PRTG Manual 1

Download as pdf or txt
Download as pdf or txt
You are on page 1of 2096

PRTG Net work Monit or User Manual

© 2014 Paessler AG

All rights reserved. No parts of this work may be reproduced in any form or by any means—graphic,
electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval
systems—without the written permission of the publisher.

Products that are referred to in this document may be either trademarks and/or registered trademarks
of the respective owners. The publisher and the author make no claim to these trademarks.

While every precaution has been taken in the preparation of this document, the publisher and the author
assume no responsibility for errors or omissions, or for damages resulting from the use of information
contained in this document or from the use of programs and source code that may accompany it. In no
event shall the publisher and the author be liable for any loss of profit or any other commercial damage
caused or alleged to have been caused directly or indirectly by this document.

Printed: Juni 2014 in Nuremberg


Contents

Table of Contents

Part 1 Welcome to PRTG Network M onitor 14


1 About this Document 15
2 Key Features 16
3 New in This Version 18
4 Available Licenses 19
5 System Requirements 21
Detailed System Requirements 23

Part 2 Quick Start Guide 32


1 ONE—Download, Installation, and First Login 33
2 TWO—Using the Configuration Guru 36

Part 3 Installing the Software 44


1 Download PRTG 45
2 Update From Previous Versions 47
3 Install a PRTG Core Server 51
4 Install a PRTG Cluster 56
5 Enter a License Key 57
6 Activate the Product 60
7 Install a PRTG Remote Probe 62
8 Install the Enterprise Console 67
9 Uninstall PRTG Products 71

Part 4 Understanding Basic Concepts 76


1 Architecture and User Interfaces 77
2 Clustering 81
3 Object Hierarchy 83
4 Inheritance of Settings 87
5 Tags 89
6 Dependencies 90
7 Scheduling 91
8 Notifying 92
9 Data Reporting 93
10 User Access Rights 94
11 IPv6 97

Part 5 Ajax Web Interface—Basic Procedures 100


1 Login 102
2 SSL Certificate Warning 105
3 General Layout 108

3
Contents

4 Sensor States 121


5 Review Monitoring Data 124
6 Compare Sensors 130
7 Historic Data Reports 133
8 Similar Sensors 138
9 Object Settings 142
10 Alarms 144
11 Logs 147
12 Tickets 149
13 Working with Table Lists 156
14 Object Selector 159
15 Priority and Favorites 160
16 Pause 162
17 Context Menus 163
18 Hover Popup 174
19 Main Menu Structure 175

Part 6 Ajax Web Interface—Device and Sensor Setup 188


1 Auto-Discovery 190
2 Create Objects Manually 204
Add a Group 205
Add a Device 211
Add a Sensor 220
3 Manage Device Tree 222
4 Root Group Settings 224
5 Probe Settings 238
6 Group Settings 253
7 Device Settings 272
8 Sensor Settings 290
List of Available Sensor Types 291
Active Directory Replication Errors Sensor 309
ADO SQL Sensor 316
Amazon CloudWatch Sensor 323
AVM FRITZ!Box WAN Interface Sensor 331
Cisco IP SLA Sensor 337
Citrix XenServer Host Sensor 343
Citrix XenServer Virtual Machine Sensor 349
Cluster Probe Health Sensor 355
Core Health Sensor 359
Dell PowerVault MDi Sensor 363
DHCP Sensor 369
DNS Sensor 376
Enterprise Virtual Array Sensor 382
Event Log (Windows API) Sensor 389
Exchange Backup (Powershell) Sensor 397
Exchange Database (Powershell) Sensor 404
Exchange Mailbox (Powershell) Sensor 411
Exchange Mail Queue (Powershell) Sensor 418

4
Contents

Exchange Public Folder (Powershell) Sensor 424


EXE/Script Sensor 431
EXE/Script Advanced Sensor 440
File Sensor 449
File Content Sensor 455
Folder Sensor 461
FTP Sensor 467
FTP Server File Count Sensor 473
Google Analytics Sensor 479
HTTP Sensor 486
HTTP Advanced Sensor 493
HTTP Apache ModStatus PerfStats Sensor 505
HTTP Apache ModStatus Totals Sensor 512
HTTP Content Sensor 519
HTTP Full Web Page Sensor 528
HTTP Push Count Sensor 536
HTTP Push Data Sensor 542
HTTP Push Data Advanced Sensor 549
HTTP SSL Certificate Expiry Sensor 556
HTTP Transaction Sensor 562
HTTP XML/REST Value Sensor 572
Hyper-V Cluster Shared Volume Disk Free Sensor 583
Hyper-V Host Server Sensor 590
Hyper-V Virtual Machine Sensor 596
Hyper-V Virtual Network Adapter Sensor 604
Hyper-V Virtual Storage Device Sensor 611
IMAP Sensor 618
INI File Content Check Sensor 629
IP on DNS Blacklist Sensor 635
IPFIX Sensor 641
IPFIX (Custom) Sensor 649
IPMI System Health Sensor 657
jFlow V5 Sensor 664
jFlow V5 (Custom) Sensor 672
LDAP Sensor 680
Microsoft SQL Sensor 685
MySQL Sensor 693
NetFlow V5 Sensor 700
NetFlow V5 (Custom) Sensor 708
NetFlow V9 Sensor 716
NetFlow V9 (Custom) Sensor 724
Oracle SQL Sensor 732
Packet Sniffer Sensor 740
Packet Sniffer (Custom) Sensor 748
Passive Application Performance Sensor 755
PerfCounter Custom Sensor 761
PerfCounter IIS Application Pool Sensor 768
Ping Sensor 775
Ping Jitter Sensor 781
Pingdom Sensor 786
POP3 Sensor 792

5
Contents

POP3 Email Count Sensor 798


Port Sensor 804
Port Range Sensor 811
Probe Health Sensor 816
QoS (Quality of Service) One Way Sensor 820
QoS (Quality of Service) Round Trip Sensor 826
RADIUS Sensor 832
RDP (Remote Desktop) Sensor 837
SCVMM Host Sensor 842
SCVMM Virtual Machine Sensor 849
Sensor Factory Sensor 856
sFlow Sensor 871
sFlow (Custom) Sensor 879
SFTP Secure File Transfer Protocol Sensor 887
Share Disk Free Sensor 893
SIP Options Ping Sensor 899
SMTP Sensor 905
SMTP&IMAP Round Trip Sensor 911
SMTP&POP3 Round Trip Sensor 919
SNMP APC Hardware Sensor 927
SNMP Cisco ADSL Sensor 933
SNMP Cisco ASA VPN Connections Sensor 938
SNMP Cisco ASA VPN Traffic Sensor 943
SNMP Cisco ASA VPN Users Sensor 948
SNMP Cisco CBQoS Sensor 953
SNMP Cisco System Health Sensor 958
SNMP Cisco UCS Chassis Sensor 964
SNMP Cisco UCS Physical Disk Sensor 970
SNMP Cisco UCS System Health Sensor 976
SNMP CPU Load Sensor 982
SNMP Custom Sensor 987
SNMP Custom String Sensor 994
SNMP Dell Hardware Sensor 1002
SNMP Dell PowerEdge Physical Disk Sensor 1008
SNMP Dell PowerEdge System Health Sensor 1014
SNMP Disk Free Sensor 1020
SNMP GSA System Health Sensor 1026
SNMP Hardware Status Sensor 1031
SNMP HP LaserJet Hardware Sensor 1036
SNMP HP ProLiant Logical Disk Sensor 1042
SNMP HP ProLiant Memory Controller Sensor 1048
SNMP HP ProLiant Network Interface Sensor 1054
SNMP HP ProLiant Physical Disk Sensor 1060
SNMP HP ProLiant System Health Sensor 1066
SNMP IBM System X Logical Disk Sensor 1072
SNMP IBM System X Physical Disk Sensor 1078
SNMP IBM System X Physical Memory Sensor 1084
SNMP IBM System X System Health Sensor 1090
SNMP interSeptor Pro Environment Sensor 1096
SNMP LenovoEMC Physical Disk Sensor 1102
SNMP LenovoEMC System Health Sensor 1108

6
Contents

SNMP Library Sensor 1113


SNMP Linux Disk Free Sensor 1122
SNMP Linux Load Average Sensor 1130
SNMP Linux Meminfo Sensor 1135
SNMP Linux Physical Disk Sensor 1140
SNMP Memory Sensor 1148
SNMP NetApp Disk Free Sensor 1154
SNMP NetApp Enclosure Sensor 1160
SNMP NetApp I/O Sensor 1166
SNMP NetApp License Sensor 1172
SNMP NetApp Logical Unit Sensor 1178
SNMP NetApp Network Interface Sensor 1184
SNMP NetApp System Health Sensor 1190
SNMP Poseidon Environment Sensor 1196
SNMP Printer Sensor 1201
SNMP QNAP Logical Disk Sensor 1206
SNMP QNAP Physical Disk Sensor 1211
SNMP QNAP System Health Sensor 1217
SNMP RMON Sensor 1222
SNMP SonicWALL System Health Sensor 1228
SNMP SonicWALL VPN Traffic Sensor 1233
SNMP Synology Logical Disk Sensor 1239
SNMP Synology Physical Disk Sensor 1244
SNMP Synology System Health Sensor 1249
SNMP System Uptime Sensor 1254
SNMP Traffic Sensor 1259
SNMP Trap Receiver Sensor 1267
SNMP Windows Service Sensor 1276
SNTP Sensor 1281
SSH Disk Free Sensor 1286
SSH INodes Free Sensor 1295
SSH Load Average Sensor 1301
SSH Meminfo Sensor 1307
SSH Remote Ping Sensor 1313
SSH SAN Logical Disk Sensor 1320
SSH SAN Physical Disk Sensor 1327
SSH SAN System Health Sensor 1334
SSH Script Sensor 1341
SSH Script Advanced Sensor 1350
SSH VMWare ESX(i) Disk Sensor 1358
Syslog Receiver Sensor 1364
System Health Sensor 1373
TFTP Sensor 1377
Traceroute Hop Count Sensor 1383
Virtuozzo Container Disk Sensor 1389
Virtuozzo Container Network Sensor 1395
VMware Host Hardware (WBEM) Sensor 1401
VMware Host Hardware Status (SOAP) Sensor 1407
VMware Host Performance (SOAP) Sensor 1413
VMware Virtual Machine (SOAP) Sensor 1419
WBEM Custom Sensor 1426

7
Contents

Windows CPU Load Sensor 1432


Windows IIS 6.0 SMTP Received Sensor 1438
Windows IIS 6.0 SMTP Sent Sensor 1444
Windows IIS Application Sensor 1450
Windows Last Update Sensor 1457
Windows Logged In Users Sensor 1463
Windows MSMQ Queue Length Sensor 1469
Windows Network Card Sensor 1476
Windows Pagefile Sensor 1483
Windows Physical Disk Sensor 1489
Windows Print Queue Sensor 1496
Windows Registry Sensor 1502
Windows Scheduled Task Sensor 1510
Windows System Uptime Sensor 1517
Windows Updates Status (Powershell) Sensor 1523
WMI Custom Sensor 1529
WMI Custom String Sensor 1536
WMI Event Log Sensor 1545
WMI Exchange Server Sensor 1553
WMI Exchange Transport Queue Sensor 1560
WMI File Sensor 1567
WMI Free Disk Space (Multi Drive) Sensor 1573
WMI HDD Health Sensor 1581
WMI Logical Disk Sensor 1587
WMI Memory Sensor 1593
WMI Microsoft SQL Server 2005 Sensor (Deprecated) 1598
WMI Microsoft SQL Server 2008 Sensor 1607
WMI Microsoft SQL Server 2012 Sensor 1615
WMI Process Sensor 1623
WMI Remote Ping Sensor 1629
WMI Security Center Sensor 1634
WMI Service Sensor 1640
WMI Share Sensor 1646
WMI SharePoint Process Sensor 1653
WMI Terminal Services (Windows 2008) Sensor 1659
WMI Terminal Services (Windows XP/Vista/2003) Sensor 1664
WMI UTC Time Sensor 1669
WMI Vital System Data (V2) Sensor 1674
WMI Volume Sensor 1680
WMI Volume Fragmentation Sensor 1686
WMI Windows Version Sensor 1693
WSUS Statistics Sensor 1699
9 Additional Sensor Types (Custom Sensors) 1706
10 Sensor Channels Settings 1709
11 Sensor Notifications Settings 1716

Part 7 Ajax Web Interface—Advanced Procedures 1726


1 Toplists 1728
2 Arrange Objects 1733
3 Clone Object 1734

8
Contents

4 Multi-Edit 1736
5 Create Device Template 1741
6 Geo Maps 1744
7 Notifications 1749
Setting Up Notifications Based on Sensor Limits: Example 1751
8 Libraries 1759
Libraries Step By Step 1762
Management 1766
Libraries and Node Settings 1768
Context Menus 1774
9 Reports 1775
Reports Step By Step 1778
View and Run Reports 1781
Reports Settings 1784
10 Maps 1794
Maps Step By Step 1797
Maps Designer 1800
Maps Settings 1806
11 Setup 1810
Account Settings—My Account 1812
Account Settings—Notifications 1817
Account Settings—Schedules 1827
System Administration—User Interface 1831
System Administration—Monitoring 1839
System Administration—Notification Delivery 1843
System Administration—Core & Probes 1849
System Administration—Cluster 1855
System Administration—User Accounts 1856
System Administration—User Groups 1861
System Administration—Administrative Tools 1865
PRTG Status—System Status 1869
PRTG Status—Auto-Update 1878
PRTG Status—Cluster Status 1883
PRTG Status—Activation Status 1884
Optional Downloads and Add-Ons 1885
Chrome Desktop Notifications 1887
Support—Contact Support 1889

Part 8 Enterprise Console 1894


1 First Start 1897
2 General Layout 1898
3 Menu Tabs and Page Content 1902
Devices 1903
Libraries 1910
Sensors 1912
Alarms 1914
Maps 1916
Reports 1918
Logs 1920

9
Contents

Tickets 1922
Setup 1924
Search Results 1926
4 PRTG Servers 1927
5 Options 1930
6 Windows Menu Structure 1936
7 Context Menus 1941
8 Shortcuts Overview 1942

Part 9 Other User Interfaces 1946


1 Mobile Web GUI 1947
2 Smartphone Apps 1950

Part 10 Sensor Technologies 1954


1 Monitoring via SNMP 1955
2 Monitoring via WMI 1959
3 Monitoring via SSH 1962
4 Monitoring Bandwidth via Packet Sniffing 1964
5 Monitoring Bandwidth via Flows 1966
6 Bandwidth Monitoring Comparison 1969
7 Monitoring Quality of Service and VoIP 1971
8 Monitoring Email Round Trip 1975
9 Monitoring Backups 1977
10 Monitoring Virtual Environments 1978
11 Monitoring Databases 1987
12 Monitoring Syslogs and SNMP Traps 1989

Part 11 Sy stem Administration Tools 1998


1 PRTG Server Administrator 1999
2 PRTG Probe Administrator 2016

Part 12 Advanced Topics 2028


1 Active Directory Integration 2029
2 Application Programming Interface (API) Definition 2031
3 Filter Rules for xFlow, IPFIX and Packet Sniffer Sensors 2032
4 Channel Definitions for xFlow, IPFIX, and Packet Sniffer Sensors 2036
5 Define IP Ranges 2038
6 Define Lookups 2039
7 Regular Expressions 2048
8 Add Remote Probe 2049
Remote Probes and Multiple Probes 2050
Remote Probe Quick Setup 2053
Remote Probe Setup Using Installer 2059
9 Failover Cluster Configuration 2064
Failover Cluster Step by Step 2067
10 Data Storage 2074

10
Contents

11 Using Your Own SSL Certificate with PRTG's Web Server 2076
12 Calculating Percentiles 2078

Part 13 Appendix 2080


1 Glossary 2081
2 List of Abbreviations 2085
3 Support and Troubleshooting 2088
4 Legal Notices 2089

Index 2091

11
Part 1
Welcome to PRTG Network Monitor

14.01.2014 13
Part 1: Welcome to PRTG Network Monitor |

1 Welcome to PRTG Network Monitor


Welcome to PRTG Network Monitor! You have chosen an easy-to-use software product that
comes with a powerful set of features to monitor your entire network.

Why Network Monitoring is Important

Today, most businesses rely on a computer and network infrastructure for internet, internal
management, telephone, and email. A complex set of servers and network equipment is
required to ensure that business data flows seamlessly between employees, offices, and
customers. The economical success of an organization is tightly connected with the flow of
data.

The computer network's reliability, speed, and efficiency are crucial for businesses to be
successful. But, like all other technical objects, network devices may fail from time to time—
potentially causing trouble and loss of sales, no matter what migration efforts have been made
up-front.

Network administrators need to take three key steps to maintain network uptime, reliability,
and speed:

1. Set up a well-planned network with reliable components.


2. Create recovery plans for the event of device failure.
3. Monitor their network to know about failures as they build up or actually happen.

PRTG Network Monitor, the software described in this document, is a complete solution for
monitoring small, medium, and large networks.

Monitoring Networks with PRTG Network Monitor

PRTG Network Monitor is a powerful network monitoring application for Windows-based


systems. It is suitable for small, medium, and large networks and capable of LAN, WAN, WLAN,
and VPN monitoring. You can also monitor physical or virtual web, mail, and file servers, Linux
systems, Windows clients, routers, and many more. PRTG monitors network availability and
bandwidth usage, as well as various other network parameters such as quality of service,
memory load, and CPU usages. It provides system administrators with live readings and
periodical usage trends to optimize the efficiency, layout, and setup of leased lines, routers,
firewalls, servers, and other network components.

The software is easy to set up and use and monitors a network using Simple Network
Management Protocol (SNMP), Windows Management Instrumentation (WMI), packet sniffer,
Cisco NetFlow (as well as IPFIX, sFlow, and jFlow), and many other industry standard protocols.
It runs on a Windows-based machine in your network for 24-hours every day. PRTG Network
Monitor constantly records the network usage parameters and the availability of network
systems. The recorded data is stored in an internal database for later analysis.

14 14.01.2014
Part 1: Welcome to PRTG Network Monitor | 1 About this Document

1.1 About this Document


This document introduces you to the system concepts of PRTG Net work Monit or and
explains how to set up the software to achieve the best monitoring results. You will learn how
to plan your monitoring setup, how to set up your devices and sensors, dependencies,
reports, notifications, maps, user accounts, and clustering for fail-safe monitoring.

This document is also meant as a reference for all available settings. Short contextual help is
already provided within the Ajax web interface; in this manual you often get some more help
regarding the different options available.

This document does not explain monitoring protocols and file formats in-depth. Also, the use
of the Application Programming Interface (API) built into PRTG is only briefly addressed.
Whenever possible, hyperlinks to more detailed resources are provided, such as articles in the
Paessler Knowledge Base.

To start using PRTG right away, please see the Quick St art Guide 32 section. For more
detailed instructions, see the other sections.

19.07.2013 15
Part 1: Welcome to PRTG Network Monitor | 2 Key Features

1.2 Key Features


PRTG Network Monitor monitors your network and requires no third party software.
Conducting a quick ad-hoc download, you do not need to fill web forms and will not have any
registration hassles. The installation process requires only a few minutes, as well as the first
configuration which is mainly done automatically. The initial setup is achieved by an interactive
guidance by the software.

What PRTG Can Be Used For


§ Monitor and alert due to uptimes/downtimes or slow servers.
§ Monitor system health of various hardware devices.
§ Monitor and account bandwidth and network device usage.
§ Monitor applications.
§ Monitor virtual servers.
§ Monitor Service Level Agreement (SLA).
§ Monitor system usage (CPU loads, free memory, free disk space, etc.).
§ Monitor performance of databases as well as monitor databases directly.
§ Monitor email servers and use this feature to monitor various backup solutions.
§ Monitor the environment.
§ Classify network traffic by source/destination and content.
§ Discover unusual, suspicious, or malicious activity with devices or users.
§ Measure QoS and VoIP parameters and control service level agreements (SLA).
§ Discover and assess network devices.
§ Find unexpected relationships between your network components to detect potential
security issues and to explore the real usage of your network and hardware.
§ Monitor fail-safe using a failover cluster setup.

What PRTG Includes

The PRTG installer contains all modules and software necessary to run the monitoring system
without the need for third party modules, including:

§ High performance: PRTG's own fast and efficient database system to store the raw
monitoring results as well as logs, Toplists, and tickets (outperforms SQL servers for
monitoring data), accessible through Application Programming Interface (API). You can
distribute high loads over multiple probes.
§ Low system requirements: an average PC from the year 2007 is sufficient and even a
netbook can monitor over thousand sensors.

16 14.01.2014
Part 1: Welcome to PRTG Network Monitor | 2 Key Features

§ High security standards: SSL encryption for connections and web server, and multiple user
accounts with shared and private sensors, as well as rights management, and many more.
§ Built-in SSL secured web server with HTTP and HTTPS support for the user interface.
§ Fast web interface, works as Single Page Application (SPA) to avoid time-extensive reloading
of the page.
§ Mail server for automatic email delivery.
§ Flexible alerting
§ including nine notification technologies, for example, email, SMS, syslog and SNMP trap,
HTTP request, event log, Amazon SNS, executing scripts, etc.
§ including various triggers, for example, status alerts, limit alerts, threshold alerts, multiple
condition alerts, escalation alerts.
§ including dependencies to avoid alarms floods, acknowledging alarms to avoid further
notifications for this alarm, and alert scheduling.
§ In-depth report generator to create reports on-the-fly as well as scheduled reports in HTML
or Portable Document Format (PDF). Many report templates are available by default.
§ Graphics engine for user-friendly live and historic data charts.
§ Network analysis module to automatically discover network devices and sensors.
§ Distributed monitoring to monitor several networks in different locations.
§ Special features for Managed Service Provider (MSP) to monitor customer networks and
increase the quality of service.
§ Data publishing with real time dashboards—private and public—including live performance
and status information. You can design these maps as you like with many different objects,
as well as you can integrate external custom objects.
§ Different languages like English, German, Spanish, French, Portuguese, Dutch, Czech,
Japanese, and Simplified Chinese.
§ Customizations: The PRTG Application Programming Interface (API) allows you to program
your own features and to customize and re-brand PRTG's web interface to your needs. In
addition, you can create custom sensors, notifications, and device templates.

PRTG Network Monitor supports monitoring up to 20,000 thousand sensors per installation. It
can optionally work with multiple remote probes to monitor multiple sites or network
segments from one central core installation, and to distribute high loads. You can also
configure fail-safe monitoring using a cluster installation to perform automatic failovers. Single
failover installations are allowed with every PRTG license.

The software is based on Paessler's reliable monitoring technology, which has been constantly
improved since 1997 and is already used by more than 150,000 users around the world every
day. An outstanding support ensures that your inquiries are answered within one business day
in order to ensure best possible network monitoring. Attractive licensing packages from
freeware (up to 10 sensors) to enterprise level (with thousands of sensors) make sure that
every user finds the proper solution.

14.01.2014 17
Part 1: Welcome to PRTG Network Monitor | 3 New in This Version

1.3 New in This Version


With ongoing continuous development and rollout, we constantly extend and improve on the
functionalities provided by PRTG. Instead of delivering just a few versions distributed over the
year with massive changes in every version, PRTG is automatically and seamlessly enhanced
with new features and fixes—fast and with high quality. There are three release channels for
PRTG:

§ St able: best tested version of PRTG for live systems; updated about once or twice a month;
for usage on live systems
§ Preview: offering the latest features and fixes; updated about once a week; consider this
version as "beta", thus, do not use this version on live systems you have to depend on!
§ Canary : providing "nightly builds"; updated very often; not tested extensively; never use on
live systems you have to depend on!

Because of these three channels, you can choose either maximum stability, earlier access to
new features, or a mixture of both.

For an overview of all most recent changes in the current version, please visit the version
history on our website. Please see the More 18 section below for more information.

More
Paessler Website: PRTG Network Monitor Version History
§ http://www.paessler.com/prtg/history

Paessler Blog: Version 12 of PRTG introduces "Continuous Rollout"


§ http://www.paessler.com/blog/2012/04/25/

18 14.01.2014
Part 1: Welcome to PRTG Network Monitor | 4 Available Licenses

1.4 Available Licenses


There are four different PRTG flavors available.

Freeware Edition

The Freeware Edition is a good solution to get started with PRTG, or for private use:

§ May be used for free for personal and commercial use.


§ Can monitor up to 10 sensors.
§ Supports all available sensor types.
§ Shortest available monitoring interval is one minute.
Note: If you want to use the Freeware Edition, please first install the Trial Edit ion 19 and get a
free trial key. After the trial period has ended, your Trial Edition will automatically revert into a
Freeware Edition.

Special Edition

The Special Edition has all the features of the Freeware Edition, plus it supports up to 30
sensors. By entering a Special Edition key, you can extend your Freeware Edition. This key is
not for download, we only hand it out on special request. For detailed information, see More
20 section below.

Trial Edition

The Trial Edition is intended for evaluation purposes for customers who are interested in
purchasing commercial licenses:

§ Can monitor an unlimited number of sensors.


§ Supports all available sensor types.
§ Shortest available monitoring interval is one second (not officially supported; a minimum
interval of 10 seconds is recommended).
§ Temporary license key must be requested from Paessler's website.
§ Trial period limited to 30 days (automatically reverts to Freeware Edition 19 afterwards).

§ With each license one single failover cluster setup 81 , consisting of two nodes, is included.
Cluster installations with two and three failover nodes will require one additional trial license
key; a cluster installation with four failover nodes will require two additional trial license
keys.

After the trial period has ended, a Trial Edition will revert into a Freeware Edition, allowing you
to monitor up to 10 sensors for free.

28.05.2014 19
Part 1: Welcome to PRTG Network Monitor | 4 Available Licenses

Commercial Editions

There are several licenses of PRTG Network Monitor available to suit the demands of smaller,
as well as larger customers and organizations:

§ Can monitor maximum number of sensors (from 100 to unlimited).


§ Supports all available sensor types.
§ Shortest available monitoring interval is one second (not officially supported; a minimum
interval of 10 seconds is recommended).
§ With each license one single failover cluster setup 81 , consisting of two nodes, is included.
Cluster installations with two and three failover nodes will require one additional license of
the same size; a cluster installation with four failover nodes will require two additional
licenses of the same size.

For more information about available commercial licenses, please see More 20 section below.

More
Knowledge Base: What is the PRTG Special Edition license?
§ http://kb.paessler.com/en/topic/8063

Paessler Website: Request a Free PRTG Trial Key for Evaluation


§ http://www.paessler.com/prtg/trial

Paessler FAQs: What is the difference between the PRTG Network Monitor licenses?
§ http://www.paessler.com/support/faqs#e1912

20 28.05.2014
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements

1.5 System Requirements


In order to install and work with PRTG Network Monitor, you need to meet the following
requirements:

§ A PC server or virtual machine with roughly the CPU performance of an average PC built in
the year 2007 or later and minimum 1024 RAM memory. For cluster 81 installations, use
systems with similar performance.
§ Operating systems Microsoft Windows 7, Windows 8, Server 2012, Server 2012 R2, Windows
2003 SP1 or later, or Windows 2008 R2 (all 32-bit or 64-bit) are officially supported. You can
also use Windows Vista or 2008 R1, but we recommend not using these systems, because
there are known performance issues related to them.
§ Web browser to access the web interface. The following browsers are supported:
§ Google Chrome 34 or later (recommended)
§ Mozilla Firefox 28 or later
§ Microsoft Internet Explorer 10 or 11

Planning an Installation With Hundreds of Sensors or More?

As a rule of thumb, an average PC/server built in the year 2007 or later should be able to
monitor 1,000 sensors with ease. Some exceptions apply for version 3 of Simple Network
Management Protocol (SNMP), Windows Management Instrumentation (WMI) and packet sniffer.
The maximum number of sensors you can monitor with one installation of PRTG mainly
depends on the monitoring technology and the monitoring intervals you use. In general,
consider the following rules:

§ SNMP V1 and V2, Ping, Port , and HTTP


These sensor types are recommended for scenarios with thousands of sensors. With these
technologies up to 20,000 sensors are possible.
§ SNMP V3
You will be able to monitor about 5,000 SNMP V3 sensors with an interval of 60 seconds on
a common two core computer, and about 10,000 sensors on a four core system (the main
limiting factor is your CPU power).
§ WMI
Try to keep the number of WMI sensors per probe below 120 sensors (with 60s interval), or
600 sensors (with 300s interval).
§ xFlow (IPFIX , Net Flow, sFlow, jFlow)
Monitoring the maximum number of sensors depends on the traffic pattern, the number of
xFlow packets per second received by the PRTG probe, as well as the performance of the
probe system (see site planner tool linked in the More 22 section below).
§ Packet Sniffer
These sensors create the highest CPU load on the probe system. This technology is only
recommended for monitoring of low traffic connections (<50 Mbit/s steady stream). When
traffic is often over 10 Mbit/s a dedicated remote probe 2049 should be used.

28.05.2014 21
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements

§ VMware Monit oring


Monitoring of VMware is limited to about 20 sensors at a 60 seconds monitoring interval, or
100 sensors at a 5 minutes interval. These limitations issue from the VMware platform. A
registry hack is available to boost this to 150 sensors at a 5 minutes interval (this will require
a change in the ESX/vCenter configuration). For details please see More 22 section below.
§ Ot her sensor t y pes
The impact of a specific sensor type on performance is indicated by a color range when
adding a sensor to a device. It ranges from dark green (very low impact; 5,000 sensors per
probe) to bold red (very high impact; 50 sensors per probe).

To overcome any limitations mentioned above you should distribute the sensors over two
remote probes 2049 or more. For detailed information please use the site planner tool to plan
large installations. See More 22 section below.

We recommend using a dedicated physical machine to run both the PRTG core server and PRTG
remote probes. For more information please see the Det ailed Sy st em Requirement s 23
section.

More
§ Updat e From Previous Versions 47

Knowledge Base: Planning Large Installations of PRTG Network Monitor


§ http://kb.paessler.com/en/topic/26383

Knowledge Base: Paessler PRTG Site Planner Tool


§ http://kb.paessler.com/en/topic/41373

Knowledge Base: How can I speed up PRTG—especially for large installations?


§ http://kb.paessler.com/en/topic/2733

Knowledge Base: Increasing Maximum Connections for VMware Sensors


§ http://kb.paessler.com/en/topic/30643

Knowledge Base: Checklist for Running PRTG on VMware


§ http://kb.paessler.com/en/topic/49193

22 28.05.2014
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

1.5.1 Detailed Sy stem Requirements

This section lists different aspects of system requirements for PRTG. Please consider these
requirements in order to avoid issues while network monitoring.

§ Support ed Operat ing Sy st ems 23

§ Hardware Requirement s 24

§ Sample Configurat ions 25

§ Running PRTG on Virt ual Machines 27

§ Web Browser Requirement s 28

§ Screen Resolut ion 28

§ Requirement s for Monit ored Devices 28

§ Requirement s for t he Ent erprise Console 29

§ Requirement s for Mobile Web GUI 29

§ Requirement s for Smart phones 29

§ More 29

Supported Operating Systems

The 32-bit and 64-bit versions of the following operating systems are officially supported for
PRTG Core Service and Probe Service (Intel x86/x64 architectures only):

§ Microsoft Windows 7
§ Microsoft Windows 8
§ Microsoft Windows Server 2008 R2 and Windows Server 2008 R2 SP1
§ Microsoft Windows Server 2012**
§ Microsoft Windows Server 2012 R2**
§ Microsoft Windows Server 2003 SP1 or later
§ Microsoft Windows Vista*
§ Microsoft Windows Server 2008*

* For performance reasons, we do not recommend using Windows Vista or Windows Server
2008 R1, especially when monitoring via Windows Management Instrumentation (WMI). Using
these operating systems, you will only be able to add a limited number of WMI sensors! For
detailed information, please see More 29 section below. If you need to use Windows Server
2008 R1, we strongly recommend installing Service Pack 2 (SP2).

** Windows Server 2012 in Core mode and the Minimal Server Interface are not officially
supported.

28.05.2014 23
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

The version (32-bit or 64-bit) of the PRTG Core Server depends on the version of your
operating system. The 64-bit version of the PRTG Core Server will be installed if

§ the operating system is a 64-bit Windows system, and


§ the system provides 6GB RAM or more.

Otherwise the 32-bit version of the PRTG Core Server will be installed.

We recommend you to provide Microsoft .NET Framework versions 3.5 and 4.0 (with latest
updates) on all systems running a PRTG probe. Note: Version 4.0 is imperatively needed for
monitoring VMware and XenServer virtual environments.

More details: Some sensor types need the Microsoft .NET Framework to be installed on the
computer running the PRTG probe. This is either on the local system (on every node, if on a
cluster probe), or on the system running a remote probe 2050 . Depending on the sensor type,
the required versions are 2.0, 3.0, or 4.0. Note: According to the Microsoft website, .NET
version 3.5 contains versions 2.0 SP1 and 3.0 SP1. Version 4.0 is not downward compatible,
but must be installed side-by-side to older version(s), if required.

For best performance of hybrid sensors using Windows Performance Counters and Windows
Management Instrumentation (WMI), we recommend Windows 2008 R2 or higher on the
computer running the PRTG probe: This is either on the local system (on every node, if on a
cluster probe), or on the system running a remote probe 2050 .

Hardware Requirements

Hardware requirements for PRTG Core Service and Probe Service mainly depend on the
sensor types and intervals used. The following values are provided as reference for common
usage scenarios of PRTG (based on a default sensor interval of 60 seconds).

§ CPU
An average PC built in 2007 can easily monitor 1,000 sensors (see sensor type specific notes
below). PRTG supports native x86 architectures.
§ RAM memory
Minimum requirement: 1024 MB RAM. You will need about 150 KB of RAM per sensor.
§ Hard Disk Drive
You will need about 200 KB of disk space per sensor per day (for sensors with 60 second
interval).
§ Int ernet connect ion
An internet connection is required for license activation (via HTTP or email).
§ St able net work connect ion for remot e probes
Remote probes require a stable network connection between the PRTG core server and the
remote probe. Unstable connections, for example via 3G, might work but it could be possible
that you lose monitoring data if the connection is non-reliable.

24 28.05.2014
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

There are also non-hardware dependent limitations for some sensor types, for example, WMI
and SNMP V3 sensors. These limitations can be overcome by distributing the sensors across
multiple remote probes 2049 . If you plan installations with more than 500 to 1,000 sensors, or
more than 10 Packet Sniffer or xFlow (NetFlow, sFlow) sensors, please consult the site planner
tool linked in the More 29 section below.

Sample Configurations

The sample configurations in the table below will give you an overview of the hardware
requirements for PRTG, based on your configuration.

28.05.2014 25
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

Large Inst allat ion Large Inst allat ion B Net book
A Inst allat ion

Sy st em DELL PowerEdge DELL Inspiron Mini


DELL Alienware
2900 III 10

CPU Intel Core2 Quad- Intel Xeon Quad-


Intel Atom Z520
Core Core
1.33 GHz
2.6 GHz 1.87 GHz

RAM 8 GB 16 GB 1 GB

Operat ing Sy st em Windows 2003 64-


Windows 7 64-Bit Windows XP 32-Bit
Bit

Sensors 20,000 SNMP 600 SNMP


20,000 SNMP
100 Other 750 WMI

Inst allat ion 24 switches à 25


400 switches à 48 400 switches à 48
Corresponds To ports
ports ports
+ 30 Windows server

Scanning Int erval 1 minute 1 minute 5 minutes

Number of Probes 4 1 1

Average CPU Load


3% 20 % 35 %
While Monit oring*

Average CPU Load


While Generat ing 20 % 30 % 85 %
Report s*

Average Memory Used 3 GB 3.5 GB 260 MB

Average Dat a Writ t en


800 GB 800 GB 55 GB
t o Disk Per Year

Average Net work Load 80 kbit/s 550 kbit/s 150 kbit/s

* CPU load is higher while users are accessing the web interface.

26 28.05.2014
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

Running PRTG on Virtual Machines

PRTG core server as well as PRTG probe can be run on virtualized platforms. The following
platforms were tested successfully:

Virt ual Host Technology Client OS

VMware ESX/ESXi versions 3.5, 4.0, or 5.0 Windows XP, Windows 2003 SP1 or later
(32/64 bit), Windows Vista, Windows 7 (32/64
bit), Windows 2008 (32/64 bit), Windows 8
(32/64 bit), Windows 2012 (32/64 bit)

VMware Server 2.0 Windows XP, Windows 2003 SP1 or later


(32/64 bit), Windows 2008, Windows 8 (32/64
bit), Windows 2012 (32/64 bit)

XEN Server 5.0 Windows XP, Windows 2003 SP1 or later


(32/64 bit), Windows 2008, Windows 8 (32/64
bit), Windows 2012 (32/64 bit)

Parallels Virtuozzo Containers Windows 2003 Server SP1 or later (32/64 bit),
Windows 2008 Server, Windows 8 (32/64 bit),
Windows 2012 (32/64 bit)

Cloud Hosting Platforms (Amazon EC2, Windows Server 2003 SP1 or later, Windows
TheRackspaceCloud, and others) Server 2008, Windows 8 (32/64 bit), Windows
2012 (32/64 bit)

Important notice: We recommend using a dedicated physical machine to run both the PRTG
core server and PRTG remote probes. If you run PRTG on a virtual machine, we strongly
recommend to stay below 2,000 sensors for performance reasons. Unfortunately, we cannot
offer technical support regarding performance and stability problems for PRTG installations on
virtual machines that run with more than 5,000 sensors. In this case, please migrate PRTG to
one or more, preferably physical, machines.

Note: When running PRTG on a virtual machine, do not use dynamic resource allocation, but
please make sure that full resources are available to the virtual machine at any time. In our
experience, dynamic resource allocation is not working efficiently for a monitoring software
and can therefore lead to massive performance issues.

Please see also section More 29 regarding running PRTG on VMware.

28.05.2014 27
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

Web Browser Requirements

The following browsers are officially supported by the PRTG web interface (in order of
performance and reliability):

§ Google Chrome 34 or later (recommended)


§ Mozilla Firefox 28 or later
§ Microsoft Internet Explorer 10 or 11
Note: Deprecated Internet Explorer versions as well as mobile browsers might not be able to
display the full featured Ajax web int erface 100 . Using these browsers, you can access the
feature-limited Mobile Web GUI 1947 , which does not require CSS or Javascript capability.

PRTG's web interface makes heavy use of Javascript and AJAX. We found that for some
functions Chrome is up to 10 times faster than Internet Explorer, and 3 to 5 times faster than
Firefox.

Screen Resolution

A screen resolution of at least 1024x768 pixels is sufficient for most functions of PRTG.
However, we recommend a screen resolution of 1200x800 or higher.

Requirements for Monitored Devices


§ SNMP monit oring
The monitored device(s) must be equipped with SNMP Version 1, 2c, or 3 (i.e., an SNMP-
compatible software must be installed on the device). SNMP must be enabled on the device
and the machine running PRTG must be granted access to the SNMP interface.
§ Windows/WMI monit oring
In order to use WMI (Windows Management Instrumentation) monitoring, you will need a
Windows network. For client PCs monitored with WMI, only the operating systems as given
above 23 are officially supported. Windows 2000 is not officially supported. Please do not
use Windows Vista or Windows 2008 R1 for WMI monitoring (they both have WMI
performance issues). Windows XP is not officially supported and might not work with
sensors which use Remote Powershell.
§ xFlow (IPFIX , Net Flow, sFlow) monit oring
The device must be configured to send NetFlow data packets (NetFlow version 5 or 9; IPFIX
is the successor protocol of NetFlow 9) or sFlow packets (version 5) to the machine running
the PRTG probe.
§ Packet Sniffer monit oring
Only data packets passing the local machine's network card can be analyzed. Switches with
so-called 'monitoring ports' are necessary for network-wide monitoring in switched
networks.
§ Ot her sensor t y pes
Depending on the specific sensor type, you can find requirements (for example, modules,
components, device configurations) which may have to be fulfilled in the corresponding
manual section, as well as partly when adding the sensor to a device.

28 28.05.2014
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

Requirements for the Enterprise Console

The optional PRTG Ent erprise Console 1894 runs under all Windows versions XP or later. It has a
built-in webkit browser engine and requires no specific browser installed on the system. See
also section Ent erprise Console—Requirement s for Connect ions t o PRTG Web Server(s) 1894
.

Requirements for Mobile Web GUI

The feature-limited mobile web interface is optimized for low bandwidth and mobile access. It
has been designed for and tested with iOS (iPhone, iPad), Android, Blackberry, Windows Mobile,
and also deprecated Internet Explorer versions.

Requirements for Smartphones


The optional smartphone apps for iOS devices require iOS version 6 or later and PRTG v12 or
later. For Android devices, the app "PRTG for Android" requires Android OS 4.0 or later (version
4.1 or later recommended), as well as PRTG Network Monitor 13.1 or later. For more
information, please see Smart phone Apps 1950 . The 'Mobile Web GUI 1947 ' interface can be used
on most phones with a browser. We successfully tested it on Symbian, BlackBerry, Windows,
Android, and iOS devices.

More
§ Updat e From Previous Versions 47

Paessler Blog: Don't Use Windows Vista And Windows 2008 R1 for Network Monitoring via
WMI!
§ http://www.paessler.com/blog/2010/09/22/

Paessler Website: Paessler PRTG Site Planner Tool


§ http://kb.paessler.com/en/topic/41373

Knowledge Base: How can I speed up PRTG—especially for large installations?


§ http://kb.paessler.com/en/topic/2733

Knowledge Base: My WMI sensors don't work. What can I do?


§ http://kb.paessler.com/en/topic/1043

Knowledge Base: Frequent Questions about xFlow, Packet Sniffing, Traffic Monitoring and
Cisco
§ http://kb.paessler.com/en/topic/3733

Knowledge Base: My SNMP sensors don't work. What can I do?

28.05.2014 29
Part 1: Welcome to PRTG Network Monitor | 5 System Requirements
1 Detailed System Requirements

§ http://kb.paessler.com/en/topic/46863

Knowledge Base: Checklist for Running PRTG on VMware


§ http://kb.paessler.com/en/topic/49193

30 28.05.2014
Part 2
Quick Start Guide

14.01.2014 31
Part 2: Quick Start Guide |

2 Quick Start Guide


Welcome to PRTG Network Monitor! This section will support you with a quick start into PRTG,
so you can start monitoring your network right away!

Welc ome Sc reen

Setting up monitoring for your network is easy! You only need to download the installer from
Paessler's website, run through the installation wizard, and provide some information in the
configuration guru. PRTG will start monitoring your network immediately without any further
complicated stumbling blocks! Of course, later on, you still can adjust everything to your
needs.

Please see the following quick steps.

Quick Start Guide—Topics


§ ONE—Download, Inst allat ion, and First Login 33

§ TWO—Using t he Configurat ion Guru 36

32 14.01.2014
Part 2: Quick Start Guide | 1 ONE—Download, Installation, and First Login

2.1 ONE—Download, Installation, and First Login


Simply download and install the version of PRTG Network Monitor which meets your needs.
For video tutorials with PRTG basics, please see section More 35 below.

Download

On the Paessler website, you find two different installers for PRTG, a public download for the
Freeware, Special, and Trial editions, and a login link to download the commercial editions
(which is only available for paying customers).

PRTG Download on Paessler Website with Marked Full Version Download Link

03.04.2014 33
Part 2: Quick Start Guide | 1 ONE—Download, Installation, and First Login

Downloading the Freeware, Special, or Trial Edition

Please download the latest publicly available file from the Paessler website. You can also
request a trial key there, which must be entered during installation:

§ ht t p://www.paessler.com/prt g/download

Note: Every Freeware installation will start as a Trial version, giving you an unlimited number of
sensors for 30 days. After the trial period has expired, your installation will automatically revert
to a Freeware edition with 10 sensors.

Note: A Special Edition is an extended Freeware version. If you meet certain requirements, you
can receive a Special Edition key from us which gives you an extended number of sensors for
free. For details, please see:

§ ht t p://www.paessler.com/prt g/download#30sensors

Downloading the Commercial Edition

Downloads and updates are free to customers with an active maintenance contract. Please log
into the Paessler website to get the latest download. You can also find your license key there,
which must be entered during installation:

§ ht t p://www.paessler.com/login

If you do not have an active maintenance contract, please contact [email protected].

Note: Once installed, you will usually use the Soft ware Aut o-Updat e 1878 function of PRTG to
download and install new versions. This will further ease the process of installing updates.

Installation

Please double click the setup file on the computer that will be your PRTG server. Follow the
installation wizard and install the software.

At the end of the installation, a browser window will be opened automatically, and it will
connect to the PRTG web interface, showing the Configurat ion Guru. Please make sure you
load the web interface with one of the supported browsers:

§ Google Chrome 34 or later (recommended),


§ Mozilla Firefox 28 or later, or
§ Microsoft Internet Explorer 10 or 11.

34 03.04.2014
Part 2: Quick Start Guide | 1 ONE—Download, Installation, and First Login

Note: Due to scripting incompatibilities, you might not be able to use all functionalities of the
PRTG Ajax web interface with Internet Explorer 9 or earlier and other older browsers. If you
cannot access the Configurat ion Guru, please open the URL of the PRTG web interface in
another browser.

Login

If everything works fine, you will not see the login screen on first startup. Only when switching
browsers you will have to log in.

PRTG Login Sc reen

§ Leave the Login Name and Password fields empty.


§ Choose the AJAX Web GUI (All feat ures, opt imized for deskt op access) option.
§ Click on the Default Login button to login.

Please make sure you use a supported web browser when logging in to PRTG. Please use
Google Chrome 34 or later (recommended), Mozilla Firefox 28 or later, or Microsoft Internet
Explorer 10 or 11. Only with a supported browser you can use the AJAX Web GUI (All
feat ures, opt imized for deskt op access) option. If you see this option grayed out, please
change your browser and open the URL again.

Please see the next step for more information about Using t he Configurat ion Guru 36 .

More
Video Tutorials for PRTG Network Monitor:
§ http://www.paessler.com/support/video_tutorials

03.04.2014 35
Part 2: Quick Start Guide | 2 TWO—Using the Configuration Guru

2.2 TWO—Using the Configuration Guru


For a new inst allat ion, PRTG will open t he Configurat ion Guru aut omat ically aft er each
login. It will reappear unt il y ou eit her ran t hrough it complet ely or skipped it . In order
t o open it at any t ime, please click t he Run Configurat ion Guru but t on on PRTG's Home
screen.

Note: When using the Ent erprise Console 1894 , please start the Guru by selecting Help | Run
Configurat ion Guru from the main menu.

Ajax Web Interfac e Home Sc reen

By answering about ten simple questions, this assistant will guide you through an initial setup
and pre-configure an essential monitoring of your network including important devices,
servers, and websites. You can later adjust these automatically generated monitoring settings
later by hand.

36 12.05.2014
Part 2: Quick Start Guide | 2 TWO—Using the Configuration Guru

Configuration Guru Start Sc reen

The steps to go are:

§ Enable SSL Encry pt ion 38

§ Configure Administ rat or Account 38

§ Ent er Windows/WMI Credent ials 38

§ Ent er SNMP Credent ials 39

§ Ent er VMware/X enServer Credent ials 39

§ Ent er Linux/Solaris/Mac OS Credent ials 40

§ Monit or Your Int ernet Connect ion 40

§ Monit or LAN Servers 40

§ Monit or Websit es/Online Shops 41

§ Monit or Cloud Services 41

§ Discover a Net work Segment 42

§ You Are Done! 42

Click on the St art Guru button to start. You can skip a step at any time by clicking on the Skip
button.

12.05.2014 37
Part 2: Quick Start Guide | 2 TWO—Using the Configuration Guru

Enable SSL Encryption

This step is shown only if your web server runs on http. We recommend running the PRTG web
interface using SSL encryption (https), especially if you make your web interface available from
the internet. Without encryption your passwords are sent over your network unencrypted.
Choose between:

§ Yes: Switch the PRTG web server to use SSL. A popup will appear, showing you the screen
shot of a certificate security warning that will be shown the next time you load the PRTG
web interface. Confirm by clicking the button Yes, swit ch t o SSL now. After you confirm,
the PRTG core server Windows service will be restarted and the web interface will be
reloaded, most likely showing a certificate warning. Confirm it to proceed to the login
screen. For more information, please see SSL Cert ificat e Warning 105 .

§ No: Skip this step and keep using an unencrypted http connection. Once you skipped this
step, it will not be shown again. You can switch to SSL later by using the PRTG Server
Administrator tool from the Windows start menu. For more information, please see PRTG
Server Administ rat or 1999 .

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Configure Administrator Account

By default, PRTG uses the administrator account with login name prt gadmin and password
prt gadmin. For security reasons you should at least change the password.

Please enter credentials and email address for the administrator account.

The password must meet the following requirements:

§ at least eight characters long


§ at least one number
§ at least one capital letter

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Enter Windows/WMI Credentials

In order to monitor your Windows clients and servers via Windows Management
Instrumentation (WMI), please enter Windows administrator credentials for your network. We
recommend using Domain Administrator credentials (if you're using an Active Directory).

PRTG will store these credentials in the Root 224 group of your device tree. All Windows-based
devices will automatically inherit and use them for monitoring. You can discontinue
Inherit ance of Set t ings 87 at any level, entering other credentials instead.

38 12.05.2014
Part 2: Quick Start Guide | 2 TWO—Using the Configuration Guru

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Enter SNMP Credentials

In order to monitor your hardware (router, switches, etc.), Simple Network Management
Protocol (SNMP) is the most common protocol used. Usually, all SNMP-enabled devices use the
same settings by default: SNMP version 1, community string public, SNMP port 161).

You only need to change values here if the SNMP-enabled devices in your network use other
settings. Choose between:

§ No: You SNMP-enabled devices use the default configuration. If you're not sure, choose this
option.
§ Yes: Choose this option to enter your own SNMP credentials and settings. More settings will
appear. Choose the SNMP version, enter the community string and SNMP port number, and
define a time out for SNMP connections.

PRTG will store these credentials in the Root 224 group of your device tree. All SNMP-based
devices will automatically inherit and use them for monitoring. You can discontinue
Inherit ance of Set t ings 87 at any level, entering other credentials instead.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Enter VMware/XenServer Credentials

If you use the virtual environments VMware or Citrix XenServer, PRTG can monitor them as
well. To do so, please enter root access credentials for those systems. Choose between:

§ No: PRTG will not monitor virtual environments. You can later add those credentials.
§ Yes: Please enter user name and password for VMware or XenServer systems. For VMware,
please also specify the protocol that will be used to connect.

PRTG will store these credentials in the Root 224 group of your device tree. All VMware/
XenServer-based devices will automatically inherit and use them for monitoring. You can
discontinue Inherit ance of Set t ings 87 at any level, entering other credentials instead.

For an overview of all available VMware and XenServer sensors, please see List of Available
Sensor Ty pes 296 , section "Virtual Servers Sensors".

12.05.2014 39
Part 2: Quick Start Guide | 2 TWO—Using the Configuration Guru

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Enter Linux/Solaris/Mac OS Credentials

If you have systems running on Linux, Solaris, or Mac OS X, PRTG can monitor them as well. To
do so, please enter root access credentials for those systems. Choose between:

§ No: PRTG will not monitor devices via SSH/WBEM. You can later add those credentials.
§ Yes: Please enter SSH/WBEM credentials. You can either provide username and password, or
paste a private key. For WBEM access, please also define protocol and port. Additionally,
specify the rights an SSH command will be executed with.

PRTG will store these credentials in the Root 224 group of your device tree. All SSH/WBEM-
based devices will automatically inherit and use them for monitoring. You can discontinue
Inherit ance of Set t ings 87 at any level, entering other credentials instead.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Monitor Your Internet Connection

PRTG can monitor the availability of your default gateway and DNS servers. It will try to
automatically detect and pre-populate the respective fields with the correct IP addresses.
Please review and/or enter the IP addresses of your default (internet) gateway and your DNS
server(s). Enter each IP address/DNS name in one line.

Note: For most networks, the gateway is the IP address or DNS name of your firewall or
router. If you do not have a second DNS server, simply leave the respective field blank.

PRTG will create a new device for each entry and run an auto-discovery to set up sensors. In
the background, auto-discovery will start immediately after you confirm this step.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Monitor LAN Servers

PRTG can monitor your AD domain controllers, Exchange or other mail servers, as well as
additional servers in your network. PRTG will try to automatically detect and pre-populate the
respective fields with the correct IP addresses. Please review and/or enter the entries for your
Active Directory domain controllers and mail servers. Enter each IP address/DNS name in one
line.

40 12.05.2014
Part 2: Quick Start Guide | 2 TWO—Using the Configuration Guru

PRTG will create a new device for each entry and run an auto-discovery to set up sensors. In
the background, auto-discovery will start immediately after you confirm this step.

Note: Your entries will not be shown in the Configuration Guru after confirming this step but
will be added as devices to your device tree nevertheless. The Configuration Guru option
Monit or LAN Servers will be marked with a green check mark as well if one or more servers
were defined in this section.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Monitor Websites/Online Shops

PRTG can monitor your website and online shop using http. Simply enter the URLs you want to
monitor, each in one line.

PRTG will create a new device for all of your websites, with one sensor for each URL.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

Monitor Cloud Services

To see if the cloud services that you usually use are up and running, PRTG can set up http
sensors for those as well. In the list of services, simply switch the radio button to Yes for each
service you want to monitor. Choose from:

§ Google Search, Google Mail, Google Drive


§ Microsoft Office 365
§ Salesforce
§ Dropbox
§ iCloud
§ Facebook
§ Twit t er
§ Sky pe

PRTG will create a new device for all of cloud services, with one sensor for each URL.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

12.05.2014 41
Part 2: Quick Start Guide | 2 TWO—Using the Configuration Guru

Discover a Network Segment

PRTG can scan an entire network segment, automatically detect devices, and create sensors
using its auto-discovery.

PRTG will try to automatically detect and pre-populate the respective fields with the correct IP
range. Please review and/or enter the entries. In the IPv4 Base field, enter the first three
octets of your network's IP range, for example 192.168.0 or 10.0.0, or whatever IP address
range you use. If you don't change the default values for IPv4 Range St art and End, PRTG will
automatically complete the IP base and scan all IP addresses ending in .1 to .254.

If you need more options regarding the definition of IP ranges, you can run additional auto-
discoveries later. Please see Aut o-Discovery 190 for more details.

Click the Save & Next button to apply your settings, or click the Skip button to skip this step.
Both buttons will take you to the next step.

You Are Done!

While you were busy using the guru, PRTG has already created devices and sensors for you.
There are first monitoring values available, too. In the meantime, you can follow PRTG on your
favorite social network by clicking on of the buttons for Facebook, Twitter, or Google +.

Click on the OK! Let me view my new sensors! button to view the device tree.

In order to get familiar with the PRTG web interface, we recommend you proceed with section
General Lay out 108 of the web interface, or with General Lay out 1898 of the Enterprise
Console.

42 12.05.2014
Part 3
Installing the Software

27.11.2012 43
Part 3: Installing the Software |

3 Installing the Software


This section describes how to download and install your PRTG product.

PRTG Setup

Please see the following sections for more information.

Installing the Software—Topics

§ Download PRTG 45

§ Updat e From Previous Versions 47

§ Inst all a PRTG Core Server 51

§ Inst all a PRTG Clust er 56

§ Ent er a License Key 57

§ Act ivat e t he Product 60

§ Inst all a PRTG Remot e Probe 62

§ Inst all t he Ent erprise Console 67

§ Uninst all PRTG Product s 71

44 27.11.2012
Part 3: Installing the Software | 1 Download PRTG

3.1 Download PRTG


On the Paessler website, you find two different installers for PRTG, a public download for the
Freeware, Special, and Trial editions, and a login link to download the commercial editions
(which is only available for paying customers).

PRTG Download on Paessler Website with Marked Full Version Download Link

Downloading the Freeware, Special, or Trial Edition

Please download the latest publicly available file from the Paessler website. You can also
request a trial key there, which must be entered during installation:

§ ht t p://www.paessler.com/prt g/download

27.11.2012 45
Part 3: Installing the Software | 1 Download PRTG

Note: Every Freeware installation will start as a Trial version, giving you an unlimited number of
sensors for 30 days. After the trial period has expired, your installation will automatically revert
to a Freeware edition with 10 sensors.

Note: A Special Edition is an extended Freeware version. If you meet certain requirements, you
can receive a Special Edition key from us which gives you an extended number of sensors for
free. For details, please see:

§ ht t p://www.paessler.com/prt g/download#30sensors

Downloading the Commercial Edition

Downloads and updates are free to customers with an active maintenance contract. Please log
into the Paessler website to get the latest download. You can also find your license key there,
which must be entered during installation:

§ ht t p://www.paessler.com/login

If you do not have an active maintenance contract, please contact [email protected].

Note: Once installed, you will usually use the Soft ware Aut o-Updat e 1878 function of PRTG to
download and install new versions. This will further ease the process of installing updates.

46 27.11.2012
Part 3: Installing the Software | 2 Update From Previous Versions

3.2 Update From Previous Versions


If you already have installed a previous software version, there are several things you should
consider before updating to the current PRTG version.

Note: We recommend you always have a proper backup of your monitoring data and
configuration. In most cases both will be maintained when upgrading. Anyway, we recommend
a backup before upgrading. Please see More 49 section below.

Update From PRTG Network Monitor 12 or later

If you have been running PRTG Network Monitor with version 12, 13 or 14, simply install 51 the
latest version on top of the previous version. Your configuration will be kept. If you have
configured PRTG as a cluster, you only have to install an update on any node server (master or
failover). The new version will then be deployed to the cluster automatically. Note: We
recommend you always have a proper backup of your monitoring data.

Note: As of PRTG 14, Int ernet Explorer 9 is no longer officially support ed for access to the
PRTG web interface.

Web Interface Customizations as of PRTG Network Monitor 13.2.3

As of PRTG version 13.2.3, the website folder of the PRTG program directory is not used any
more. This means that if you update from an older PRTG version than 13.2.3 to the current
version, all existing customizations of the web interface will be disabled and have to be
revised. You may find a way for a similar customization that can be applied to the files in the
current webroot folder which contains the web interface files now. For details, please see
section More 49 .

Update From PRTG Network Monitor 9

If you are using PRTG 9 now, your configuration will be kept when installing the current PRTG
version in St andalone Mode or when installing a Mast er Node. There are only a few things
you should consider.

§ Discont inued Sensors: Existing instances of the following sensor types will stop working as
of PRTG V12 and must be replaced with their successor sensor types!

- VMware Host Server (SOAP)


- VMware Virt ual Machine (SOAP)
- X en Virt ual Machine

If your configuration contains these sensor types, they will stop monitoring after upgrading
to the current version. We recommend you to pause them to keep their data. In order to
continue monitoring, please add the sensors anew (for example, using the auto-discovery).
§ Please inst all .NET 4.0: We strongly recommend installing .NET 4.0 on systems that run the
core server (and the remote probes, if you use those). Otherwise the following features will
not work: VMware 296 auto-discovery and monitoring, Citrix XenServer 343 auto-discovery
and monitoring, SIP Options Ping Sensor 899 , Windows Last Update Sensor 1457 .

28.05.2014 47
Part 3: Installing the Software | 2 Update From Previous Versions

§ Changed Geo Maps Provider: When you update to the current PRTG version, the provider
for geographical maps will automatically be switched from Google Maps to MapQuest (using
Open Street Map data).
§ Windows 2000 Not Support ed: Since PRTG 7 we do not officially support Windows 2000
systems any more. This means, PRTG cannot be installed on systems running Windows 2000,
and you cannot officially monitor Windows 2000 systems (for example, via WMI). However, if
you could successfully monitor your Windows 2000 systems with PRTG 9, this might actually
not be possible any more with the current PRTG version. Especially the WMI Service Sensor
1640 will show an error message when monitoring Windows 2000 systems under the current

PRTG version. For a work around, please see More 49 section below.

Update From PRTG Network Monitor 7 or 8

If you are using PRTG 7 or 8 now, your configuration will be kept when installing the current
PRTG version in St andalone Mode or when installing a Mast er Node. There are only a few
things you should consider.

Note: If you're running PRTG 7 or 8 we recommend you first update to the latest PRTG 8
version as an intermediate step, in order to make sure all data is carried over correctly. Please
contact technical support 2088 to obtain a download link for PRTG 8. In any case we recommend
you always keep a proper backup of your configuration and monitoring data.

Updat ing from PRTG 7 or 8 t o Current PRTG Version

§ Packet Sniffer (Content) sensors are not supported any more. Existing sensors of this type
will automatically be switched to Packet Sniffer (Header) sensors after the update. As a
benefit, you can now also sniff IPv6 traffic.
§ Internet Explorer 8 is no longer supported for access to the PRTG Ajax web interface or to
the mobile web GUI.
§ You may experience a slow Enterprise Console 1894 (former 'Windows GUI') due to different
reasons. For detailed information, please see the knowledge base article linked in the More
49 section below.

§ When installing a failover node on top of an existing stand-alone PRTG 7, 8, 9, 12, or 13+
installation, the configuration cannot be kept and is written to a backup folder. Then, the
new cluster configuration is received from the master node of the cluster. As all nodes work
with the same configuration, a failover node's old configuration and monitoring data can no
longer be used. If you want to keep a configuration of PRTG 7, please install the master node
on top of the old installation and use other servers for the failover node installations.

§ Since PRTG 9 the SNMP sensors use the IPv4 Out going IP set for the probe service (this
setting was formerly ignored by those sensors, using the aut o setting instead). If you
experience failing sensors, please check the setting in the PRTG Probe Administrator 2018 . For
detailed information please see More 49 section below.

§ If you have (manually) configured the PRTG probe or PRTG core service to run under a
different Windows user account (for example, for successful internet access through an ISA
server firewall), please apply the respective Windows user account for the
"PRTGProbeService" and/or "PRTGCoreService" anew after installing the current PRTG version.
For detailed information please see More 49 section below.

48 28.05.2014
Part 3: Installing the Software | 2 Update From Previous Versions

§ Probe core and probe now require: SP1 (or later) on Windows 2003, and SP2 (or later) on
Windows XP.

§ If you use the default data path in your PRTG setup, it will be changed automatically. Up to
version 8 all data was stored in a sub folder reflecting a PRTG version number (v7 or v8). As
of version 9 this sub folder is omitted, and data is stored directly at %ALLUSERSPROFILE%
\Application data\Paessler\PRTG Network Monitor. During setup, all data will be moved to
the new directory. If you use a custom data path it will not be changed.

§ Up to version 8 all data in the registry was stored in a sub key reflecting a PRTG version
number (v7 or v8). As of version 9 this sub key is omitted, and registry data is stored directly
under the key HKEY_LOCAL_MACHINE\SOFTWARE\Paessler\PRTG Network Monitor (on 32-bit
systems) respectively HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Paessler\PRTG
Network Monitor (on 64-bit systems). During setup, all existing registry values will be moved
to the new key.

Updat ing from PRTG 7 t o Current PRTG Version

§ Regarding custom sensors, the interpretation of returned values is handled more strict as of
PRTG 8. If you're using custom sensors with PRTG 7, these may not work with the current
PRTG version if they do not fully apply to the API definition 2031 .

Update From Older PRTG Products

For all other predecessor products, a direct data import into the current version is not
possible.

If you have been using IPCheck 5 or PRTG Traffic Grapher 6, please perform a clean installation
of PRTG Network Monitor and set up your configuration anew. Using PRTG's Aut o-Discovery
190 is the easiest way to quickly configure a monitoring of your entire network. Please see

Quick St art Guide 32 section for more information.

More

Knowledge Base: How do I backup all data and configuration of my PRTG installation?
§ http://kb.paessler.com/en/topic/523

Knowledge Base: What about my web interface customizations as of PRTG 13.2.3?


§ http://kb.paessler.com/en/topic/44703

Knowledge Base: How can I monitor a Windows service on Windows 2000?


§ http://kb.paessler.com/en/topic/36483

Knowledge Base: Why is the Enterprise Console so slow?


§ http://kb.paessler.com/en/topic/25413

28.05.2014 49
Part 3: Installing the Software | 2 Update From Previous Versions

Knowledge Base: Some of my SNMP sensors do not work after updating from PRTG 8 to PRTG
9 or later
§ http://kb.paessler.com/en/topic/25663

Knowledge Base: Probe Service or Core Service stop working after updating from PRTG 8 to
PRTG 9 or later
§ http://kb.paessler.com/en/topic/25463

Knowledge Base: How and where does PRTG store its data?
§ http://kb.paessler.com/en/topic/463

Knowledge Base: Can I update from PRTG Traffic Grapher or IP Check 5 to the current PRTG
version?
§ http://kb.paessler.com/en/topic/26553

Knowledge Base: How do I Import Data from PRTG Traffic Grapher 6 or IPCheck Server Monitor
5 in PRTG Network Monitor?
§ http://kb.paessler.com/en/topic/253

50 28.05.2014
Part 3: Installing the Software | 3 Install a PRTG Core Server

3.3 Install a PRTG Core Server


Installing PRTG is easy. It is similar to other Windows-based applications. To install the
application please run the installation setup program from the ZIP file that you have
downloaded.

Windows User Ac c ount Control Confirmation Request

Confirm the question of the Windows User Account Control with Yes to allow the program to
install. The usual software installation wizard will guide you through the installation process.

Setup Language Selec tion

Please select a language for your product and click the OK button. The available language
options depend on both your Windows version and the setup file.

28.05.2014 51
Part 3: Installing the Software | 3 Install a PRTG Core Server

Setup Wizard Start Sc reen

Please click Next to walk through the wizard.

Setup Wizard Lic ense Agreement

Please accept the license agreement and click Next .

52 28.05.2014
Part 3: Installing the Software | 3 Install a PRTG Core Server

Administrator Email Address

Please enter a valid email address. Your PRTG server will send important and urgent system
alerts to this address. Click the Next button to continue.

Lic ense Key Information

Please choose the folder you wish to install the software in. We recommend using the default
value.

28.05.2014 53
Part 3: Installing the Software | 3 Install a PRTG Core Server

Setup Wizard Destination Loc ation

As soon as you click Next , the necessary files will be copied to your disk.

Setup Wizard Installing

After installation, the Ajax Web Int erface 100 is opened in your system's default browser.
Please make sure there is Google Chrome 34 or later (recommended), Mozilla Firefox 28 or
later, or Microsoft Internet Explorer 10 or 11 available on the system, and set as default
browser (see Sy st em Requirement s 21 ).

54 28.05.2014
Part 3: Installing the Software | 3 Install a PRTG Core Server

Enter License Information

Only if you entered incorrect license information before you will be asked to enter a correct
license name and key.

Welc ome Wizard Enter Lic ense Information

Please enter both Name and Key exactly as stated in the email received from Paessler. We
recommend using copy&paste to avoid typing mistakes. For details, please see Ent er a
License Key 57 .

More
Knowledge Base: What is the PRTG Special Edition license?
§ http://kb.paessler.com/en/topic/8063

Knowledge Base: How can I establish a secure web interface connection to PRTG?
§ http://kb.paessler.com/en/topic/273

Knowledge Base: PRTG blocks port 80 although I'm using SSL on port 443. How to free port
80?
§ http://kb.paessler.com/en/topic/5373

28.05.2014 55
Part 3: Installing the Software | 4 Install a PRTG Cluster

3.4 Install a PRTG Cluster


PRTG offers single failover clustering in all licenses—even using the freeware edition. A single
failover cluster consists of two servers ("Current Master" Node and "Failover Node"), each of
them running one installation of PRTG. They are connected to each other and exchange
configuration and monitoring data. You can run a cluster with up to 5 nodes.

Illustration of a Single Failov er Cluster

For detailed information, please see Failover Clust er Configurat ion 2064 .

More
Knowledge Base: What's the Clustering Feature in PRTG?
§ http://kb.paessler.com/en/topic/6403

56 28.05.2014
Part 3: Installing the Software | 5 Enter a License Key

3.5 Enter a License Key


A license key for PRTG Network Monitor consists of the license name and a license key. The
key is a string consisting of approx. 70 characters.

Your Personal License Information

You should have received license name and key via email. This is either the information for a
Trial or a Commercial Edition.

Example of License Informat ion

License Name: John Q. Public


License Key: 0223515-FFSEJC-ZHGRDFM-UR1CS8-U73FGK-G645F2-YVF1DD-H8323N-
D11HG9-M2DRG

During the setup process, PRTG will ask you to enter your license information. Please use copy
and paste to fill out the form in the dialog shown by the installer.

§ Trial/Freeware license key : When entering a Trial license key you can experience unlimited
functionality of PRTG during the trial period. Your installation will automatically switch to a
Freeware Edition afterwards. In details how to get your free Trial installer, please see
Download PRTG 45 section.
§ Commercial license key : This key can only be entered if you install the Commercial Edition
of PRTG, available for download in the customer service center. See Download PRTG 46
section for details. Your installation will allow the number of sensors according to your
license.

Change License Key

Usually you do not need to enter a key manually, as it is prompted during installation.
However, there are still scenarios where you want to change your key, for example, when
switching from a Trial Edition to a Special Edition 19 .

If you need to enter new license information, please follow these steps.

Step 1: Make Sure You Have Installed the Correct Edition

Please check first if you have installed the proper edition and then enter the license key.

There are two different installers available for PRTG (see Download 45 section):

§ The publicly available installer only contains the Freeware, Special, and Trial Editions. It does
not accept any commercial license keys.
§ The Commercial installer is only available for download to paying customers.

14.01.2014 57
Part 3: Installing the Software | 5 Enter a License Key

The Commercial Installer must be installed to run the commercial editions of PRTG Network
Monitor. If y ou have purchased a license key for PRTG, please download and inst all t he
lat est Commercial Inst aller from t he Paessler websit e in order t o apply y our license
key . Note: You can install a commercial version "on top" of an existing Trial Edition in order to
maintain your configuration and monitoring data.

Step 2: Enter the License Key in the PRTG Server Administrator

Please start the PRTG Server Administ rat or program from the Windows Start Menu. In the
program, select the License tab.

Start M enu Ic on

To use a PRTG license with this installation of PRTG, please enter the license information you
have received from Paessler via email. To avoid typing errors, please copy and paste both the
License Name and the License Key from the email. Both must be transferred exactly as shown
in the email.

58 14.01.2014
Part 3: Installing the Software | 5 Enter a License Key

PRTG Serv er Administrator Lic ense Tab

To make sure your key has been entered correctly please click on the Check Key button. A
popup box will either show success or denial of your license information. License information
is also checked if you change tabs.

In the Licensed Edit ion field you will see an accepted license key.

Click on the Ok button to save and confirm to restart the core server service by clicking on
the Yes button.

PRTG Serv er Administrator Confirm Serv ic e Restart

14.01.2014 59
Part 3: Installing the Software | 6 Activate the Product

3.6 Activate the Product


PRTG tries to activate your license automatically via the internet on first start up. Only if PRTG
cannot connect to the internet directly, the web interface will display a Soft ware Act ivat ion
Required notice.

You have to run through the product activation process once in order to use PRTG
continuously (only Freeware and Trial Edition are always activated automatically and do not
require a special procedure). The activation has to be done within ten days after installation
and only takes a few minutes. If you do not activate PRTG for ten days, it will temporarily revert
to the Freeware Edition (with a maximum of 10 sensors) until you activate. Login to the PRTG
web interface 102 to activate.

Activate via Internet

In the PRTG web interface, choose Set up | PRTG St at us | Act ivat ion St at us from the main
menu.

Click on the button St art Act ivat ion Now to start product activation. PRTG will now connect
with the Paessler license server to check your license (via SSL on port 443). A few seconds
later you should see Act ivat ion OK in the License Activation Status.

Note: The PRTG core server needs an internet connection on port 443 to activate. If a proxy
connection is needed, please configure it in the Sy st em Administ rat ion—Core & Probes 1849
settings. Please see More 61 section for details about activation servers. In case activation
fails, you can activate via email.

Activate via Email

In the PRTG Web Interface, choose Set up | PRTG St at us | Act ivat ion St at us from the main
menu.

If there is no internet connection available, you can activate PRTG via email. To do so, first click
on the St art Act ivat ion Now button. You will then see Last message about act ivat ion:
Act ivat ion failed in the License Activation Status.

§ Once the activation via internet fails, the activation via email is available.
§ Click on the St art Act ivat ion per Email tab. You will see an Act ivat ion Request Code.
§ Copy it and send it to the email address shown.
§ Within two business days you will receive an email reply from Paessler, containing an
activation code.
§ Once you've received this email, go the Finalize Act ivat ion per Email tab and copy the
activation code into the according field. Note: Please make sure you only copy the code
itself and nothing else from the email. Also, please omit the "Activation Code Start/End"
markers.
§ Click on Confirm Act ivat ion.

60 28.05.2014
Part 3: Installing the Software | 6 Activate the Product

A few seconds later you should see Act ivat ion OK in the License Activation Status.

More
Knowledge Base: Which servers does PRTG connect to for Software Auto-Update and for
Activation?
§ http://kb.paessler.com/en/topic/32513

28.05.2014 61
Part 3: Installing the Software | 7 Install a PRTG Remote Probe

3.7 Install a PRTG Remote Probe


The local probe is already included in a PRTG core server installation 51 . You can install
additional remote probes on other computers in order to take load from the system running
the core installation or to extend monitoring to distributed networks. Note: You cannot install
a remote probe on a system already running a PRTG core installation.

Download Remote Probe Installer from the Web Interface

The remote probe version has to fit the PRTG core server version you will connect to. In order
download your setup program to the computer you want to install it on, please connect to the
Ajax web interface 102 . On the login screen 102 , enter login name and password and from the
main menu, select Set up | Downloads / Add-Ons | Remot e Probe Inst aller. Click on the
Download: Remot e Probe Inst aller button. Your browser will show a download dialog. Save
the setup program to your local hard disk drive.

Install Remote Probe

Please execute the setup program you've just downloaded.

Windows User Ac c ount Control Confirmation Request

Confirm the question of the Windows User Account Control with Yes to allow the program to
install. The usual software installation wizard will guide you through the installation process.

Setup Language Selec tion

62 14.01.2014
Part 3: Installing the Software | 7 Install a PRTG Remote Probe

Please select a language for your product and click the OK button. The available language
options depend on both your Windows version and the setup file.

Remote Probe Setup Wizard Welc ome Sc reen

Please click Next to walk through the wizard.

Setup Wizard Lic ense Agreement

After accepting the license agreement, you can choose the folder you wish to install the
software in. We recommend using the default value.

14.01.2014 63
Part 3: Installing the Software | 7 Install a PRTG Remote Probe

Setup Wizard Destination Loc ation

As soon as you click Next , the necessary files will be copied to your disk.

Windows GUI Setup Wizard Install

The PRTG Probe Administrator is shown. Please enter the correct settings in order to connect
with your PRTG core installation. See Remot e Probe Set up 2059 section for more information.
Click Ok to continue.

64 14.01.2014
Part 3: Installing the Software | 7 Install a PRTG Remote Probe

Probe Settings in PRTG Probe Administrator

When asked if you want to start the probe service, confirm with Yes. The installation is
completed.

PRTG Probe Administrator Start Serv ic e Request

After installation, click Finish.

14.01.2014 65
Part 3: Installing the Software | 7 Install a PRTG Remote Probe

Remote Probe Setup Wizard Finish

Your remote probe is now installed on this computer as Windows service.

More

After you click the Finish button, the PRTG Probe Administrator is shown, allowing you to
configure connections. Please see section Remot e Probe Set up 2059 for more information on
how to connect the remote probe with your PRTG core server installation.

Note: You can also install a Remote Probe directly from PRTG's web interface. For details, refer
to Remot e Probe Quick Inst all 2053 .

66 14.01.2014
Part 3: Installing the Software | 8 Install the Enterprise Console

3.8 Install the Enterprise Console


The Enterprise Console is already included in a PRTG core server installation 51 . You can install
additional Enterprise Consoles on other computers.

Download Enterprise Console from the Web Interface

The version of the Enterprise Console has to fit exactly the PRTG core server version you will
connect to. From the computer you want to install the Enterprise Console on, please connect
to the Ajax 100 web interface. On the login screen 102 of the web interface, enter login name
and password and select the Ent erprise Console (Download for Windows) option. You
browser will show a download dialog. Save the setup program to the local hard disk drive.

Install Enterprise Console

Please execute the setup program you just have downloaded.

Windows User Ac c ount Control Confirmation Request

Confirm the question of the Windows User Account Control with Yes to allow the program to
install. The usual software installation wizard will guide you through the installation process.

Setup Language Selec tion

Please select a language for your product and click the OK button. The available language
options depend on both your Windows version and the setup file.

14.01.2014 67
Part 3: Installing the Software | 8 Install the Enterprise Console

Windows GUI Setup Wizard Welc ome Sc reen

Please click Next to walk through the wizard.

Setup Wizard Lic ense Agreement

After accepting the license agreement, you can choose the folder you wish to install the
software in. We recommend using the default value.

68 14.01.2014
Part 3: Installing the Software | 8 Install the Enterprise Console

Setup Wizard Destination Loc ation

Select which icons will be created. We recommend using the default value.

Windows GUI Setup Wizard Additional Tasks

As soon as you click Next , the necessary files will be copied to your disk.

14.01.2014 69
Part 3: Installing the Software | 8 Install the Enterprise Console

Windows GUI Setup Wizard Install

After installation, click Finish to start the Enterprise Console.

Windows GUI Setup Wizard Finish

More

Please see section Ent erprise Console 1894 for more information on how to use this Graphical
User Interface (GUI).

70 14.01.2014
Part 3: Installing the Software | 9 Uninstall PRTG Products

3.9 Uninstall PRTG Products


The uninstall process has six steps—regardless of if you are uninstalling an entire PRTG
Network Monitor installation, a single Enterprise Console installation, or a PRTG Remote Probe
installation. Use the Windows uninstall routines to remove the PRTG software from your
system.

Step 1

From the Windows Start Menu, select the Uninst all PRTG Net work Monit or icon, the
Uninst all PRTG Ent erprise Console icon, or the Uninst all PRTG Remot e Probe icon, or open
your Windows Control Panel and choose the respective entry in the Programs section.
Depending on the installed products, not all uninstall programs are available.

Start Menu Ic ons

Step 2

If asked, confirm the question of the Windows User Account Control with Yes to allow the
program to uninstall. The usual software uninstall wizard will guide you through the uninstall
process.

Windows User Ac c ount Control Request

Step 3

Confirm the removal of the software by clicking the Yes button.

28.05.2014 71
Part 3: Installing the Software | 9 Uninstall PRTG Products

Uninstall PRTG Network Monitor Step 1

Step 4

Wait while the software is being removed.

Uninstall PRTG Network Monitor Step 2

Step 5

Confirm a system restart by clicking the Yes button.

72 28.05.2014
Part 3: Installing the Software | 9 Uninstall PRTG Products

Uninstall PRTG Network Monitor Step 3

Step 6

After system restart, the software is removed. However, there are still custom data in the PRTG
program folder left. If you have uninstalled an entire PRTG Network Monitor installation or a
remote probe installation, your monitoring data is still stored on the system. To completely
remove all PRTG data, please delete the PRTG Net work Monit or program folder as well as the
Paessler\PRTG Net work Monit or folder in your data path. For more information where data is
stored see Dat a St orage 2074 section.

More
Knowledge Base: Can we remotely and silently uninstall a Remote Probe?
§ http://kb.paessler.com/en/topic/27383

28.05.2014 73
Part 4
Understanding Basic Concepts

14.01.2014 75
Part 4: Understanding Basic Concepts |

4 Understanding Basic Concepts


There are a number of basic concepts that are essential for understanding the functionality and
ease of use of PRTG Network Monitor. We have made using our software as easy as possible;
setting it up for the first start and getting first monitoring results happens almost automatically.
Nevertheless, there are some basic principles we would like to explain to you. Please read this
section carefully to understand the underlying workflow like architecture of the monitoring
system, hierarchy of objects, settings inheritance, notifying, etc. Afterwards, you will be able to
enhance your monitoring experience permanently.

Understanding Basic Concepts—Topics


§ Archit ect ure and User Int erfaces 77

§ Clust ering 81

§ Object Hierarchy 83

§ Inherit ance of Set t ings 87

§ Tags 89

§ Dependencies 90

§ Scheduling 91

§ Not ify ing 92

§ Dat a Report ing 93

§ User Access Right s 94

§ IPv6 97

76 14.01.2014
Part 4: Understanding Basic Concepts | 1 Architecture and User Interfaces

4.1 Architecture and User Interfaces


PRTG Network Monitor consists of different parts which can be divided into three main
categories: System parts, control interfaces, and basic administration interfaces.

Ty pe Part of PRTG

System Parts Core Server 78


This is the central part of a PRTG installation and includes data
storage, web server, report engine, a notification system, and
more. The core server is configured is Windows service which run
permanently.

Probe(s) 78
The part of PRTG on which the actual monitoring is performed.
There are local probes, remote probes, and cluster probes
available. All monitoring data is forwarded to the central core
server. Probes are configured as Windows services which run
permanently.

User Interfaces Ajax Web Int erface 100


The Ajax-based web interface is used for configuration of devices
and sensors, as well as the review of monitoring results. Also
system administration and user management are configured here.

Ent erprise Console 1894


A native Windows application (former Windows GUI) as alternative
to the web interface to manage your monitoring. With the
Enterprise Console, you can connect to different independent PRTG
core server installations and review their data at a glance!

Mobile Web GUI 1947


A read-only interface optimized for mobile access to your PRTG
installation. View latest states, tables, and graphs. Using jQuery
Mobile, this interface is compatible with almost all mobile devices
available on the market, as well as with older and unsupported
browser versions.

Smart Phone Apps 1950


Monitor your network on the go with PRTG and apps for iOS and
Android devices.

PRTG Server Administ rat or 1999


System Administration Used to configure basic core server settings, such as administrator
Programs login, web server IPs and port, probe connection settings, cluster
mode, system language, and more.

14.01.2014 77
Part 4: Understanding Basic Concepts | 1 Architecture and User Interfaces

Ty pe Part of PRTG

PRTG Probe Administ rat or 2016


Used to configure basic probe settings such as name of the probe,
IP and server connection settings, and more.

Core Server

The core server is the heart of your PRTG system and performs the following processes:

§ Configuration management for object monitoring


§ Management and configuration of the connected probes
§ Cluster management
§ Database for monitoring results
§ Notification management including a mail server for email delivery
§ Report generator and scheduler
§ User account management
§ Data purging (culling data that is older than 365 days, for example)
§ Web server and API server

In a cluster 81 , the current master node is responsible for all of these tasks.

The built-in, fast, and secure web server (no additional IIS or Apache is required) supports HTTP
as well as secure HTTPS (via SSL). It serves the web interface when accessed with a browser
and also answers PRTG Application Programming Interface (API) calls (for example, for user
scripts or the Enterprise Console).

Note: Core server and probe(s) are configured as Windows services which are permanently run
by the Windows system without the requirement for a logged-in user.

Probe(s)

On a probe, PRTG performs the actual monitoring with the sensors created on a device (for
example, computer, router, server, firewall, etc.). The probe receives its configuration from the
core server, runs the monitoring processes, and delivers monitoring results back to the core
server. On every system running a PRTG core server, there is always a local probe running with
it on the same machine.

78 14.01.2014
Part 4: Understanding Basic Concepts | 1 Architecture and User Interfaces

PRTG Core Serv er and Loc al Probe Monitoring a Loc al Area Network

The actual monitoring is performed by PRTG probe processes which run on one or more
computers. During installation, the system automatically creates the so-called Local Probe. In a
single-probe installation—which is the default setup—the local probe performs all monitoring.

The PRTG core server inside the corporate LAN (bottom right in the figure above) is able to
monitor services and servers in the entire Local Area Network (LAN). Note: Core server and
probe(s) are configured as Windows services which are permanently run by the Windows
system without the requirement for a logged-in user.

In a cluster setup 81 , a cluster probe runs on all nodes. There is an additional so-called Clust er
Probe. All devices created on it are monitored by all nodes in the cluster, so data from
different perspectives is available and monitoring for these devices always continues, also if
one of the nodes fails.

PRTG automatically monitors system health of its own core server and of each probe in order
to discover overloading situations that may distort monitoring results. To monitor the system
status of the probe computer, PRTG automatically creates a few sensors. These include Core
and Probe Healt h, Sy st em Healt h, Clust er Probe Healt h, Disk Free, and a bandwidth sensor
for all installed network cards. We recommend keeping these sensors, but you can optionally
remove all except the Healt h sensors. They measure various internal system parameters of
the probe system hardware and the probe's internal processes and then computes a resulting
value. Frequent or repeated values below 100% should be investigated. Please check the
channels 124 of a particular sensor for details.

Additional so-called Remot e Probes can be created by the user in order to achieve monitoring
of multiple locations, or for several other scenarios. They are using SSL-secured connections
to the core and allow to securely monitor services and systems inside remote networks which
are not openly accessible or secured by firewalls. For more information, please see Remot e
Probes and Mult iple Probes 2049 section. For a video on this please see More 203 section
below.

More
Video Tutorial: There is a video available on the Paessler video tutorials page.
§ http://www.paessler.com/support/video_tutorials

14.01.2014 79
Part 4: Understanding Basic Concepts | 1 Architecture and User Interfaces

80 14.01.2014
Part 4: Understanding Basic Concepts | 2 Clustering

4.2 Clustering
A PRTG Cluster consists of two or more installations of PRTG 51 that work together to form a
high availability monitoring system. The objective is to reach true 100% uptime for the
monitoring tool. Using clustering 2064 , the uptime will no longer be degraded by failing
connections because of an internet outage at a PRTG server's location, failing hardware, or
because of downtime due to a software update for the operating system or PRTG itself.

How a PRTG Cluster Works

A PRTG cluster consists of one Primary Mast er Node and one or more Failover Nodes. Each
node is simply a full installation of PRTG which could perform the whole monitoring and alerting
on its own. Nodes are connected to each other using two TCP/IP connections. They
communicate in both directions and a single node only needs to connect to one other node
to integrate into the cluster.

During normal operation the Primary Mast er is used to configure devices and sensors (using
the web interface 100 or Enterprise Console 1894 ). The master automatically distributes the
configuration to all other nodes in real time. All nodes are permanently monitoring the
network according to this common configuration and each node stores its results into its own
database. This way, the storage of monitoring results also is distributed among the cluster (the
downside of this concept is that monitoring traffic and load on the network is multiplied by the
number of cluster nodes, but this will not be a problem for most usage scenarios). The user
can review the monitoring results by logging into the web interface of any of the cluster nodes
in read only mode. Because the monitoring configuration is centrally managed, it can only be
changed on the master node, though.

By default, all devices created on the Clust er Probe are monitored by all nodes in the cluster,
so data from different perspective is available and monitoring for these devices always
continues, even if one of the nodes fails. In case the Primary Mast er fails, one of the Failover
Nodes takes over the master role and controls the cluster until the master node is back. This
ensures a fail-safe monitoring with gapless data. Note: During the outage of a node, it will not
be able to collect monitoring data. The data of this single node will show gaps. However,
monitoring data for this time span is still available on the other node(s). There is no
functionality to actually fill in other nodes' data into those gaps.

If downtimes or threshold breaches are discovered by one or more nodes, only one
installation, either the Primary Master or the Failover Master, will send out notifications (via
email, SMS text message, etc.). Thus, the administrator will not be flooded with notifications
from all cluster nodes in case of failures.

Set Up a PRTG Cluster

For detailed information, please see Failover Clust er Configurat ion 2064 .

More
Knowledge Base: What's the Clustering Feature in PRTG?
§ http://kb.paessler.com/en/topic/6403

28.05.2014 81
Part 4: Understanding Basic Concepts | 2 Clustering

82 28.05.2014
Part 4: Understanding Basic Concepts | 3 Object Hierarchy

4.3 Object Hierarchy


All objects in a PRTG monitoring configuration are arranged in a tree-like hierarchy to create an
easy to navigate list and to give the user the possibility to arrange them in groups that monitor
similar devices, services, or same locations. The hierarchical order described is also used to
define common settings for larger groups of objects, for example, settings of the Root group
apply by default to all other objects underneath (see section Inherit ance of Set t ings 87 ).

Objec t Hierarc hy in PRTG

The figure shows the object hierarchy in PRTG:

§ Root group contains all objects in your setup; all probes are directly under the root node.
§ A Probe contains one or more groups.
§ A Group contains one or more devices.

14.01.2014 83
Part 4: Understanding Basic Concepts | 3 Object Hierarchy

§ A Device represents one component in your network which is reachable via an IP address.
On a device are several sensors.
§ A Sensor monitors one single aspect of a device and has at least one channel.
§ A Channel receives the monitoring results and is part of a sensor.

Root Group

The Root group is the topmost instance in PRTG. It contains all other objects in your setup.
Using the inheritance 87 mechanism, we recommend adjusting the default settings for the
Root group 224 . This makes configuration easier later on, because all other objects inherit
these standard settings by default and, thus, you will not have to set up the same
configuration for each object anew.

Probe

Each group (except the Root group) is part of a Probe. This is the platform on which the
monitoring takes place. All objects configured below a probe will be monitored via that probe.
Every PRTG core installation automatically installs a Local Probe service. You can add additional
probes and remote probes to your configuration to include remote devices from outside your
network into the monitoring (see section Mult iple Probes and Remot e Probes 2049 ). In a
cluster, there is an additional Clust er Probe running on all nodes. Devices on the cluster
probe are monitored by all nodes of the cluster, so data from a different perspective is
available and monitoring for these devices will always continue, even if one of the nodes fails.

Group

On each probe, there are one or more Groups, which serve merely structural purposes. Use
groups to arrange similar objects in order to inherit same settings to them. To a group, you
add the devices. You can arrange your devices in different nested groups to reflect the
structure of your network.

Find below a sample configuration: A device tree with local probe, several groups, devices and
their sensors.

84 14.01.2014
Part 4: Understanding Basic Concepts | 3 Object Hierarchy

PRTG Dev ic e Tree View

Device

To each probe or group, you can add Devices that you want to monitor. Each device in your
PRTG configuration represents a real hardware or virtual device in your network. These can be,
for example:

§ Web or file server


§ Client computer (Windows, Linux, or Mac OS)
§ Router or network switch
§ Almost every device in your network that has its own IP address

Note: Sometimes you may want to add the same device in PRTG several times, in order to get a
better overview when using many sensors for a very detailed monitoring, or to use different
device settings for different groups of sensors. In PRTG you can simply add multiple devices
with the same IP address or DNS name. The sensors on all of these PRTG devices will then
query the same real hardware device in your network.

PRTG additionally adds a so called Probe Device to the local probe. This is an internal system
device. It has access to the computer on which the probe is running on and monitors its
health parameters with several sensors running on it.

14.01.2014 85
Part 4: Understanding Basic Concepts | 3 Object Hierarchy

Sensor

On each device you can create a number of Sensors. Every sensor monitors one single aspect
of a device. This can be, for example:

§ One network service like SMTP, FTP, HTTP, etc.


§ One network switch port's traffic
§ CPU load of a device
§ Memory load of a device
§ Traffic on one network card
§ One NetFlow device
§ System health of a device
§ Other content (for example, of databases, mails, HTTP, XML, files, etc.)
§ etc.

Channel

Every sensor has a number of Channels through which it receives the different data streams.
The available channels depend on the type of sensor. One sensor channel can contain, for
example:

§ Downt ime and upt ime of a device


§ Traffic in of a bandwidth device (for example, a router)
§ Traffic out of a bandwidth device (for example, a router)
§ Traffic sum of a bandwidth device (for example, a router)
§ WWW t raffic of a NetFlow device
§ Mail t raffic of a NetFlow device
§ Ot her t raffic of a NetFlow device
§ CPU load of a device
§ Loading t ime of a web page
§ Download bandwidt h of a web page
§ Time t o first by t e of a web page
§ Response t ime of a Ping request to a device
§ Response t ime of a Remote Desktop service
§ etc.

86 14.01.2014
Part 4: Understanding Basic Concepts | 4 Inheritance of Settings

4.4 Inheritance of Settings


The hierarchical tree 83 is not only used to group sensors for organizational reasons, there is
also an important aspect involved that we call inheritance. To ensure administration is quick
and easy—especially for large monitoring setups—certain settings are inherited from the
overlying level. For example, you can change the monitoring interval for all sensors by editing
the interval setting of the topmost Root group (unless no other setting is defined below).

Settings are Inherited to Child Objects

You can override this inheritance on any level of the hierarchy by setting a different value for a
specific probe, group, device, or sensor. All objects below will inherit these new settings;
object settings from levels above will stay unchanged.

Settings that are inherited among all objects include:

§ Monitoring interval
§ Notification triggers
§ Authentication settings for several systems
§ Compatibility settings (for certain types of sensors)
§ Channel and unit configuration
§ User access rights 94

§ Tags 89

§ Paused status: If an object is paused by the user, or a schedule, all sensors on it are paused
as well
§ etc.

There is one exception for devices and sensors: The IP address or DNS name of a device and
compatibility settings are always inherited by sensors and can not be changed on sensor level.

The actual overriding of the parent's settings takes place in an object's settings: Remove the
check mark symbol at the beginning of the respective line inherit from [parent object ]. For
example, the screenshot below shows Windows systems credentials settings after removing
the check mark symbol.

Credentials for Windows Sy stems

14.01.2014 87
Part 4: Understanding Basic Concepts | 4 Inheritance of Settings

Default Values Set in Root Group

For all settings (except passwords), PRTG already includes a set of default values so you can
get started with the software immediately. For example, the following settings will be inherited
by all sensors from the Root group:

§ Default monitoring interval of one minute


§ SNMP version 1 with community string set to public (default values for most devices)
§ Dependency type Use parent
§ etc.

You may need to change some of the default entries as you become used to the interface.
However, these settings will initially suffice for most situations.

Before sensor setup, please review the Root group's settings and set the default values to
suit your setup, including necessary credentials for all kinds of systems in your network you
want to monitor (Windows, Linux, virtual servers, etc.).

See section Root Group Set t ings 224 for more details.

Inheritance of Notification Triggers

If you add notification triggers on probe, group, or devices level, these will also be inherited to
all sensors underneath, unless you cancel inheritance with specific settings.

See section Sensor Not ificat ions Set t ings 1716 for details.

88 14.01.2014
Part 4: Understanding Basic Concepts | 5 Tags

4.5 Tags
For every object in your PRTG setup, you cannot only name objects, but also define tags in an
object's settings 142 to additionally mark an object as a member of certain categories. Although
there are tags predefined when adding objects 204 , you are completely free in the way you add
tags. For example, you can mark all of the bandwidth sensors which are especially important
for you with the tag bandwidth_important. Later, you can view lists of objects with certain tags
(helpful for multi-edit 1736 of settings), or choose sensors by tag when creating reports 1775 . A
clever arrangement of tags can save you a lot of time at some point. Note: You can also
change tags for several objects at a time using the multi-edit 1736 function.

View and Edit Tags in Basic Sensor Settings

Tags Are Inherited

The tags in an object's settings are automatically inherited 87 to all other objects further down
in the hierarchy. So, for example, a device with the tag myExampleTag will automatically and
invisibly inherit this tag to all sensors created on it. This will not be visible in the sensor's tag
settings, but the sensors will appear in the list whenever you search for myExampleTag. This is
useful, for example, when adding sensors by tag in reports 1775 settings. This way, in order to
configure your setup for fetching all sensors on a device by tag, you do not have to tag every
single sensor, but it is enough to tag the device. Inheritance for tags cannot be disabled.

14.01.2014 89
Part 4: Understanding Basic Concepts | 6 Dependencies

4.6 Dependencies
Using dependencies, you can pause sensor monitoring based on the status of another sensor
in order to avoid false alarms and incorrect downtime recording. A dependency stops the
monitoring of one sensor or a set of sensors as soon as a specific sensor is not in an Up
status. This means, for example, you can stop monitoring remote network services when the
corresponding firewall is down due to connection problems.

When using the auto-discovery 190 function, the Ping sensor on a device is by default set as
the master object for this device. This means that monitoring for the entire device is paused if
the Ping sensor is in a Down status. Usually, it does not make sense to monitor other aspects
of a device with other sensors, while the Ping sensor indicates that the device is not even
reachable.

In order to view a list of all dependencies or only selected dependencies, choose Devices |
Dependencies from the main menu 176 .

For more information about the dependency settings, please see the settings of the
respective object 142 you want to set a dependency for.

90 14.01.2014
Part 4: Understanding Basic Concepts | 7 Scheduling

4.7 Scheduling
Using schedules, monitoring of an object can be paused 162 for a certain time, for example,
Sundays between 4 and 8 a.m. A paused sensor will not collect monitoring data, will not
change its status, and will not trigger any notifications 92 . With schedules you can limit the
monitoring time automatically. You can also pause monitoring for planned system maintenance
time spans to avoid false alarms. You can apply different schedules to every object. They are
also used for reports and notifications.

Av ailable Default Sc hedules in Dev ic e Settings

Schedules are user account specific. To change the default pre-defined schedules or to add
your own schedule, please see Account Set t ings—Schedules 1827 section.

Note: If you use failover clustering with nodes in different timezones, scheduling applies at the
local time of each node. For more information, please see section Failover Clust er
Configurat ion—Before Get t ing St art ed 2064 .

14.01.2014 91
Part 4: Understanding Basic Concepts | 8 Notifying

4.8 Notifying
PRTG Network Monitor keeps the administrator or other responsible persons informed about
the current status of the network. There are several methods how the administrator can stay
up to date.

Notifications

This is the most powerful information tool. Whenever PRTG discovers downtime, an overloaded
system, threshold breach (for example, a disk runs full), or similar situations, it can send a
notification. Notifications use various methods by which you can be notified (for example,
email, SMS, pager message, and others). After creating notifications in the system settings, you
can select them on the notifications tab of probes, groups, devices, and sensors, as well as on
the root group. See Not ificat ions 1749 section for more details.

Limits

In a sensor channel's settings 1709 , you can set limits to change the status of the sensor when
certain limits are breached. This way, you can set, for example, a traffic sensor (typically never
in a error status) to Down status whenever bandwidth values are measured that you consider
critical. This sensor will then show up in the alarms list.

Alarms

The alarms list shows all sensors that are currently in a Down, Down (Acknowledged),
Warning, or Unusual status. This is useful to keep track of all irregularities in your network. In
the table list, you can re-sort the items by clicking on the column's header items. See Alarms
144 section for more details.

Logs

In the logs list, the log file with all monitoring events is shown. In a typical setup, a huge
amount of data is produced here. As the activity of every single object is minuted, you can use
this data to check exactly if your setup works as expected. See Logs 147 section for more
information.

Tickets

The tickets list shows items with important system information or action steps to take for the
administrator. You should view every ticket and take appropriate actions. Per default, an email
is sent to the administrator for every new ticket that is created by the system or another user.
If a ticket is assigned to a specific user, this user will get an email by default. See Ticket s 149
section for more information.

92 14.01.2014
Part 4: Understanding Basic Concepts | 9 Data Reporting

4.9 Data Reporting


With Report s 1775 you can analyze and review monitoring data for specific time spans. There are
several ways to create data reports in PRTG for your individual needs.

View Historic Data

To get a report for a single sensor, there is a function included to review historic data in PRTG.
It allows you to generate reports and charts for a single sensor's data. See Hist oric Dat a
Report s 133 section for more information.

Generate Reports

You can use the sophisticated reports machine included in PRTG to create exhaustive reports
for all monitoring data. See Report s 1775 section for more information.

Export Data Using the API

You can also export all monitoring raw data to XML or CSV files and generate your own
reports using any third party software. See Using t he PRTG API (Applicat ion Programming
Int erface) 2031 section for more information.

Make Data Available

You can make monitoring data available to other persons using a special user with read-only
rights (see User Access Right s 94 section), or you can create public or semi-public HTML
pages with monitoring data using the Maps feature. See Maps 1794 section for more
information.

Bill Customers

You can also create custom billing reports based on PRTG's monitoring data, using the open
source Billing Tool for PRTG. For details and download, please see More 93 section below.

More

§ Dat a St orage 2074

Paessler Website: Billing Tool


§ http://www.paessler.com/tools/billingtool

14.01.2014 93
Part 4: Understanding Basic Concepts | 10 User Access Rights

4.10 User Access Rights


The default administrator can use the PRTG installation as the only user or can create an
unlimited number of users. Users are organized in an unlimited number of user groups. Access
rights for each individual object in your PRTG device tree 83 can be given separately for each
user group (except for sensor channels). Access rights to objects can also be inherited 87 .

In addition, every single user has specific rights: There are administrator users, read/write
users, and read only users. You can define these settings in Sy st em Administ rat ion—User
Account s 1856 . With these tools, you can create a rights management that allows you to specify
exactly what users will be able to see and edit.

User Rights in User Ac c ount Settings

Individual user rights in combination with access rights of the group(s) they belong to conduct
the access rights to certain objects in the device tree. This means that group membership
particularly controls what a user is allowed to do and which objects the user will see when
logged in.

The actual access rights for each object in the device tree can be defined in an object's
settings. You can define different access rights for all sensors, devices, groups, or probes via
the corresponding Cont ext Menus 163 or in the Object Set t ings 142 .

Access Rights Overview

The following classes of access rights for objects are available in hierarchical order as they can
be given to user groups (lowest rights to highest rights):

§ None: The object will not be displayed to the users of the group; no logs, no tickets, no
alarms regarding this object will appear.
§ Read: Only monitoring results can be seen.
§ Writ e: Reviewing monitoring results and editing settings is allowed. In addition, objects can
be added to and deleted from the device tree.
§ Full: Reviewing monitoring results, editing settings, and editing access rights is allowed. In
addition, objects can be added to and deleted from the device tree.
§ Admin right s: If a user group has administrator rights, all options are available, including
creating users, creating user groups, and deleting objects from the device tree. Access
restrictions to objects cannot be set for this type of user group.

94 14.01.2014
Part 4: Understanding Basic Concepts | 10 User Access Rights

Note: Access rights that are defined locally on an object, for example, on a device, override
inherited 87 rights. On a certain object, the highest directly set access right applies for a user
group. If there is no access right set directly on an object, the next higher object level will be
checked for access rights. This process is repeated until defined access rights are found to be
inherited or there is no higher object level.

Different Ac c ess Rights for a Firewall in the Dev ic e Tree Depending on User Groups

Please see the table below for which user rights apply when. Column headings show access
rights of user groups for objects in the device tree; line headings show the type of user.

Note: Users are either in PRTG user groups or in Active Directory Domain user groups. They
cannot be in both. We recommend to use only one type of user group (either PRTG or Active
Directory) to minimize your administration effort.

§ PRTG User § PRTG User § PRTG User § PRTG Sy st em


Group Group Group Administ rat or
§ Domain User § Domain User § Domain User § Domain
Group Group Group Administ rat or
Read Access Read/Writ e Full Access
Access
§ PRTG User Read Read-only rights Read-only rights Read-only rights Admin rights
Only
§ Domain User
Read Only

14.01.2014 95
Part 4: Understanding Basic Concepts | 10 User Access Rights

§ PRTG User Read-only rights Read/write rights Full access Admin rights
Read/Writ e
§ Domain User
Read/Writ e

§ Users in an administ rat or group have always administrator access rights, no matter of the
access rights of an object.
§ Read-only users have just read rights, no matter of the access rights of their group, except
for users which are members of an administrator group.
§ Read/writ e users in a group with full access to an object have full access rights to this
object only.
§ If a user is in more than one group, access rights of the user group with the highest right s
apply .
§ Administrator rights can only be given via the administrator group.

For more information about defining access rights, please see the following sections:

§ Sy st em Administ rat ion—User Account s 1856

§ Sy st em Administ rat ion—User Groups 1861

For information about connecting PRTG to an existing Active Directory, please see Act ive
Direct ory Int egrat ion 2029 .

96 14.01.2014
Part 4: Understanding Basic Concepts | 11 IPv6

4.11 IPv6
PRTG supports the IPv6 protocol for most sensor types. You can define whether data from
your network is queried via IPv4 or IPv6: For each device in PRTG you can select whether PRTG
will connect to it using either IPv4 or IPv6. This is a simple selection in the Device Set t ings 272
of each device. Depending on the setting, the sensors created on this device will use the
respective protocol.

In the Out going IP Set t ings of the PRTG Probe Administ rat or 2018 you can additionally
choose which IPv6 address will be used for outgoing monitoring requests. Note: There is the
same option for IPv4, too.

14.01.2014 97
Part 5
Ajax Web Interface—Basic Procedures

14.01.2014 99
Part 5: Ajax Web Interface—Basic Procedures |

5 Ajax Web Interface—Basic Procedures


The Ajax-based web interface is your access to PRTG. It is used to configure devices and
sensors, and to set up notifications, as well as to review monitoring results and to create
reports. This web interface is highly interactive, uses Asynchronous Java Script and XML (AJAX)
to deliver a powerful and easy-to-use user experience. While the user is logged in 102 , the data
on the screen is permanently refreshed (via Ajax calls) so it always shows the current
monitoring results (refresh interval and method can be set 1856 by the user).

Because the web interface works as a Single Page Application (SPA), you will rarely see a full
page refresh to avoid this performance impact due to redundant processing. Only single page
elements will be refreshed when necessary. All object setting dialogs are shown as pop-up
layers, so you will never lose the current context. This speeds up the user experience
appreciably and makes the configuration of objects in PRTG comprehensible.

The following sections introduce the features and concepts of the Ajax Graphical User
Interface (GUI).

100 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures |

Ajax Web Interface—Basic Procedures—Topics


§ Login 102

§ SSL Cert ificat e Warning 105

§ General Lay out 108

§ Sensor St at es 121

§ Review Monit oring Dat a 124

§ Compare Sensors 130

§ Hist oric Dat a Report s 133

§ Similar Sensors 138

§ Object Set t ings 142

§ Alarms 144

§ Logs 147

§ Ticket s 149

§ Working wit h Table List s 156

§ Object Select or 159

§ Priorit y and Favorit es 160

§ Pause 162

§ Cont ext Menus 163

§ Hover Popup 174

§ Main Menu St ruct ure 175

Other Ajax Web Interface Sections


§ Ajax Web Int erface—Device and Sensor Set up 188

§ Ajax Web Int erface—Advanced Procedures 1726

Related Topics
§ Ent erprise Console 1894

§ Ot her User Int erfaces 1946

14.01.2014 101
Part 5: Ajax Web Interface—Basic Procedures | 1 Login

5.1 Login
Once the PRTG core server is installed 51 , you can log in to the web interface. In your browser,
load the IP address or DNS name of the computer PRTG is installed on and log in using the
Default Login button.

You can look up and change PRTG's web server settings at any time using the PRTG Server
Administrator 1999 Windows application on the system where the PRTG core server is installed
on. Especially when accessing PRTG from the internet you should use an SSL encrypted
connection. You can easily switch to SSL using the Yes, swit ch t o SSL button shown on the
welcome screen.

Loading the Web Interface

In a web browser window, please enter the IP address or URL of the system PRTG is installed
on. When using a cluster, please connect to the primary master node. You can also double
click on the PRTG Net work Monit or icon on the desktop of the system PRTG is installed on.

Note: If you run PRTG on localhost, please do not use the DNS name http://localhost to log in
to the web server, as this may considerably slow down PRTG's web interface. Please use your
local IP address or http://127.0.0.1 instead.

Desktop Ic on

If you see a certificate warning in your browser, you can usually just confirm it. For more
information please see SSL Cert ificat e Warning 105 .

Login Screen

After loading the web interface, the login screen is shown. You can either login as default
administrator or as an other PRTG user. As Administrator user you can use all functionalities of
the web interface. Administrators can create additional users 1856 with administrator rights or
with more restricted privileges (for example, read only users).

Additionally, there are different GUI versions available.

102 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 1 Login

PRTG Login Sc reen

Login as Default Administrator (First Time Login)

When logging in for the first time, login name and password for the default administrator login
are both prt gadmin. You can leave the login name and password fields empty and click on
the Default Login button to log in using these default credentials.

Note: After login you should change the default password. To do so, go to Set up | Account
Set t ings | My Account and specify a new password in section User Account .

Note: If you are not logged in into the web interface, you can change the credentials for this
default user account any time in the PRTG Server Administrator 2010 Windows application.

Login as PRTG User

If you have received user credentials from your administrator, please enter them here to login.
Also, when using other administrator credentials, please enter them here.

Choose GUI version

Depending on the used browser, different Graphical User Interface (GUI) options are shown:

§ Use AJAX Web GUI (All feat ures, opt imized for deskt op access): The standard interface.
We recommend to use this option for PRTG whenever possible. It offers the full functionality
of PRTG. Use Google Chrome 34 or later (recommended) or Mozilla Firefox 28 or later for
best performance. In some browsers, the Ajax option is not shown, for example, in old
browser versions.
· Note: Although you can login using Microsoft Internet Explorer 10 or 11, the Ajax web
interface might not be fully compatible with Internet Explorer! When using Microsoft
Internet Explorer 10 or 11, please set the security level at least to Default level Medium-
high and make sure you do not use the Compat ibilit y View! For detailed information,
please see More 104 section below.

28.05.2014 103
Part 5: Ajax Web Interface—Basic Procedures | 1 Login

§ Use Mobile Web GUI (Limit ed funct ionalit y , opt imized for mobile access): The Mobile
Web GUI 1947 interface is optimized for slow network connections and old browsers. It only
offers read-only functionality and comes with less scripting. It is also a fallback solution when
using a browser that is not supported by the Ajax interface.

§ Download Client Soft ware (for Windows, iOS, Android): This option calls PRTG's download
page in the Mobile Web GUI. You can optionally download the native Windows application
Ent erprise Console to the desktop (called Windows GUI in previous deprecated PRTG
versions). It has to be installed 1894 on the client computer before use. The Enterprise
Console 1894 provides full functionality; however, for some functions the Ajax Web GUI is
opened. As an additional feature, the Enterprise Console can view data of several
independent PRTG core installations in a single application.
You can also access pages on Paessler's website from here for information about the PRTG
apps 1950 PRTG for Android and iPRTG for iOS. These pages contain also the download links
for the apps for your mobile device. Note: Also when using this download option, login
name and password (or a Default Login) are required!

Note: Only Google Chrome 34 or later (recommended) and Mozilla Firefox 28 or later are fully
compatible with the Ajax web interface. For more information about Internet Explorer support,
please see More 104 section below.

Click on the Login button to proceed to the PRTG web interface.

More
Knowledge Base: Why are Internet Explorer IE6 and IE7 not supported by PRTG's Ajax Interface?
§ http://kb.paessler.com/en/topic/7633

Knowledge Base: How can I access the AJAX web interface of PRTG with Internet Explorer 9 or
IE10?
§ http://kb.paessler.com/en/topic/46893

104 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 2 SSL Certificate Warning

5.2 SSL Certificate Warning


If you use PRTG outside your internal LAN, especially when using it on the internet, you should
switch the internal web server to use SSL. After doing so, your browser will show a certificate
warning, as the certificate that comes with PRTG cannot be signed by a valid authority. Anyway,
the connection to your PRTG web server will be secured via SSL, and you can confirm the
claimed security risk. For more information on secure browser connections, please see the
More 104 section below.

Every browser shows the certificate warning in a different layout. The steps to take are similar
for every browser, yet different in detail:

§ Google Chrome 105

§ Mozilla Firefox 105

§ Internet Explorer 106

§ Other 107

Google Chrome

In Google Chrome, click on Proceed any way every time you call the web interface.

Sec urity Warning in Google Chrome Browser

Mozilla Firefox

In Mozilla Firefox, click on I Underst and t he Risks and then on the Add Except ion... button.
In the appearing window, leave the check mark for Permanent ly st ore t his except ion and
finally click on the Confirm Securit y Except ion button.

28.05.2014 105
Part 5: Ajax Web Interface—Basic Procedures | 2 SSL Certificate Warning

Sec urity Warning in Mozilla Firefox

You only have to go through this procedure once for every Firefox browser and PRTG core
server.

Internet Explorer

In Int ernet Explorer, click on Cont inue t o t his websit e (not recommended) every time you
call the web interface.

Sec urity Warning in Internet Explorer

106 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 2 SSL Certificate Warning

Other

For other browsers, the procedures to confirm the certificate will be similar to the ones
described above.

More
§ Using Your Own SSL Cert ificat e 2076

Knowledge Base: Why don't I get an SSL connection to the PRTG web interface?
§ http://kb.paessler.com/en/topic/11813

28.05.2014 107
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

5.3 General Layout


This manual section provides an overview about the structure of PRTG's web interface. The
main focus is on the Devices view which you can select via the main menu bar, because there
you see your monitoring results at a glance and, thus, you will widely use it.

Welcome Page

Once you have run through the Configurat ion Guru 36 , you will see PRTG's welcome page as
default after you log in to the web interface. You can set another homepage in your account
settings 1812 , section Web Int erface.

You have the following options on the welcome page:

§ Run Configurat ion Guru 36

§ Download Windows Client App 1885

§ Perform Net work Aut o-Discovery 190

§ Inst all Smart phone Client Apps 1950

§ Review Result s 133

§ Get Help and Support : Opens the help center where you find links to this manual, to the
Knowledge Base, and the contact Paessler support form 1889 .

PRTG Welc ome Sc reen

108 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Tree View Layout

Click on the Review Result s option on the welcome screen to display the tree-like device
view which will be a starting point for everyday use or on Devices in the main menu bar.

PRTG Dev ic e Tree

From top to bottom, the main layout consists of:

28.05.2014 109
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Screen Part Descript ion


Number

1 Global Header This element contains the main menu at the top, the global
Area 111 status bar, the path to the currently selected object, and a
quick search box.

2 Page Header Bar This element contains the page heading with the name of the
113 current object, several tabs with settings, monitoring data, etc.
of the current object, the object's status bar, quick action
buttons, and the QR code linking to the current URL.

3 Device Tree This selection is part of the page header bar. Using the
View 115 provided options you can define how your device tree is
displayed.

4 Page Content 119 This element contains information about the current object and
all other objects underneath in the tree hierarchy.

5 Page Footer With these icons you have quick access to the PRTG Auto-
Icons Update page, to PRTG's social network accounts, and to the
contact support form 1889 . There is also a link to context
sensitive help.
When running PRTG in a cluster, you will also see a cluster
related element. It shows the name of the node you are logged
in and displays whether this is a master or a failover node. Click
the bar to show the Clust er St at us 1883 . In a failover node, you
can review all data, but changes in the settings will not be
saved. In order to change settings, please log into the master
node of your cluster.

6 Page Footer Shows information about the current version of PRTG, the
logged in user, the time remaining to the next automatic page
refresh, and the current time.

Simply click on an object to see more details about it. In the page heading of the page header
bar 113 you always see which object you're looking at.

When you navigate through PRTG's web interface you will always use one of the following
navigational paths:

§ The main menu provides access to all important aspects of the software.
§ The quick search is often the fastest way to navigate to an object.
§ Using the page's tabs, you can switch between various sub-pages for an object.
§ Many objects offer a context menu that will pop up when you right-click them.
§ Many objects offer a quick-info menu that will pop up when hovering an object

110 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

§ And, finally, you are able to drill down into the object hierarchy of probes, groups, devices,
and sensors in the object tree by merely clicking an sub-object of the currently displayed
object (for example, a sensor on the device page).

These six navigation paths put PRTG's complete functionality at your fingertips. Quite likely you
are already familiar with these techniques from many other websites and web-based user
interfaces.

In the following, the different areas of the web interface are described.

Global Header Area

PRTG's Global Header Area

The header area of the web interface is both base for the most important information of your
installation and starting point for all actions. You can view the global status and navigate
through the web interface using the main menu.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

The global header area consists of the following parts:

28.05.2014 111
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Screen Part Descript ion


Number

1 Main Menu Bar Navigating through the web interface is performed using the
main menu. Please take a few minutes to familiarize yourself
with all menu items and sub-items. A detailed description can be
found in the Main Menu St ruct ure 175 section.

2 Icons Refresh, With the icons on the right you can reload the current page,
Help Center, open the help center or log the current user out.
Logout

3 White Search To search for any monitoring object, enter the name, part of
Box the name, an IP address, a DNS name or a tag in the search box
on the right and hit the enter key. A web page with all items
that fit the search term will be returned—even displaying online
help articles.

4 'Breadcrumbs' Below the main menu, there is always a path shown, leading to
the homepage. Use it to go back to where you came from. It
can also help you to orient yourself in case you get lost. If you
click on a 'breadcrumb' item to open a drop-down menu
showing all available object on the same level. Enter a view
letters to search for a name, or select an object directly. For
example, you can use this to directly access all other sensors
or a device, the other devices within a group, another group on
the same probe, or other probes in your root group.

5 Buttons New These buttons show the number of new alarms and new log
Alarms, New Log entries, as well as the number of new tickets. Click on the
Entries, New respective button to view the Alarms 144 , Logs 147 , or Ticket s
Tickets 149 .

6 Global Sensor This area shows the aggregated status of all sensors you have
Status Symbols configured for monitoring, divided into different sensor states.
Depending on the sensors' status you will see colored boxes
with numbers which symbolize the sensors. For example, you
can see how many sensors are in Up, Down, or Warning state.
Click on a box to view a list of all sensors in the respective
status. For a detailed description, please see Sensor St at es 121
section.

112 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Page Header Bar

In the page header under the global header area, you see the name of the current object and
the page content underneath. When displaying a group, aggregated sensor states are shown
in a sensor bar and there is an option to change the tree view. Furthermore, various
information about the current object is reported here.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

PRTG's Page Header Bar

The page header and tabs area consists of the following parts:

28.05.2014 113
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Screen Part Descript ion


Number

1 Page Heading This line displays the kind of the current object and the name
as page heading. In the screenshot above, it is a group which is
called Root . Here you also can add the current object to
favorites by clicking on the flag, as well as you can define the
object's priority by clicking on one of the five stars (not
available for the Root group). For details, please see section
Priorit y and Favorit es 160 .

2 Tabs Using the tabs you can navigate to various sub-pages of an


object, showing monitoring data or changing settings. For
more information, please see sections Review Sensor Dat a 124

and Change Device and Sensor Set t ings 142 .

3 Context Buttons On the right side are icons which allow you to perform several
actions. Depending on the currently viewed page within PRTG,
you can pause (and resume) or delete this object, add another
object (for example, a sensor to a device), send a link to the
current page per email, perform an immediate scan, open a
related ticket, and show the corresponding object history page
147 . By clicking on the down arrow, you can open the context

menu for the currently displayed object with even more


options. For more information, please see Cont ext Menus 163
section.

4 Object Status This element indicates the current status of the selected
object.

5 Sensor Status This element is visible when viewing a probe, a group (including
Bar Root ), or a device. It is not available when viewing a sensor's
details. The sensor status bar shows the aggregated status of
all sensors for the current object, divided into different sensor
states. They show the number of sensors in the respective
state. For example, you can see how many sensors are in Up,
Down, or Warning state. For a detailed description of sensor
states, please see Sensor St at es 121 section. You can hide
sensors that are in a certain state by removing the check mark
symbol in front of the respective sensor symbol. To show them
again, re-add the check mark.

6 Tree Search In the white search box next to the tree view selection, enter a
key word to search the device tree for matching names. The
tree will then highlight matching devices and sensors by graying
out all others. This can help to gain a quick overview over
sensors monitoring a specific part of your network. For
example, you can enter the keyword "firewall" to highlight
devices and sensors which match this name.

7 Device Tree This element is only visible when viewing a probe or a group. It
View is not available when viewing a device's or sensor's details. For
114 a detailed description, see Switch Device Tree View 115 28.05.2014
below.

8 Scanning This element shows in what time interval PRTG scans the
Interval current object.
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Switch Device Tree View

When viewing a probe or group, you can choose the way your device tree is shown.

Dev ic e Tree View Switc h


Buttons

Switch Device Tree View—Classic Device Tree

Using the different circle symbols in the page header bar, you can define how much space is
used to show devices and sensors in a hierarchical tree structure. In four steps, you can
switch from a very condensed view (small circle; marked with 1 in the screenshot) up to an
extra large view (big circle; marked with 4 in the screenshot).

In the classic device tree view you can collapse devices, groups, and probes. Click on the
minus box left to the object's name. The sensor states will be summarized then. Each status of
the sensors on this object will be displayed with the number of sensors currently being in this
status—with the exception of the states Down, Down (Part ial), and Down (Acknowledged).
These will be summarized respectively not before there are more than ten sensors in this
status, otherwise they are displayed individually.

Collapsed Dev ic e With Summarized Ups and Unusuals and Indiv idual Downs

Switch Device Tree View—Extended Views

There are two additional options to the simple tree views which enable you to display the
status of all sensors of your entire installation in a single overview. Click on one of the icons
to change the view:

Tree Map View (6)


The tree map view tiles all devices of your entire installation into one square, arranged by the
groups you put them into. Each device changes color dynamically to reflect the overall status
of the sensors on the device. You can also adjust the size of the squares: either depending on
a device's priority, or depending on the number of sensors on a device, or depending on both.
For this concern, add a check mark under the point Size by : in front of Sensors and/or
Priorit y in the page header bar (see the mark in the screenshot below).

28.05.2014 115
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

PRTG Tree Map View

Sunburst View (5)


The sunburst view shows your entire installation in one circle diagram. The groups are
represented as inner circles, and all devices contained within a group are shown as 'cake slices'
attached to the outside of a circle element.

116 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

PRTG Sunburst View

For both views:

§ Colors
A device (or group) element can have different colors, depending on the states of the
sensors running on this device or group (see Sensor St at es 121 ) 121 . A more severe status is
regarded more important and wins the color battle. For example, if a device currently has
sensors in the states Up (green), Paused (blue), and Warning (yellow), the according device
tile in this view would be yellow, indicating that at least one sensor on this device is in
Warning status. If there are any red Down sensors, the according device tile will turn red.
Following, all possible states in both views are listed ordered by their hierarchy:

28.05.2014 117
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Flag Flag Color Object St at us Meaning

Red Down At least one sensor of this object shows a red


Down status. Hover an object's name to view
the total number of alarms concerning this
object.

Bright-Red Down At least one sensor of this object is Down and


(Acknowledged) the status was acknowledged by a PRTG user,
applying the Acknowledge Alarm function. The
Down states of all sensors of this object have to
be acknowledged—if at least one sensor is
unacknowledged down, this object will be
displayed as Down.

Yellow Warning At least one sensor of this object shows a


yellow Warning status. There is no sensor in a
Down or Down (Acknowledged) status
concerning this object.

Orange Unusual At least one sensor of this object shows an


orange Unusual status. There is no sensor in a
Down, Down (Acknowledged), or Warning
status concerning this object.

Green Up All sensors of this object are in a green Up


status. There is no sensor in a Down, Down
(Acknowledged), Warning, Paused, or Unusual
status concerning this object.

Blue Paused All sensors of this object show a blue Paused


status. There is no sensor in a Down, Down
(Acknowledged), Warning, Unusual, or Up
status concerning this object.

Black (Grey) Unknown All sensors of this object have an Unknown


status. There is no sensor in a Down, Down
(Acknowledged), Warning, Unusual, Paused, or
Up status concerning this object.

§ Size by Sensors / Size by Priorit y


You can adjust the size of the different squares. They can be calculated by the number of
sensors running on a device or within a group, or by the sensors' priority (see Priorit y and
Favorit es 160 ), or both. Use the check boxes in the page header bar (see the mark in the
tree map view screenshot) to change view immediately, then use the setting that suits best
for your needs.

118 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

Page Content

The page content of the general layout varies dependent on the selected object. It shows
information about the current object and all other objects underneath in the tree hierarchy.
The deeper down in the hierarchy you select an object, the more detailed is the displayed
information.

By default, a Probe Device is created in the device tree on the local probe. It represents the
probe system running with your PRTG installation. PRTG automatically monitors the system
health of the core server and each probe in order to discover overloading situations that may
distort monitoring results. To monitor the system status of the probe computer, PRTG
automatically creates a few sensors. These include a Core/Probe Healt h Sensor, a WMI
sensor that measures disk usage, and a bandwidth sensor for all installed network cards. It is
recommended to keep these sensors, but you can optionally remove all except the Core/
Probe Healt h sensor. In a cluster installation, PRTG also creates a Clust er Probe Device with
a Clust er Probe Healt h Sensor 355 that monitors the cluster's system health.

You can add (or remove) a device or sensor to favorites by one click on the respective flag
displayed with an object (please see the marks in the screenshot below).

One-Clic k Fav orites in the Dev ie Tree

Another one-click option for adding/removing favorites or setting the priority for a selected
device or sensor is given in the page header bar 113 right to the object name (please see
screen number 1 in that subsection). Simply click on the flag for favorites or on a star for
priority.

One-Clic k Fav orite and Priority in the Page Header Bar

A black flag means that the respective object is a favorite already; clicking on the black flag will
remove the object from favorites. A gray flag indicates that it is not a favorite yet. Please see
also Priorit y and Favorit es 160 for this concern.

For more details about page contents, please see the following sections:

28.05.2014 119
Part 5: Ajax Web Interface—Basic Procedures | 3 General Layout

§ Review Monit oring Dat a 124

§ Hist oric Dat a Report s 133

§ Object Set t ings 142

§ Compare Sensors 130

§ Geo Maps 1744

More
Knowledge Base: How can I change the width of the devices and group "boxes" shown in the
PRTG 9 device tree?
§ http://kb.paessler.com/en/topic/24963

120 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 4 Sensor States

5.4 Sensor States


In PRTG's device tree you usually create several sensors on each 'device 272 '. With sensors, you
can monitor different aspects of your devices. Using a simple color code, they always show
you what is going on in your network.

The color of a sensor always shows its current status. Following, you find a list of states a
sensor can show. This list also reflects the hierarchy of states whenever summarized sensor
states are shown (in the device tree 109 , or on geo maps 1744 ) : the higher a status is in the
hierarchy, the higher will be its priority in displaying sensor states. For example, if all the
sensors of a specific device are Up, but one of its sensors reached a Down status, then the
overall status of this device will be Down as well (for example, displayed red in the Tree Map
View 115 ), as this state is hierarchically higher. Note: Down and Down (Part ial) states are
hierarchically equal.

Sensor Color St at us Name Meaning

Red Down 1. PRTG is not able to reach the device or the


sensor has reached an error state. Please
see Sensor Warning and Down Behavior 122
below for more information. Note: By design,
a sensor does not record any data in its
channels while it shows this status.
2. Another reason for this status can be an
error limit that is set in the Sensor Channels
Set t ings 1709 , or an error status due to a
sensor Lookup 2039 . Note: In this case, the
sensor continues to record data in all sensor
channels although the sensor shows an
error.

Red/Green Down (Part ial) In a cluster, at least one node reports this
sensor as Down, while at least one other node
reports the same sensor as Up.

Bright-Red Down The sensor is Down and the status was


(Acknowledged) acknowledged by a PRTG user, applying the
Acknowledge Alarm function. This can be
helpful to mark that an alarm has already been
attended to. For acknowledged alarms no
more notifications 1749 are sent. To set this
sensor status, right-click on a sensor in a Down
status and from the context menu 163 , select
Acknowledge Alarm.... Then enter a comment
and click OK.

28.05.2014 121
Part 5: Ajax Web Interface—Basic Procedures | 4 Sensor States

Sensor Color St at us Name Meaning

Yellow Warning There was an error reading the sensor, but


PRTG will try again. The sensor may soon
change to a down status. Please see Sensor
Warning and Down Behavior 122 below for
more information. Another reason for this state
can be a warning limit set in a sensor's Sensor
Channels Set t ings 1709 .

Orange Unusual The sensor reports unusual values for this


weekday and time of day. The unusual
detection is based on the historic average data
and can be configured or disabled in the system
administration 1839 . You can also disable unusual
detection for certain groups only (see Group
Set t ings 270 ).

Green Up The last check was okay and the sensor


receives data.

Blue Paused The sensor is currently paused (for a certain


time or unlimitedly, or by dependency).

Black Unknown The sensor has not been checked yet by PRTG
(Gray) or there is an error in (network) communication,
likely on the probe system. If sensors show this
status persistently, a PRTG restart may be
necessary. For extended trouble shooting
please see More 123 section below.

Sensor Warning and Down Behavior

The Down status symbolizes that something is wrong with a monitored device. There can be
various reasons for a down status, for example, an interruption in the physical connection to
the device, an internet connection outage, or a crashed server.

After a failed request, PRTG tries to reach the device again before setting a sensor to Down
status (this is true for almost all types of sensors):

1. If a request to a device fails for the first time, the sensor is set to Warning status. PRTG
repeats the request and tries to re-scan the device immediately.
2. If also the second request fails, the sensor is set to Down status until the device is
reachable again. PRTG tries to reach the device with every scanning interval.

This procedure gives devices and services the chance to recover from a momentary overload
and prevents false alarms. Still, you are informed promptly about any failures occurring.

122 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 4 Sensor States

Note: The behavior described above does not apply to a Warning or Down status that is
activated due to a warning or error limit set in the Sensor Channels Set t ings 1709 .

More
Knowledge Base: What to check if sensors are black (gray)?
§ http://kb.paessler.com/en/topic/25643

28.05.2014 123
Part 5: Ajax Web Interface—Basic Procedures | 5 Review Monitoring Data

5.5 Review Monitoring Data


Pages of probes, groups, device, and sensors have a tab-like interface. Using the tabs you can
navigate through various sub-pages of an object in order to show your network's status, view
monitoring results, or change settings.

Tabs Bar on Sensor Pages

Overview

The Overview tab shows an overview of the currently selected object and of its sensors. The
pages share a common layout, but include different elements, depending on the kind of object
you look at:

§ For probes and groups, the Overview tab shows a tree-like view with devices and sensors,
a GeoMap, as well as summary graphs for different time spans of the current probe or group.
§ For devices, the Overview tab shows device details, a GeoMap, and summary graphs for
different time spans, colored gauges for high priority sensors, as well as a table list of all
sensors on this device.
Note: In order to display gauges which represent sensor states, corresponding sensors
need to be tagged with 4 stars (****) or 5 stars (*****) in the priority settings 160 . 5 stars
sensors will be represented with bigger gauges than 4 stars sensors.
§ For sensors, the Overview tab shows sensor details, current status, a GeoMap, colored
gauges which represent the last value of particular sensor channels (the primary channel in
biggest size; not available for the Downt ime channel), sensor graphs for different time
spans, a table with all sensor channels, as well as similar sensors 138 which show correlations
in your network.

Note: For sensors using lookups 2039 , we recommend staying below 120 lookup values in the
primary channel to get expressive gauges. For sensors with a priority of 4 stars, the upper limit
is around 40 lookup values.

124 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 5 Review Monitoring Data

Dev ic e Ov erv iew Tab with Gauges for High Priority Sensors, Sensors Table List, Geo Map,
and Mini Graphs

Toplists

Toplist s are available for xFlow and Packet Sniffer sensors 291 only. Toplist graphs are
displayed right on the sensor overview page. Please see section Toplist s 1728 .

Live Data and Data By x Days

Select one of the tabs Live Dat a (available for sensors only), 2 day s, 30 day s, or 365 day s to
display an object's monitoring data live (sensors only), or for different time spans and in more
or less detail. Note: The days mentioned here are the default setting. You can change the
detail of the different graphs any time in the system administration 1835 .

28.05.2014 125
Part 5: Ajax Web Interface—Basic Procedures | 5 Review Monitoring Data

2 Day s Tab of a Firewall with Ov erv iew Graph and Sensor Mini Graphs

Live Data and Data By x Days—Probes, Groups, and Devices

For probes, groups, and devices, each of the tabs shows a summary graph for the current
object and mini graphs for all sensors on this object, as well as a data table for the current
object. There are never more than 50 mini graphs displayed for performance reasons. Hover a
mini graph to see the graph legend.

The summary graph shows the number of alarms as well as three index graphs. These graphs
indicate response time, CPU usage, and bandwidth usage for all sensors. Index graphs are
similar to a stock index. The shown values are based on the readings of all sensors of this
object. PRTG computes these values using statistics and by comparing the values to the
highest and lowest readings ever recorded.

The three index graphs shows overall (or global) trends in your network. If these values
increase during a specific time frame, then CPU load, bandwidth load, or response time
respectively have worsened during this time. For example, a CPU Load Index value of 90%
means that the average CPU load for all CPU sensors of your current configuration is at 90% of
the highest ever measured CPU usage value.

The following four channels are available in the summary graph:

126 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 5 Review Monitoring Data

§ Alarms: Sums up the number of all down states of sensors on this object during the given
time span. This graph provides you a bird's eye view of trouble in your network. It cannot be
hided.
§ Response Time Index: Indicates request times in your network.
§ CPU Load Index: Indicates the CPU usage in your network.
§ Traffic Index: Indicates the bandwidth usage in your network.

See section More 129 for a detailed description of the index graphs.

You can hide single channels individually except the "Alarms" channel. Simply remove the check
mark symbol in front of a channel name besides the graph, and the according channel's line will
disappear. You can also Show all or Hide all channels by clicking on the buttons underneath
the channel names. The graph view will be reset immediately.

Sensor Liv e Data Tab for a Traffic Sensor

28.05.2014 127
Part 5: Ajax Web Interface—Basic Procedures | 5 Review Monitoring Data

Live Data and Data By x Days—Sensors

For sensors, the tabs show a graph and data table of the selected sensor. When viewing data
of a sensor running on a cluster probe, you can additionally select if you want to show the
data of all nodes, or of one specific node only. Please use the Select Clust er Member bar
below the tabs. Note: Multi-node graphs are never displayed filled here, but with single lines
only. However, historic data reports can have filled multi-node graphs.

While viewing a sensor graph you can hide single sensor channels individually. Simply remove
the check mark symbol in front of a channel name underneath the graph, and the according
channel's line will disappear. You can also Show all or Hide all channels by clicking on the
buttons besides the channel names. The graph view will be reset immediately.

In the upper right corner of every graph, you will find three small icons. Using them, you can do
the following:

§ Zoom graph in new window: This will open a larger version of the graph in a new browser
window.
§ Download t he graph (PNG or SVG): This will show a PNG or SVG file of the graph in a new
browser window. You can then save or copy it for later use.

Historic Data

The Hist oric Dat a tab is available for sensors only. Please see section Hist oric Dat a Report s
133 .

Sensors Lists

Viewing lists of sensors is a great way to keep an eye on your network's status, as you can
select which kind of sensors you would like to see. There are many different sensor list views
available, such as a list of favorite sensors and top 10 lists; lists filtered by current sensor
status, value, availability, tag, or type; there is a sensor cross reference, and many more.

Sensor lists are available from the main menu bar. Click the Sensors entry to show a table list
of all sensors. In the table list 156 appearing, you can re-sort the items by clicking on the
column's header items. Hover to show other menu options. For detailed information about the
available options, please see Main Menu St ruct ure 178 (Sensors) section.

Alarms

The Alarms tab is not available for sensors, but for probes, groups, and devices only. Please
see section Alarms 144 .

Log

The logs tab shows past activities and events regarding the currently selected object. Please
see section Logs 147 .

128 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 5 Review Monitoring Data

Related Topics

§ Object Set t ings 142

§ Compare Sensors 130

More

Knowledge Base: How does PRTG compute CPU Index, Traffic Index and Response Time Index?
§ http://kb.paessler.com/en/topic/313

28.05.2014 129
Part 5: Ajax Web Interface—Basic Procedures | 6 Compare Sensors

5.6 Compare Sensors


This function allows you to visually compare the graphs of two or more specific objects. The
selected graphs will be shown next to each other so you can have a look at all of them at the
same time.

To open the page to compare graphs of several monitoring objects, from the main menu,
choose Sensors | Compare Sensors. Select how many sensors you want to compare.

PRTG Main Menu: Compare


Sensors

Once you have chosen the number of sensors that will be compared, an assistant will open
where you can define your desired sensors and the time span shown in the graphs.

130 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 6 Compare Sensors

Compare Graphs of Two Sensors with 30 Day s Time Span

Compare Sensors Settings

Opt ions

Time Span Specify the time span for which you want to show the graphs for.
Choose between:
§ 2 day s
§ 30 day s
§ 365 day s

Dat a Comparison

Select the objects you want to show a graph for. Click on Please click here t o edit ! to open
the Object Select or 159 . There will appear as many selection screens as you have defined
before.

14.01.2014 131
Part 5: Ajax Web Interface—Basic Procedures | 6 Compare Sensors

Selec t the Objec ts to be Compared

The graphs will be shown immediately after object selection.

Related Topics
If you want to create a sensor that combines the data of different other sensors, please see
the following sensor type:
§ Sensor Fact ory Sensor 856

132 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 7 Historic Data Reports

5.7 Historic Data Reports


For quick reporting on monitoring data, use historic data reports as an alternative to the
exhaustive reports 1775 function. You can view a report of the historic data for each single
sensor, on demand. Additionally, you can also export this data and download it to your
computer for further processing in external applications.

There are two possibilities to call the function for historic data reports: Either you click on the
Hist oric Dat a tab on a sensor's detail page, or you choose Sensors | View Hist oric Dat a
from the main menu 178 .

Historic Data (Sensor Tab)


Pages of probes, groups, device, and sensors have a tab-like interface. Using the tabs you can
navigate through various sub-pages of an object in order to show your network's status, view
monitoring results, or change settings.

Tabs Bar on Sensor Pages

The Hist oric Dat a tab is available for sensors only (not for probes, groups, or devices). When
calling the historic data reports via this tab, there is no sensor selection available, because you
have already determined which sensor you would like to create a report for.

14.01.2014 133
Part 5: Ajax Web Interface—Basic Procedures | 7 Historic Data Reports

Historic Data Tab of a Ping Sensor

Historic Monitoring Data (Sensors Menu)

When calling the historic data reports via the View Hist oric Dat a entry from the Sensors entry
in the main menu, an additional option is available, enabling you to choose the sensor you
want to create a report for.

134 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 7 Historic Data Reports

View Historic Data Func tion Called from Main Menu

Historic Monitoring Data Settings

Set t ings

Sensor This field is only visible if you called this function via the main menu.
Select the sensor you would like to create the report for: Click on
the reading-glass symbol to open the object selector. For more
information, please see section Object Select or 159 .

Start Specify the start date and time of the data you want to review. Use
the date time picker to enter the date and time.

End Specify the end date and time of the data you want to review. Use
the date time picker to enter the date and time.

Quick Range In this section several links are provided for a faster selection of
start and end date. Click on any of these links to change the St art
and End values above. Choose between:
§ 1 Day , 2 Day s, 7 Day s, or 14 Day s: Set the date range to the
respective day(s). The current time of today will be the end date.

14.01.2014 135
Part 5: Ajax Web Interface—Basic Procedures | 7 Historic Data Reports

Set t ings

§ Today , Yest erday , Last Week (Mo-Su), Last Week (Su-Sa), Last
Mont h, 2 Mont hs, 6 Mont hs, 12 Mont hs: Set the date range to
the last matching period, starting 00:00, ending 00:00 of the
particularly following day.

Average Interval With this option, you can activate and set up averaging. Select an
interval for which the average value should be calculated. You can
choose between No Int erval (no averaging will be performed and
only raw data displayed), a few seconds, minutes, hours, or a whole
day (24 Hours). A smaller interval will result in a more detailed
report for this sensor. The best settings for you vary, depending
on the scanning interval of the sensor, the selected date period
and, of course, the intended use for the report. It might be useful
to try different settings to see what the results look like. Please
also see the section Aut omat ic Averaging 137 below.

Cluster Node This field is only visible if the sensor is running on a cluster probe.
Select the cluster node's data that will be used for the report.
Choose between:
§ All nodes: Include the data of all cluster nodes in the report.
§ [Several specific nodes]: Use a specific node's data for the report.
The nodes shown are specific to your setup.

File Format Select the output format for the report. Choose between:
§ HTML web page: Display the result directly as HTML web page.
This is also a good option to check results before exporting to
another file format.
§ X ML file: Export the data as Extensible Markup Language (XML)
file. Usually, you browser will show a download dialog.
§ CSV file: Export the data as Comma Seperated Values (CSV) file,
for example, for import into Microsoft Excel. Usually, you browser
will show a download dialog.

Include Percent iles

Percentile Results Select if percentiles will be shown in the report. Choose between:
§ Off: No percentiles will be calculated.
§ On: Percentiles will be enabled in the report. In the overview
table, additional values will be displayed with averages/sums for
each sensor channel. Please define additional settings below.
For more information about percentiles, please see section
Calculat ing Percent iles 2078 .

136 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 7 Historic Data Reports

Include Percent iles

Percentile This field is only visible if percentile results are enabled above.
Enter which percentile you would like to calculate. Please enter an
integer value.

Percentile Average This field is only visible if percentile results are enabled above.
Enter the averaging interval in seconds that will be used for
percentile calculation. Please enter an integer value.

Percentile Mode This field is only visible if percentile results are enabled above.
Choose between:
§ Discret e: Chooses the next smaller discrete value.
§ Cont inuous: Interpolates between discrete values.

Click on St art to start the generation of a historic data report. Note: Data reporting is limited
to 5 requests per minute.

Automatic Averaging

For performance reasons, PRTG automatically averages monitoring data when calculating data
for large time spans. Data is then averaged regardless of the selected average interval.

Time Span in Report Minimum Level of Det ail (Average Int erval)

Up to 40 days Any

40 to 500 days 60 minutes/1 hour or larger

A report for a time span of more than 500 days is not possible. If you try to set a larger time
span, it will be reduced to 365 days automatically.

Related Topics
§ Review Monit oring Dat a 124

§ Report s 1775

14.01.2014 137
Part 5: Ajax Web Interface—Basic Procedures | 8 Similar Sensors

5.8 Similar Sensors


With PRTG you can detect relationships between different components in your network. This
function is called similar sensors analysis, a heuristic calculation showing similar behavior of
your sensors. The analysis is completely automated and sensor type agnostic. It is based on
mathematics and fuzzy logic. This feature will help you to find interconnections in your
network you were not aware of and optimizes your sensor usage by tracking redundant
monitoring of some aspects of your system.

You can adjust the depth of similar sensors analysis in Sy st em Administ rat ion—Monit oring
1840 . You can toggle on/off similarity analysis on group basis in the settings of an object

(probes, groups, devices) in the device tree.

There are two possibilities to view similar sensors:

§ Each sensor's overview page contains a similar sensors section. PRTG lists channels there
which show similarities to channels of the current sensor.
§ In addition, you can call a similar sensors overview page via Sensors | Similar Sensors
Overview from the main menu 178 .

Similar Sensors (Sensor Overview Tab)


Pages of probes, groups, device, and sensors have a tab-like interface. Using the tabs you can
navigate through various sub-pages of an object in order to show your network's status, view
monitoring results, or change settings.

Tabs Bar on Sensor Pages

On the overview tab of a sensor, PRTG lists channels which show similarities to channels of the
currently selected sensor. The table will be empty if PRTG detects no similarities regarding the
selected sensor.

Note: PRTG will only show similar sensors here when channels have at least 85% similarity.
Furthermore, the analysis saves up to 15 entries per sensor at most.

138 12.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 8 Similar Sensors

Similar Sensors Sec tion on a Sensor's Ov erv iew Tab

The similar sensors section provides the following information:

Similar Sensors

Similarity Shows a measurement of similarity between two channels in


percent.

Channel Shows a channel of the currently selected sensor.

Similar Channel Shows a channel of another sensor similar to a channel of the


currently selected sensor (the one in the "Channel" column in the
same row).

Note: The similar sensors section will not be shown when the analysis is turned off or you
have exceeded 1,000 sensor and selected the automatic analysis depth option.

12.05.2014 139
Part 5: Ajax Web Interface—Basic Procedures | 8 Similar Sensors

Similar Sensors Overview (Sensors Menu)

This page shows the results of the similar sensors analysis from the entire monitoring
database. PRTG will list all channels with similarities to another one here. On the table top, you
have several filter options to display similar sensors as you need it. Choose the object of
interest, the degree of similarity, and if you want to display back references. For more details,
see also section Working wit h Table List s 156 .

Note: PRTG will only show similar sensors here when channels have at least 85% similarity.
Furthermore, the analysis saves up to 15 entries per sensor at most.

Similar Sensors Ov erv iew

You can sort the list by clicking on the column headers. The similar sensors overview page
provides the following information:

Similar Sensors Overview

Original Channel Shows channels to which other channels are compared. Clicking
on the column header sorts the list according to the order on the
device tree in ascending or descending order.

Similarity Shows a measurement of similarity between two channels in


percent. Clicking on the column header sorts the list according to
the similarities in ascending or descending order.

140 12.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 8 Similar Sensors

Similar Sensors Overview

Similar Channel Shows a channel compared to the original channel. Clicking on the
column header sorts the list according to the order on the device
tree in ascending or descending order.

Item Count Define how many channel similarities are shown on this page.
Choose between 50, 100, or 500.

Note: The similar sensors overview option will not be shown in the main menu when the
analysis is turned off or you have exceeded 1,000 sensor and selected the automatic analysis
depth option.

12.05.2014 141
Part 5: Ajax Web Interface—Basic Procedures | 9 Object Settings

5.9 Object Settings


Pages of probes, groups, device, and sensors have a tab-like interface. Using the tabs you can
navigate through various sub-pages of an object in order to show your network's status, view
monitoring results, or change settings.

Tabs Bar on Sensor Pages

Device Tree Management

The Management tab is available when viewing probes or groups. After clicking this tab you
can move devices and sensors right within the tree view. If moving is not possible, the web
interface will start a clone process automatically.

For more information, please see Manage Device Tree 222 section.

General Settings

In the Set t ings tab you can define all settings of the current object. The available options vary,
depending on the kind of object you're changing. Please see the following sections for
information about the respective object types:

§ Root Group Set t ings 224

§ Probe Set t ings 238

§ Group Set t ings 253

§ Device Set t ings 272

§ Sensor Set t ings 290

Note: The available setting options are different for each sensor, but always the same for
probes, groups, and devices. Sensor Channels Set t ings 1709 are not reachable via tab but
directly on a sensor's overview page via channel gauges and the channels table.

Notifications Settings

In the Not ificat ions tab, notification triggers can be set for every object. When using these
settings for a probe, group, or device, they will be inherited to all sensors on these objects.
Available notification trigger options are the same for all objects.

For more information, please see Sensor Not ificat ions Set t ings 1716 section.

Comments

In the Comment s tab you can enter free text for each object. This can be used for
documentation purposes or to leave information for other users.

142 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 9 Object Settings

History

In the Hist ory tab all changes in the settings of an object are logged with a timestamp, the
PRTG user which conducted the change, and a message. The history log keeps the last 100
entries.

Note: On some pages, you can access the history of subordinate objects via the according
context button in the page header bar 113 . This includes Sy st em Administ rat ion 1831 and the
overview pages of User Account s 1856 , User Groups 1861 , Report s 1775 , Libraries 1759 , and Maps
1794 . See section Logs (Main Menu) 147 for details.

Related Topics
§ General Lay out 108

§ Review Monit oring Dat a 124

§ Toplist s 1728

28.05.2014 143
Part 5: Ajax Web Interface—Basic Procedures | 10 Alarms

5.10 Alarms
The Alarm list shows all sensors that are currently in a Down, Down (Part ial), Down
(Acknowledged), Warning, or Unusual status. Sensors in other states (for example, Up,
Paused, or Unknown) do not appear here. This is useful to keep track of all irregularities in
your network.

In the table list, you can re-sort the items by clicking on the column's header items.

Alarms List

There are two possibilities to call the alarms list: Either you click on the Alarms tab on the
detail page of a probe, group, or device (not available for sensors), or you choose the Alarms
entry in the main menu.

Alarms (Object Tab)


Pages of probes, groups, device, and sensors have a tab-like interface. Using the tabs you can
navigate through various sub-pages of an object in order to show your network's status, view
monitoring results, or change settings.

Tabs Bar on Group and Probe Lev el

On an object's detail view, click on the Alarms tab to show a table list of all sensors on this
object that currently show a Down, Down (Part ial), Warning, or Unusual status. You will see a
subset of sensors in an alarm state for the current object only. This is a subset of the entries
available via the Alarms | All option in main menu 181 . The tab is not available on a sensor's
detail page.

144 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 10 Alarms

Alarms (Main Menu)

Click the Alarms entry from the main menu 181 to show a table list of all sensors in your
configuration that currently show a Down, Down (Part ial), Down (Acknowledged), Warning,
or Unusual status. You can also show these sensors as gauges. Hover the Alarms entry and
select another option to only show a subset of sensors in certain states. Choose between:

§ All
Shows a list of all sensors which currently show a Down, Down (Part ial), Down
(Acknowledged), Warning, or Unusual status.
§ Show as Gauges
Shows the gauges of all sensors which currently show a Down, Down (Part ial), Down
(Acknowledged), Warning, or Unusual status. The size of the sensor gauges corresponds
to their respective priority.
§ Errors Only
Shows a list of all sensors which currently show a Down, Down (Part ial), or Down
(Acknowledged) status.
§ Warnings Only
Shows a list of all sensors which currently show a Warning status.
§ Unusuals Only
Shows a list of all sensors which currently show an Unusual status.

Acknowledge Alarm

An acknowledged alarm will show up in the alarms list as "acknowledged" (see Sensor St at es
121 ) and will not trigger 1716 any more notifications 1749 . Note: If the alarm condition clears, the

sensor will usually return into an Up status immediately with the next sensor scan.

In order to acknowledge an alarm, right-click on a sensor and choose Acknowledge Alarm...


from the context menu, enter a message and click the OK button. The message will appear in
the sensor's last message value. You can choose between: Acknowledge Indefinit ely ...,
acknowledge For 5 Minut es..., For 15 Minut es..., For 1 Hour..., For 3 Hours..., For 1 Day ...,
or Unt il....

If you choose Unt il... a popup window will appear:

Acknowledge Alarm unt il

Selected Objects Shows the sensor(s) for which you want to acknowledge the
alarm. You can acknowledge alarms for more than one sensor
using multi-edit 1736 .

Message Enter a text, for example, the reason why you acknowledge the
alarm.

28.05.2014 145
Part 5: Ajax Web Interface—Basic Procedures | 10 Alarms

Acknowledge Alarm unt il

Until Enter the date when the acknowledge status will end. Use the date
time picker to enter the date and time. Note: If the alarm condition
still persists after the specified date, the sensor will show a Down
status again.

Only users 1856 with write access rights may acknowledge alarms. Read-only users can be given
the right to acknowledge alarms, too. See section User Account s Set t ings 1856 , section
Account Cont rol.

More
Knowledge Base: Which audible notifications are available in PRTG? Can I change the default
sound?
§ http://kb.paessler.com/en/topic/26303

146 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 11 Logs

5.11 Logs
The Logs list shows all past activities and events of your PRTG monitoring setup. This is useful
to keep track of all important activities and, for example, to check whether messages were
sent, etc. In a typical setup, a huge amount of data is produced here. As the activity of every
single object is minuted, you can use this data to check exactly if your setup works as
expected.

To support you when viewing the log files, there are several filters available. Please see
Working wit h Table List s 156 section for more information.

List with Log Entries

There are two possibilities to call the logs list: Either you click on the Log tab on the detail
page of a probe, group, device, or sensor, or you choose the Logs entry in the main menu.

Log (Object Tab)


Pages of probes, groups, device, and sensors have a tab-like interface. Using the tabs you can
navigate through various sub-pages of an object in order to show your network's status, view
monitoring results, or change settings.

Tabs Bar on Group and Probe Lev el

On an object's detail view, click on the Log tab to show a table list with all log information on
this object. This is a more detailed log than the system log available via the Logs | All option in
main menu 183 .

Logs (Main Menu)

Click the Logs entry from the main menu 183 to show a table list of all system log entries in
your configuration. Hover the Logs entry and select another option to only show a subset of
entries for certain objects for certain kind of entries. Choose between:

§ All
Show log information for all objects in your configuration, newest first.

14.01.2014 147
Part 5: Ajax Web Interface—Basic Procedures | 11 Logs

§ By Group ›
Show log information for objects in a certain group only, newest first. Hover to show other
menu items. Select All, or follow the menu path (it is specific to your setup) to select a
group you would like to show log information for.
§ St at us Changes ›
Show log information for certain status changes only. Hover to show other menu items.
Follow the menu path to view log entries with a special value in the St at us field only. Select
between Up & Down (shows entries with either Up or Down in the St at us field), Down,
Warning, Unusual, Up, Paused/Resumed (shows entries with either Paused or Resumed in
the St at us field), or Acknowledged Alarms.
§ Sy st em Event s ›
Show log information regarding certain system event types only. Hover to show other menu
items. Select between the following event types: Probe Relat ed, Clust er Relat ed, Aut o-
Discovery , Not ificat ions, or St at us Messages.
§ Object Hist ory
Shows information about changes to the PRTG setup and lists deletions of subordinate
system objects. The object history page has a tab-like interface. Using the tabs you can
navigate through various sub-pages in order to view the changes to all related settings and
deletions of objects. Select between the following tabs: My Account , Sy st em Set up,
Not ificat ions, Schedules, User Account s, User Groups, Report s, Libraries, or Maps.
Note: You can open a specific tab directly with the context button Hist ory in the page
header bar 113 on the corresponding pages.

148 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 12 Tickets

5.12 Tickets
PRTG Network Monitor includes its own ticket system. With tickets you can manage and
maintain various issues which may appear while monitoring a network. A ticket in PRTG
contains information about recent events in your PRTG installation which need a closer look by
the administrator or another responsible person. You can see each ticket as a task for a
particular PRTG user.

Each monitoring related task has a lifecycle in the ticket system. PRTG itself can create tickets,
for example, when Aut o-Discovery 190 has finished, as well as PRTG users can create tickets
for every kind of issue. In addition, you can set up notifications which open a ticket when
something uncommon occurs in your network. The task gets alive when a ticket is created.
Responsible PRTG users then take care of this issue. Once the issue has been resolved, the
ticket can be closed and the lifecycle of the task ends.

Every ticket has a unique ID, a priority, and a status, and you can take several actions on each
ticket. You should view every ticket and conduct a corresponding action. This way, you always
keep an overview about each task and its history in your PRTG installation.

PRTG can also send an email to you whenever there is a ticket assigned to you or one of your
tickets has been changed. See section Ticket s as Emails 153 for details and how to turn off
emails about tickets.

List of Tic kets

28.05.2014 149
Part 5: Ajax Web Interface—Basic Procedures | 12 Tickets

Note: You can turn off the tickets system for particular user groups in Sy st em Administ rat ion
—User Groups 1861 except for the PRTG Administrators group. The users in the admin group will
not receive new ToDo tickets (and notifications about changes) by default but only the PRTG
System Administrator user. You cannot change this behavior. However, you can turn off ticket
emails 153 for every user account.

Types of Tickets

New tickets are created in the following cases:

§ New devices or sensors have been created by the auto-discovery process. Note: In the
corresponding ticket, only device templates will be listed through which PRTG created
sensors.
§ A new probe connects to the core and must be acknowledged.
§ A new cluster node connects to the cluster and must be acknowledged.
§ A new version of the software is available.
§ A new report is ready for review.
§ In a few other situations, such as when the system runs out of disk space, for licensing
issues, when an error occurred, etc.
§ A notification 1749 opened a ticket if set in the notification settings.
§ A user opened a ticket.

Overall, there are three types of tickets:

§ User Ticket s: Tickets created by PRTG users, for example, to assign monitoring related tasks
to a particular PRTG user (or user group)
§ ToDo Ticket s: Tickets created by PRTG to show important system information and in case of
specific system events. They are assigned to the PRTG System Administrator user and cannot
be turned off.
Note: The Relat ed Object of ToDo tickets is Sy st em.
§ Not ificat ion Ticket s: Tickets created via Not ificat ions 1749 in case of monitoring alerts

States of Tickets

Tickets can have three different states depending on the working process regarding the
corresponding issue:

§ Open: New tickets will be open as long as the corresponding issue exists as described in
the ticket.
§ Resolved: The issue as described in the ticket does not persist any longer. Someone took
care of it.
§ Closed: Usually, the ticket has been resolved before, the solution to the issue has been
checked for correctness, and the ticket does not require any other action.

150 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 12 Tickets

Tickets (Main Menu)

Note: This option is only shown in the main menu bar if the user group of the current user is
allowed to use the ticket system. You can turn off tickets for particular user groups in Sy st em
Administ rat ion—User Groups 1861 . Users with read-only rights are always excluded from the
ticket system and cannot see the tickets entry in the main menu bar.

You have several options to display a list of tickets which is filtered to your needs. In the main
menu bar 175 , hover on Ticket s to show all available filter options or click directly to show all
tickets assigned to the current user. You can also create a new ticket via the main menu.
Available options are:

§ My Ticket s
Click to show all open tickets which are assigned to the current user. Hover to show other
menu items for filtering these tickets depending on their status:
§ Open
§ Resolved
§ Closed
§ All

§ All Ticket s
Click to show all open tickets of all PRTG users. Hover to show other menu items for filtering
these tickets depending on their status:
§ Open
§ Resolved
§ Closed
§ All

§ ToDo Ticket s
Click to show all open tickets from the type 150 ToDo. Hover to show other menu items for
filtering these tickets depending on their status:
§ Open
Click to show all open ToDo tickets. Hover to show other menu items for filtering these
tickets depending on their event type:
§ Report Relat ed
§ Aut o-Discovery Relat ed
§ Probe Relat ed
§ Sy st em Errors
§ New Soft ware Version
§ Resolved
§ Closed

28.05.2014 151
Part 5: Ajax Web Interface—Basic Procedures | 12 Tickets

§ All

§ Open Ticket
This will open the New Ticket dialog. In the first step, select the object on which you want
to focus in the ticket via the Object Select or 159 . Click on Cont inue. Note: You can leave
this step out when using the context menu 163 of this object in the device tree to open the
ticket.

In step 2, provide the following information and confirm by clicking on Save to create a User
Ticket:
§ Subject : Enter a meaningful title for the ticket which indicates the topic of the issue.
§ Assigned t o: Select a user (or user group) who will be responsible for this issue from the
drop down list.
§ Priorit y : Define a priority 160 from one to five stars.
§ Comment s: Enter a text message. This message should describe the issue in detail.

After selecting the desired filter or opening a new user ticket, a corresponding list of tickets
will appear. In this table list, you can re-sort the items by using the respective options 156 .
Additionally, you have several search options using the inline filter directly above the table. The
following filters are available:

§ Ticket st at us: all, open, resolved, closed


§ Ticket t y pe: User, ToDo, Notification
§ Concerned user(s): Show only tickets which are assigned to a specific user or user group.
There are the following types:
· any one: no user filter is applied so all tickets on this PRTG server are shown
· me: show tickets which are assigned to you (the user who is currently logged in)
· Groups: show tickets which are assigned to a specific user group only

· Users: show tickets which are assigned to a specific user only


· Disallowed: users or user groups which do not have access rights to the selected object
are displayed under Disallowed. This for your information only; you cannot select them!
§ Relat ionship to a monitoring object: Choose groups, probes, devices, sensors with the
Object Select or 159 .
Note: ToDo tickets are related to Sy st em.
§ Time span to view tickets by last edit of a ticket: Use the date time picker to enter the date
and time.

Click on the subject of a ticket to open the ticket's detail page. There you can find all related
information, as well as you can conduct several actions.

152 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 12 Tickets

An Open ToDo Tic ket with Instruc tions

Actions

For best experience with PRTG, check every ticket and select appropriate actions. Note: Only
members of user groups which have the corresponding access rights 94 can view and edit to
tickets which are related to a certain monitoring object.

The following actions are available when viewing the tickets list or a specific ticket:

§ Edit : Opens a dialog where you can change the subject and the priority of the ticket, as well
as you can assign the ticket to another user. Furthermore, you can add a text message to
this ticket. Confirm your changes by clicking on Save.
§ Assign: Opens a dialog in which you can give the ticket to another user. Select a user (or
user group) via the drop down menu. Furthermore, you can add a text message to this
ticket. Confirm your assignment by clicking on Save.
§ Resolve: Opens a dialog where you can resolve the ticket by clicking on Save. The status
resolved indicates that the issue as described in this ticket does not persist. Furthermore,
you can add a text message to this ticket which indicates, for example, what has been done
concerning the issue.
§ Close: Opens a dialog where you can close the ticket by clicking on Save. Usually, this ticket
has been resolved before and the correct solution of the issue has been checked.
Furthermore, you can add a text message to this ticket.
§ Reopen: Opens a dialog where you can reopen a ticket after it has been resolved or closed.
Do so, for example, if the solution of the issue turned out to be incorrect. Furthermore, you
can add a text message to this ticket which indicates, for example, why you have opened
the ticket again. Confirm reopening and assignment by clicking on Save.

Tickets as Emails

You can receive all tickets which are assigned to you or to your user group as emails. You will
be also notified each time this ticket is edited via email. This way, you will keep always
informed about new notifications (if set), important system information (if PRTG System
Administrator), or within the communication with other PRTG users. You can turn off the
setting Ticket s as Emails in Sy st em Administ rat ion—User Account s 1856 . If you disable
emails for tickets for a user account, this particular user will not receive any ticket emails
anymore.

28.05.2014 153
Part 5: Ajax Web Interface—Basic Procedures | 12 Tickets

Note: If you have defined to get tickets as emails and you are PRTG System Administrator, you
will receive emails for ToDo tickets as well, although ToDo tickets are considered to be
opened by the PRTG System Administrator.

More
Paessler Blog: A New Feature Was Assigned to You in PRTG: Ticket System Keeps Track of
Network Monitoring Issues
§ http://www.paessler.com/blog/2014/02/03/prtg/ticket-system-keeps-track-of-network-
monitoring-issues

154 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 12 Tickets

Ajax Web Interface—Basic Procedures—Topics


§ Login 102

§ SSL Cert ificat e Warning 105

§ General Lay out 108

§ Sensor St at es 121

§ Review Monit oring Dat a 124

§ Compare Sensors 130

§ Hist oric Dat a Report s 133

§ Similar Sensors 138

§ Object Set t ings 142

§ Alarms 144

§ Logs 147

§ Ticket s 149

§ Working wit h Table List s 156

§ Object Select or 159

§ Priorit y and Favorit es 160

§ Pause 162

§ Cont ext Menus 163

§ Hover Popup 174

§ Main Menu St ruct ure 175

Other Ajax Web Interface Sections


§ Ajax Web Int erface—Device and Sensor Set up 188

§ Ajax Web Int erface—Advanced Procedures 1726

Related Topics
§ Ent erprise Console 1894

§ Ot her User Int erfaces 1946

28.05.2014 155
Part 5: Ajax Web Interface—Basic Procedures | 13 Working with Table Lists

5.13 Working with Table Lists


Throughout the web interface often you will see table lists of items, for example, sensor or
device lists. Table lists are also available in the Overview tab of Libraries 1759 , Maps 1794 ,
Report s 1775 , Not ificat ions 1749 , and Schedules 1827 , as well as in Logs 147 and Ticket s 149 . All
these provide common functionality.

On certain overview pages, such as for sensors 178 , tickets 151 , and similar sensors 140 , there is
also an inline filter available directly above the table. The filter options depend on the current
page.

Example of a Table List

156 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 13 Working with Table Lists

Feat ur Display What it does


e

Paging The content of a table is


displayed on several
pages. Click on the
arrow symbols at the
beginning or the end of a
list to view other pages,
or to jump to the
beginning or the end of
the list.

New Click on the window


Windo symbol at the beginning
w or the end of a list to
open the table in a new
window.

Date Use the date time picker


Range to show table list entries
within a specific time
span only. Click on the
first date field for the
start date and on the
second field for the end
date. A calender will
open where you can
particularly select date
and time. Click on the
Done button to apply
the selected date and
time.

Select When viewing log lists


Range (not available in other
lists), hover the Select
Range option at the
upper right corner of the
list to select the time
span you want to show
log entries for. Choose
between Today ,
Yest erday , and several
other time spans.
Choose Unlimit ed to
disable this filter again.

Items Hover the It ems option


at the beginning or end
of the list to select how
many rows are shown on
each page. Choose
between 50, 100, 500,
and 1000.
28.05.2014 157

Sorting Click on the column


headers to sort lists by
Part 5: Ajax Web Interface—Basic Procedures | 13 Working with Table Lists

Related Topics

§ Mult i-Edit List s 1736

158 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 14 Object Selector

5.14 Object Selector


For some functions, the object selector is shown. It enables you to browse all objects in your
configuration and select an object in two steps.

Objec t Selec tor

Step 1: Navigate Device Tree

On the left hand side, you see a device tree specific to your setup that you can browse by
clicking on the corresponding nodes. Click on a device to view its sensors on the right hand
side.

You can directly browse for objects in the device tree by entering a probe name, group name,
or device name into the Search... field above the device tree navigation. You can also use a
substring only. The resulting objects will be displayed immediately without any manual
confirmation.

Step 2: Select an Object

If you have selected a device on the left hand side, you will see the sensors on this device
here, on the right hand side. Also, the sensor type is shown. Hover a sensor on the right side
to view its parent device and group.

You can also directly search and find sensors by entering its sensor name, group name, device
name, or tag into the Find... box above the sensor list.

Select an object and click on the Save button.

14.01.2014 159
Part 5: Ajax Web Interface—Basic Procedures | 15 Priority and Favorites

5.15 Priority and Favorites


You can set priorities for all objects in your setup as well as categorize devices or sensors as
favorites. Both settings affect how your objects will be displayed. Note: Settings for priority
and favorites are stored for the entire installation; they are not user specific.

Priority for All Objects

The priority setting will affect in which order your objects will be displayed when viewing table
lists. Objects with a higher priority are listed first, others underneath, depending on their own
priority.

To change priority settings, right-click an object to open the context menu 163 and select
Priorit y . You can choose between 5 stars ***** (top priority) and one star * (lowest priority).
By default, all objects are set to medium priority (3 stars ***). In the page header bar and in
lists, you can set a priority directly by one click on a star, for example, for sensors on a device
overview page.

Context Menu: Priority

Favorites for Devices and Sensors

To call a list of all your favorite devices or sensors, select Devices | Favorit e Devices or
Sensors | Favorit e Sensors from the main menu. These lists are sorted by priority as well.

You can mark any device or sensor as favorite to add it to the favorite list. Right click on it to
open the context menu 163 . Select Priorit y /Favorit e | Add t o Favorit es. A small black flag
symbol will be added next to the object's name.

Context Menu:
Priority /Fav orites (Add)

To remove an object from the favorites list, select Priorit y /Favorit e | Remove from
Favorit es from the context menu 163 .

160 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 15 Priority and Favorites

Context Menu:
Priority /Fav orites (Remov e)

There is also the option to add a device or sensor to favorites by one click in the device tree.
Just click on the small flag symbol right to the respective object name for this concern. If the
flag is black, the specific object is already a favorite; clicking anew on the flag will remove it
from favorites and the flag will turn gray again.

One-Clic k Adding to Fav orites in the Dev ic e Tree

Priority and Favorites in the Page Header Bar

You can add any device or sensor to favorites on its respective details page by clicking on the
small flag symbol in the page header bar 113 . If the flag is black, the selected object is already a
favorite; clicking anew on the flag will remove it from favorites and the flag will turn gray again.
It is also possible to set the priority of the object by a click on one of the five stars in the page
header; five stars ***** means top priority, one star * is the lowest priority.

One-Clic k Fav orite and Priority in the Page Header Bar

14.01.2014 161
Part 5: Ajax Web Interface—Basic Procedures | 16 Pause

5.16 Pause
While a sensor is paused, it will not collect any monitoring data, will not change its status 121 ,
and will not trigger any notifications 92 . You can pause monitoring for every object by
selecting Pause from the context menu 163 of a probe, a group, a device, or a sensor. All
sensors on this object will then be paused. You can choose Pause Indefinit ely , or select a
time after which monitoring will be resumed automatically, such as 5 or 15 minut es, 1 or 3
hours, 1 day , or Unt il a certain date. You can also set up a one-time maintenance window to
pause sensors automatically at a specified time.

Note: When selecting the Pause symbol from an object's hover popup 174 or while using multi-
edit 1736 , the object(s) will be paused indefinitely until resumed.

When selecting a pause option, you are prompted to enter a message. This will be shown in
the status message of the object as long as it is paused. Confirm with OK to pause the object;
click Cancel to not pause it.

PRTG Pause Message Prompt

Note: Monitoring for objects can also be paused by applying a schedule (see Account
Set t ings—Schedules 1827 ) in the Object Set t ings 142 .

Inheritance and Resume

If you pause monitoring for an object in the device tree 108 , all child objects underneath will be
paused as well. For example, when pausing a group, all sensors on all devices in it will also be
paused. Once an object is paused, you can resume monitoring any time by selecting Resume
from the context menu 163 . However, you cannot resume monitoring for single child objects
that are paused by a parent object, but only for the object you originally set to pause. Note:
Also after a restart of PRTG, a pause status will be kept.

162 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

5.17 Context Menus


Right-click on an object to view a context menu with many options for direct access to
monitoring data and functions. You can also access many of the functionalities via the main
menu 175 or the hover popup 174 window. However, using the context menus is the easier way
in most cases.

Note: In order to view your browser's context menu, hold down the Ctrl key (Chrome) or the
Shift key (Firefox) while right-clicking. You will then see your browser's instead of the PRTG
menu. This is not possible with Internet Explorer.

The content of the PRTG context menu varies, depending on the type of object you have
selected. Please see the following sub sections for an overview of the available options.

§ Probe Cont ext Menu 163

§ Group Cont ext Menu 166

§ Device Cont ext Menu 168

§ Sensor Cont ext Menu 171

Probe Context Menu

Probe Context Menu

§ Check Now
This will perform an immediate scan for the selected probe. The data for all devices and
sensors in the object hierarchy 83 underneath will be queried.

28.05.2014 163
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ Det ails...
This will show the details of the selected probe, such as its status, the groups on the
selected probe, and an overview about the sensor states on the selected probe.
§ Edit ›
The edit menu will appear.

Context Menu Edit

§ Edit › Set t ings...


This will open the Probe Set t ings 238 tab.
§ Edit › Not ificat ions...
This will open the Not ificat ions 1749 tab.
§ Edit › Access Right s...
This will open a popup to edit access rights 94 .
§ Edit › Rename...
This will open a popup to edit the name of the selected probe.
§ Edit › Management ...
This will open the management 222 tab.
§ Add Group...
This will open an assistant which guides you through the process of adding a new group to
the selected probe. For detailed instructions, please see Add a Group 205 .

§ Add Aut o-Discovery Group...


This will open an assistant which guides you through the process of adding a new auto-
discovery group to your setup. PRTG will create a new group and run an auto-discovery in
your network in order to add devices and sensors for these devices automatically. For more
information, please see section Using t he Aut o-Discovery 190 .

§ Add Device...
This will open an assistant which guides you through adding a new device to the selected
probe. For detailed instructions, please see Add a Device 211 .
§ Sort Alphabet ically
This will sort direct children (groups and devices) of the selected probe in alphabetical order.
The ordering will be stored in the monitoring configuration and cannot be revoked.
§ Delet e...
This will delete the selected probe. You will be asked for confirmation before anything is
actually deleted.
§ Move ›
The move menu will appear.

164 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

Context Menu Mov e

§ This will move the selected probe. Choose between


§ Move › Top: This will move the probe to the top of the mother node (here the root
group).
§ Move › Up: This will move the probe one entry up under the root group.
§ Move › Down: This will move the probe one entry down under the root group.
§ Move › Bot t om: This will move the probe to the bottom of the root group.
§ Move › Management ...: This will open the management 222 tab.
§ Pause ›
The pause menu will appear.

Context Menu Pause

§ If the probe is already in a paused state, Resume will appear in the context menu instead
of Pause ›.

Context Menu Paused

§ You can pause and resume monitoring on the selected probe. The monitoring for all
sensors in the object hierarchy 83 underneath will be paused resp. resumed. You can
choose between: Pause Indefinit ely ..., pause For 5 Minut es..., For 15 Minut es..., For 1
Hour..., For 3 Hours..., For 1 Day ..., or Pause Unt il.... If you choose Pause Unt il... a
popup window will appear where you can define a date. Monitoring will be resumed after
this date.
§ You can directly add a One-t ime maint enance window to pause monitoring during a
planned downtime. In the appearing window, use the date time picker to enter the start
date and time of the maintenance window, as well as the end time, for the selected object.

28.05.2014 165
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ Priorit y ›
The priority menu will appear.

Context Menu Priority

§ Define the priority of the selected probe. For details, please see Priorit y and Favorit es
160 .

§ Hist oric Dat a ›


The historic data menu will appear.

Context Menu Historic


Data

§ Depending on what time interval you choose, Last 2 day s..., Last 30 day s..., or Last 365
day s..., the Hist oric Dat a Report s 133 tab for the specified interval will be opened.
§ Hist oric Dat a › Creat e Report ... will open an assistant to add a report. For details, please
see Report s St ep by St ep 1778 .
§ Send Link by email
You can send the link to the selected probe by email. This will open a new email using your
system's standard email client. It will contain a direct link to the selected probe's details
page.
§ Open Ticket
This will open the New Ticket dialog. For details, see section Ticket s 152 .

Group Context Menu

Note: The context menu of the Root group is special and differs from the other groups' menu.

§ Check Now
This will perform an immediate scan for the selected group. The data for all devices and
sensors in the object hierarchy 83 underneath will be queried.
§ Det ails...
This will show the details of the selected group, such as its status, the devices on the
selected group, and an overview about the sensor states on the selected group.

§ Edit ›
The edit menu will appear.

166 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ Set t ings...
This will open the Group Set t ings 253 tab.
§ Not ificat ions...
This will open the Not ificat ions 1749 tab.
§ Access Right s...
This will open a popup to edit access rights 94 .
§ Rename...
This will open a popup to edit the name of the selected group.
§ Management ...
This will open the management 222 tab.
§ Add Group...
This will open an assistant which guides you through the process of adding a new group to
the selected group. For detailed instructions, please see Add a Group 205 .

§ Add Aut o-Discovery Group...


This will open an assistant which guides you through the process of adding a new auto-
discovery group to your setup. PRTG will create a new group and run an auto-discovery in
your network in order to add devices and sensors for these devices automatically. For more
information, please see section Using t he Aut o-Discovery 190 .

§ Add Device...
This will open an assistant which guides you through adding a new device to the selected
group. For detailed instructions, please see Add a Device 211 .
§ Run Aut o-Discovery
If you select this option, an automatic search is started, adding new sensors to the selected
group. The search is running in the background. If found, you will see new sensors after a
few minutes automatically. For more information, please see Aut o-Discovery 191 (Run Aut o-
Discovery Now).
§ Sort Alphabet ically
This will sort direct children (devices and other groups) of the selected group in alphabetical
order. The ordering will be stored in the monitoring configuration and cannot be revoked.
§ Delet e...
This will delete the selected group. You will be asked for confirmation before anything is
actually deleted.
§ Clone
This will open an assistant which guides you through cloning the selected group. For
detailed instructions, please see Clone Object 1734 .
§ Move ›
The move menu will appear.
§ This will move the selected group. Choose between:
§ Move › Top: This will move the group to the top of the mother node (here usually a
probe or another group).
§ Move › Up: This will move the group one entry up under the mother node.
§ Move › Down: This will move the group one entry down under the mother node.
§ Move › Bot t om: This will move the group to the bottom of the mother node.

28.05.2014 167
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ Move › To Ot her Group: This will move the group to another group. An assistant
will appear in this case with information about the selected group and the sub-
objects which also will be moved. Please choose a target group from the list.
§ Move › Management ...: This will open the management 222 tab.

§ Pause ›
The pause menu will appear.

· If the group is already in a paused state, Resume will appear in the context menu instead
of Pause ›.

· You can pause and resume monitoring on the selected group. The monitoring for all
sensors in the object hierarchy 83 underneath will be paused resp. resumed. You can
choose between: Pause Indefinit ely ..., pause For 5 Minut es..., For 15 Minut es..., For 1
Hour..., For 3 Hours..., For 1 Day ..., or Pause Unt il.... If you choose Pause Unt il... a
popup window will appear where you can define a date. Monitoring will be resumed after
this date.

· You can directly add a One-t ime maint enance window to pause monitoring during a
planned downtime. In the appearing window, use the date time picker to enter the start
date and time of the maintenance window, as well as the end time, for the selected object.

§ Priorit y ›
The priority menu will appear. Define the priority of the selected group. For details, please
see Priorit y and Favorit es 160 .

§ Hist oric Dat a ›


The historic data menu will appear.
· Depending on what time interval you choose, Last 2 day s..., Last 30 day s..., or Last 365
day s..., the Hist oric Dat a Report s 133 tab for the specified interval will be opened.
· Hist oric Dat a › Creat e Report ... will open an assistant to add a report. For details, please
see Report s St ep by St ep 1778 .
§ Send Link by email
You can send the link to the selected group by email. This will open a new email using your
system's standard email client. It will contain a direct link to the selected probe's details
page.
§ Open Ticket
This will open the New Ticket dialog. For details, see section Ticket s 152 .

Device Context Menu


§ Check Now
This will perform an immediate scan for the selected device. The data for all sensors in the
object hierarchy 83 underneath will be queried.
§ Det ails...
This will show the details of the selected device, such as its status and the sensor states on
the selected device.
§ Edit ›
The edit menu will appear.

168 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ Set t ings...
This will open the Device Set t ings 272 tab.
§ Not ificat ions...
This will open the Not ificat ions 1749 tab.
§ Access Right s...
This will open a popup to edit access rights 94 .
§ Rename...
This will open a popup to edit the name of the selected device.

§ Add Sensor...
This will open an assistant which guides you through adding a new sensor to the selected
device. For detailed instructions, please see Add a Sensor 220 .

§ Run Aut o-Discovery


If you select this option, an automatic search is started, adding new sensors to the selected
device. The search is running in the background. If found, you will see new sensors after a
few minutes automatically. For more information, please see Aut o-Discovery 191 (Run Aut o-
Discovery Now).

§ Creat e Device Templat e...


This will open an assistant which guides you through creating a new device template; this will
then be available in auto-discovery 190 . For detailed instructions, please see Creat e Device
Templat e 1741 .

§ Sort Alphabet ically


This will sort direct children (sensors) of the selected device in alphabetical order. The
ordering will be stored in the monitoring configuration and cannot be revoked.
§ Delet e...
This will delete the selected device. You will be asked for confirmation before anything is
actually deleted.
§ Clone
This will open an assistant which guides you through cloning the selected device. For
detailed instructions, please see Clone Object 1734 .
§ Move ›
The move menu will appear. This will move the selected device. Choose between:
§ Move › Top: This will move the device to the top of the mother node (here usually a
group or a probe).
§ Move › Up: This will move the device one entry up under the mother node.
§ Move › Down: This will move the device one entry down under the mother node.
§ Move › Bot t om: This will move the device to the bottom of the mother node.
§ Move › To Ot her Group: This will move the device to another group. An assistant
will appear in this case with information about the selected device and the sub-
objects which also will be moved. Please choose a target group from the list.
§ Pause ›
The pause menu will appear. If the device is already in a paused state, Resume will appear in
the context menu instead of Pause ›.

28.05.2014 169
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ You can pause and resume monitoring on the selected device. The monitoring for all
sensors in the object hierarchy 83 underneath will be paused resp. resumed. You can
choose between: Pause Indefinit ely ..., pause For 5 Minut es..., For 15 Minut es..., For 1
Hour..., For 3 Hours..., For 1 Day ..., or Pause Unt il.... If you choose Pause Unt il... a
popup window will appear where you can define a date. Monitoring will be resumed after
this date.

§ You can directly add a One-t ime maint enance window to pause monitoring during a
planned downtime. In the appearing window, use the date time picker to enter the start date
and time of the maintenance window, as well as the end time, for the selected object.

§ Priorit y /Favorit e ›
The priority/favorite menu will appear. Define the priority of the selected device, or add resp.
remove the device to resp. from the favorites. For details, please see Priorit y and
Favorit es 160 .

§ Hist oric Dat a ›


The historic data menu will appear.
§ Depending on what time interval you choose, Last 2 day s..., Last 30 day s..., or Last
365 day s..., the Hist oric Dat a Report s 133 tab for the specified interval will be opened.
§ Hist oric Dat a › Creat e Report ... will open an assistant to add a report. For details,
please see Report s St ep by St ep 1778 .
§ Device Tools ›
The device tools menu will appear.

Context Menu Dev ic e Tools

§ Go To Service URL...
This will open the service page you have defined in the Device Set t ings 272 .
§ New window wit h HTTP...
This will open a new browser window with Hypertext Transfer Protocol (HTTP) and the IP
address / DNS name of the device.
§ New window wit h HTTPS...
This will open a new browser window with Hypertext Transfer Protocol Secure (HTTPS) and
the IP address / DNS name of the device.
§ New window wit h FTP...
This will open a new browser window with File Transfer Protocol (FTP) and the IP address /
DNS name of the device.

170 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ Remot e Deskt op...


This will download a .rdp file. When you execute the file remote desktop will start with the
IP address / DNS name of the device. Note: In Firefox you have to use mstsc.exe
(Microsoft Terminal Service) to open the file.
§ Tracerout e...
This will start a traceroute on the selected device. PRTG will display the route and measure
transit delays of packets across the IP network.
§ Inst all Remot e Probe...
This will open an assistant to install a Remot e Probe of PRTG on this device. For more
details, please see Remot e Probe Quick Inst all 2053 .
§ Find Duplicat es...
Search in your PRTG configuration for devices with the same IP address or DNS name as the
selected device. A window with the results will appear, either showing existing duplicates or
a message indicating that there are no duplicates.
§ Send Link by email
You can send the link to the selected device by email. This will open a new email using your
system's standard email client. It will contain a direct link to the selected probe's details
page.
§ Open Ticket
This will open the New Ticket dialog. For details, see section Ticket s 152 .

Sensor Context Menu


§ Check Now
This will perform an immediate scan for the selected sensor.
§ Det ails...
This will show the details of the selected sensor, such as its status and channels.
§ Edit ›
The edit menu will appear.
§ Set t ings...
This will open the Sensor Set t ings 290 tab.
§ Not ificat ions...
This will open the Not ificat ions 1749 tab.
§ Access Right s...
This will open a popup to edit access rights 94 .
§ Rename...
This will open a popup to edit the name of the selected device.
§ Acknowledge Alarm ›
This option is available only in the sensor context menu when a sensor in a Down or Down
(Part ial) status is selected.

28.05.2014 171
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

Context Menu Ac knowledge Alarm

§ You can acknowledge an alarm for the selected sensor. An acknowledged alarm will
show up in the alarms list as "acknowledged" (see Sensor St at es 121 ) and will not trigger
1716 any more notifications 1749 . You can choose between: Acknowledge Indefinit ely ...,

acknowledge For 5 Minut es..., For 15 Minut es..., For 1 Hour..., For 3 Hours..., For 1
Day ..., or Unt il.... If you choose Unt il... a popup window will appear where you can
define a date. If the alarm condition still exists after this date, the sensor will show a
Down status again. Note: If the alarm condition clears, the sensor will usually return into
an Up status immediately with the next sensor scan. For details about acknowledging an
alarm, please see Alarms 145 section.
§ Delet e...
This will delete the selected sensor. You will be asked for confirmation before anything is
actually deleted.
§ Clone
This will open an assistant which guides you through cloning the selected sensor. For
detailed instructions, please see Clone Object 1734 .
§ Move ›
The move menu will appear. This will move the selected sensor. Choose between:
§ Move › Top: This will move the sensor to the top of the mother node (here a
device).
§ Move › Up: This will move the sensor one entry up under the device.
§ Move › Down: This will move the sensor one entry down under the device.
§ Move › Bot t om: This will move the sensor to the bottom of the device.
§ Pause ›
The pause menu will appear. If the sensor is already in a paused state, Resume will appear in
the context menu instead of Pause ›.

172 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 17 Context Menus

§ You can pause and resume monitoring on the selected sensor. You can choose
between: Pause Indefinit ely ..., pause For 5 Minut es..., For 15 Minut es..., For 1 Hour...,
For 3 Hours..., For 1 Day ..., or Pause Unt il.... If you choose Pause Unt il... a popup
window will appear where you can define a date. Monitoring will be resumed after this
date.

§ You can directly add a One-t ime maint enance window to pause monitoring during a
planned downtime. In the appearing window, use the date time picker to enter the start date
and time of the maintenance window, as well as the end time, for the selected object.

§ Simulat e Error St at us
This will set the selected sensor to a simulated error state. As for the paused state, Resume
will appear in the context menu if a the selected sensor is already in a simulated error state.
§ Priorit y /Favorit e ›
The priority/feature menu will appear.
§ Define the priority of the selected sensor. For details, please see Priorit y and Favorit es
160 .

§ Hist oric Dat a ›


The historic data menu will appear.
§ Depending on what time interval you choose, Last 2 day s..., Last 30 day s..., or Last
365 day s..., the Hist oric Dat a Report s 133 tab for the specified interval will be opened.
§ Hist oric Dat a › Creat e Report ... will open an assistant to add a report. For details,
please see Report s St ep by St ep 1778 .
§ Send Link by email
You can send the link to the selected sensor by email. This will open a new email using your
system's standard email client. It will contain a direct link to the selected probe's details
page.
§ Open Ticket
This will open the New Ticket dialog. For details, see section Ticket s 152 .

28.05.2014 173
Part 5: Ajax Web Interface—Basic Procedures | 18 Hover Popup

5.18 Hover Popup


Whenever you rest the mouse pointer for a second over an object's icon in the device tree 108 ,
a hover popup window will appear, showing details about this object. It contains information
from the object's overview tab 124 , as well as several graphs. The exact information provided
depends on the kind of object you are hovering.

Hov er Menu Example: VMware Virtual Mac hine Sensor

Note: The hover popup does only appear if your browser is the currently focused window on
your desktop. It disappears with every (automatic) page refresh.

Menu Icons

At the top of the hover popup window, several icons are shown which enable you to view or
edit the current object. These are the most important options from this object's context menu
163 which is shown when right-clicking it.

174 14.01.2014
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

5.19 Main Menu Structure


Using the main menu, you can access all functions of PRTG. Following, the most important
menu items are described. Often, you can either click on an item directly, or hover it to show
more items.

PRTG Main Menu Bar

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

The following menu items are available:

§ Home 175

§ Devices 176

§ Libraries 178

§ Sensors 178

§ Alarms 181

§ Maps 182

§ Reports 182

§ Logs 183

§ Tickets 183

§ Setup 184

§ Refresh (Arrows Symbol) 186

§ Help Center (? Symbol) 186

§ Logout (Off Symbol) 186

§ Search Box 186

Home

Click to open the user's homepage. The default setting is PRTG's welcome page. The
homepage can be changed in the user's account settings 1812 . Hover to show other menu
items.

28.05.2014 175
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

PRTG Main Menu: Home

§ Dashboard 1 – Dashboard 3
The dashboards provide different preset overviews with the status of your sensors. Choose
the one that fits your needs. Note: Dashboards are not customizable. You can create your
own overview pages using the Maps 1794 feature.
§ Swit ch Clust er Node ›
This option is only available if PRTG runs in Clust ering 81 mode. Show available cluster
nodes. Hover to show other menu items. Follow the menu path (it is specific to your setup)
to select another cluster node. The current Master node is shown in bold letters. Click on a
node's name and you will leave the current node and connect to the other, showing the
same page there.
§ Sit emap
The sitemap contains a flat text view of all menu items. You can easily search for key words
using the search function in your browser (usually shortcut CTRL-F).
§ Go t o Mobile Web GUI
This switches to the Mobile Web GUI 1947 optimized for low bandwidth and mobile devices.
Less scripting is used for more compatibility. However, this is a read-only interface.
§ Welcome t o PRTG
Shows the welcome screen which leads you to the major sections of the web interface.
§ Configurat ion Guru
This will open the Configurat ion Guru welcome page. For details about the guru, please see
section Using t he Configurat ion Guru 36 .
§ Make This My Homepage
Change the page that is loaded when you click on the Home button in the main menu.
Select this menu item on any page and its URL will be set as the current user's homepage
immediately. This setting is user sensitive. The default homepage is /welcome.htm. You can
change this setting any time by clicking on this menu item again, or by changing the
Homepage URL in the My Account 1812 settings.

Devices

Click to show a group view of all your devices, starting with the Root group which contains all
other groups of your setup. Hover to show other menu items.

176 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

PRTG Main Menu: Dev ic es

§ Group View ›
Shows a tree view of all probes and groups in your setup. Click to show a group view of all
your devices, starting with the Root group which contains all other groups of your setup.
Hover to show other menu items. Follow the menu path (it is specific to your setup) to view
the devices in a specific probe or group only.
§ Device List ›
Shows a list view of all devices in your setup. Click to show a table list of all devices in your
setup. Hover to show other menu items. Choose Favorit e Devices to show a list of all
devices marked as Favorit e 160 . Note: Follow the menu path (it is specific to your setup) to
view a table list of the devices in a specific probe or group only. In the table list 156
appearing, you can re-sort the items by clicking on the column's header items.
§ Favorit e Devices
Shows a table list of all devices marked as Favorit e 160 . Note: To mark any device as a
favorite device, select Priorit y /Favorit e | Add t o Favorit es from its context menu or click
on the small flag on a device's details page.
§ Dependencies ›
Shows an overview list of the dependencies configured for the objects in your setup. Hover
the menu item to show other menu items. Choose between Select ed Dependencies and
Mast er Dependencies to view a list of all dependencies or explicit ones. Follow the menu
path (it is specific to your setup) to view dependencies of the objects in a specific probe or
group only.
§ Add Group
Start an assistant which guides you through the process of adding a new group to your
setup. For more information, please see section Creat e Object s Manually 204 . Tip: You can
create new groups much faster by choosing Add Group... from a probe's or group's context
menu!
§ Add Aut o-Discovery Group
Start an assistant which guides you through the process of adding a new auto-discovery
group to your setup. PRTG will create a new group and run an auto-discovery in your
network in order to add devices and sensors for these devices automatically. For more
information, please see section Using t he Aut o-Discovery 190 Tip: You can create new
groups much faster by choosing Add Aut o-Discovery Group... from a probe's or group's
context menu!

28.05.2014 177
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

§ Add Device
Start an assistant which guides you through the process of adding a new device to an
existing group. During the process, you can choose if PRTG should run an auto-discover for
the new device in order to add sensors automatically. For more information, please see
section Creat e Object s Manually 204 . Tip: You can create new devices much faster by
choosing Add Device... from a group's context menu!

Libraries

Click to call the Libraries feature where you can view or add custom views of your network's
status and monitoring data. For more information, please see Libraries 1759 section. Hover to
show other menu items.

PRTG Main Menu: Libraries

§ All
Calls the Libraries feature where you can view or add custom device tree views of your
network's status and monitoring data.
§ Add Library
Lets you directly add 1762 a new library.
§ Select Library ›
Show existing libraries. Hover to show other menu items. Follow the menu path (it is specific
to your setup) to select a library.

Sensors

Click to show a table list of all sensors. In the table list 156 appearing, you can re-sort the items
by clicking on the column's header items, as well as you can filter the list by related object and
tag with the inline filter directly above the table.

Hover Sensors in the main menu bar to show other menu items. Note: In the column Last
Value only the last value of the sensor's primary channel will be shown.

178 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

PRTG Main Menu: Sensors

§ All
Shows a table list of all sensors. In the table list appearing, you can re-sort the items by
clicking on the column's header items. Note: In the column Last Value only the last value of
the sensor's primary channel will be shown.
§ Add Sensor
Start an assistant which guides you through the process of adding a new sensor to an
existing device. For more information, please see section Add a Sensor 220 . During the
process, you can also choose to create a new device. This will bring you to the "Add Device"
assistant you can call from the "Devices" menu directly.
§ Favorit e Sensors
Shows a table list of all sensors marked as Favorit e 160 . Note: To mark any sensor as a
favorite sensor, select Priorit y /Favorit e | Add t o Favorit es from its context menu or click
on the small flag on a device's details page.
§ Top 10 List s ›
This is an option to show a dashboard view with different Top 10 lists regarding best/worst
uptime, Ping, bandwidth usage, website response times, memory usage, and system uptime.
Click to show Top 10 lists out of all sensors. Hover to show other menu items. Follow the
menu path (it is specific to your setup) to view Top 10 lists out of a specific probe or group
only. Note: The sensors will be selected by default tags.
§ By Current Value ›
This is an option to show a filtered sensor list. Hover to show other menu items. Follow the
menu path to view table lists 156 of Fast est or Slowest sensors regarding
§ Ping
§ Port
§ Webpages
§ IMAP/POP3/SMTP
§ FTP

28.05.2014 179
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

as well as Most Used or Least Used sensors regarding


§ Bandwidt h
§ CPU
§ Disk
§ Memory
Note: The sensors will be selected by default tags.
§ By Current St at us ›
This is an option to show a filtered sensor list. Hover to show other menu items. Follow the
menu path to view table lists 1693 of all sensors in a certain state. Select between status
§ Up
§ Warning
§ Down
§ Down (Part ial)
§ Down (Acknowledged)
§ Unusual
§ Paused
§ Unknown
For more information about sensor states, please see Sensor St at es 121 section.
§ By Upt ime/Downt ime ›
This is an option to show a filtered sensor list. Hover to show other menu items. Follow the
menu path to view table lists 156 of all sensors sorted by their up- or downtime. Select
between
§ Best Upt ime (%)
§ Highest Upt ime (Time)
§ Worst Downt ime (%)
§ Highest Downt ime (Time)
§ By Group ›
This is an option to show a filtered sensor list. Hover to show other menu items. Follow the
menu path (it is specific to your setup) to view a sensor table list 156 of a specific probe or
group only.
§ By Ty pe ›
This is an option to show a filtered sensor list. Hover to show other menu items. Follow the
alphabetical menu path (it is specific to your setup) to view a sensor table list 156 containing
only sensors of one specific sensor type.
§ By Tag ›
This is an option to show a filtered sensor list. Hover to show other menu items. Follow the
alphabetical menu path (it is specific to your setup) to see available tags. Select a tag view a
table list 156 containing only sensors marked with this tag.

180 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

§ Cross Reference ›
The cross reference shows information about all sensors including the set interval, access
rights, notification trigger settings, schedule, and dependency. Click to show a sensor cross
reference for all sensors. Hover to show other menu items. Follow the menu path (it is
specific to your setup) to view cross reference information for sensors in a specific probe or
group only, or to view them by type or tag.
§ Compare Sensors ›
Calls a function to compare graphs of two or more monitoring objects. Hover to show other
menu items. Follow the menu path to open an assistant for comparing several monitoring
objects. For more information, please see Compare Sensors 130 section.
§ View Hist oric Dat a
Calls a function for quick generation of sensor data reports. For more information, please
see Hist oric Dat a Report s 133 section.
§ Similar Sensors Overview
Calls an overview page listing similar sensors. For more information, please see Similar
Sensors 138 section.

Alarms

Click to show a all sensors that currently show a Down, Down (Part ial), Warning, or Unusual
status. In the table list 156 appearing, you can re-sort the items by clicking on the column's
header items. If you select Show as Gauges, the sensor gauges will be displayed in a size
corresponding to their priority. Hover to show other menu items.

PRTG Main Menu: Alarms

§ All
Shows a list of all sensors which currently show a Down, Down (Part ial), Down
(Acknowledged), Warning, or Unusual status.
§ Show as Gauges
Shows the gauges of all sensors which currently show a Down, Down (Part ial), Down
(Acknowledged), Warning, or Unusual status. The size of the sensor gauges corresponds
to their respective priority.
§ Errors Only
Shows a list of all sensors which currently show a Down, Down (Part ial), or Down
(Acknowledged) status.
§ Warnings Only
Shows a list of all sensors which currently show a Warning status.

28.05.2014 181
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

§ Unusuals Only
Shows a list of all sensors which currently show an Unusual status.

Maps

Click to call the Maps feature where you can view or add custom views of your network's
status and monitoring data. For more information, please see Maps 1794 section. Hover to show
other menu items.

PRTG Main Menu: Maps

§ All
Calls the Maps feature where you can view or add custom views of your network's status
and monitoring data.
§ Add Map
Lets you directly add 1797 a new map.
§ Select Map ›
Show existing maps. Hover to show other menu items. Follow the menu path (it is specific
to your setup) to select a map.

Reports

Click to call the Reports feature where you can view or add reports of your monitoring data.
For more information, please see Report s 1775 section. Hover to show other menu items.

PRTG Main Menu: Reports

§ All
Calls the Reports feature where you can view or add reports of your monitoring data.
§ Add Report
Lets you directly add a new report.
§ Select Report ›
Show existing reports. Hover to show other menu items. Follow the menu path (it is specific
to your setup) to select a report.

182 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

Logs

Click to show log information for all objects in your configuration, newest first. In the table list
156 appearing, you can filter the items by using the respective options 156 . Hover to show

other menu items. For more information, please see Logs 147 section.

PRTG Main Menu: Logs

§ All
Show log information for all objects in your configuration, newest first.
§ By Group ›
Show log information for objects in a certain group only, newest first. Hover to show other
menu items. Select All, or follow the menu path (it is specific to your setup) to select a
group you would like to show log information for.
§ St at us Changes ›
Show log information for certain status changes only. Hover to show other menu items.
Follow the menu path to view log entries with a special value in the St at us field only. Select
between Up & Down (shows entries with either Up or Down in the St at us field), Down,
Warning, Unusual, Up, Paused/Resumed (shows entries with either Paused or Resumed in
the St at us field), or Acknowledged Alarms.
§ Sy st em Event s ›
Show log information regarding certain system event types only. Hover to show other menu
items. Select between the following event types: Probe Relat ed, Clust er Relat ed, Aut o-
Discovery , Not ificat ions, or St at us Messages.
§ Object Hist ory
Shows information about changes to the PRTG setup and lists deletions of subordinate
system objects. The object history page has a tab-like interface. Using the tabs you can
navigate through various sub-pages in order to view the changes to all related settings and
deletions of objects. Select between the following tabs: My Account , Sy st em Set up,
Not ificat ions, Schedules, User Account s, User Groups, Report s, Libraries, or Maps.
Note: You can open a specific tab directly with the context button Hist ory in the page
header bar 113 on the corresponding pages.

Tickets

Tickets show important system information or action steps to take for the administrator. For
best experience with PRTG, check every ticket and conduct appropriate actions. Click to show
all tickets which are assigned to the current user. In the table list 156 appearing, you can re-sort
the items by clicking on the column's header items, as well as you can filter the list with the
inline filter directly above the table. Hover to show other menu items. For more information,
please see section Ticket s 149 .

28.05.2014 183
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

PRTG Main Menu: Tic kets

You have several options to display a list of tickets which is filtered to your needs. You can
also create a new ticket via the main menu. Available options are:

§ My Ticket s
Click to show all open tickets which are assigned to the current user. Hover to show other
menu items for filtering these tickets depending on their status.
§ All Ticket s
Click to show all open tickets of all PRTG users. Hover to show other menu items for filtering
these tickets depending on their status.
§ ToDo Ticket s
Click to show all open tickets from the type ToDo. Hover to show other menu items for
filtering these tickets depending on their status.
§ Open Ticket
This will open the New Ticket dialog. Provide the needed information and confirm by clicking
on Save to create a User Ticket.

For more information about available options, please refer to section Ticket s 149 .

Setup

Click to show the setup page. Hover to show other menu items. For more information, please
see Set up 1810 section.

PRTG Main Menu: Setup

§ Overview
Shows the setup page 1810 .
§ Account Set t ings ›
Hover to show menu items of the account settings. Choose from:

184 28.05.2014
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

§ My Account 1812

§ Not ificat ions 1817

§ Schedules 1827

§ Sy st em Administ rat ion ›


Hover to show menu items of the system administration settings. Choose from:
§ User Int erface 1831

§ Monit oring 1839

§ Not ificat ion Delivery 1843

§ Probes 1849

§ Clust er 1855

§ User Account s 1856

§ User Groups 1861

§ Administ rat ive Tools 1865

§ Downloads / Add-Ons ›
Shows additional downloads for PRTG. Choose from:
§ PRTG Ent erprise Console 1885

§ Apps for iOS & Android 1885

§ Remot e Probe Inst aller 1885

§ PRTG Add-Ons 1885

§ PRTG Billing Tool 1886

§ Chrome Deskt op Not ificat ions 1887

§ Ent er License Key


Shows help on how to Ent er a License Key 57 .

§ PRTG St at us ›
Hover to show menu items of the PRTG status. Choose from:
§ Sy st em St at us 1869

§ Clust er St at us 1883

§ Act ivat ion St at us 1884

§ Soft ware Aut o-Updat e


Shows the Soft ware Aut o-Updat e 1878 status of your PRTG installation. On this page, you
can also download and install available updates.
§ PRTG API
Shows documentation about the Applicat ion Programming Int erface (API) Definit ion 2031

for your installation.


§ Cont act Support
Calls the Cont act Paessler Support / Send Your Feedback t o Paessler 1889 page.

28.05.2014 185
Part 5: Ajax Web Interface—Basic Procedures | 19 Main Menu Structure

Refresh (Arrows Symbol)

PRTG Main Menu: Refresh Button

Click this symbol to refresh all elements on the current page to display current data. Unlike the
reload function of your browser, this merely refreshes the single page elements, not the whole
page. During the refresh process, this symbol flashes.

Help Center (? Symbol)

PRTG Main Menu: Help Button

Shows the help center which supports you if you have any questions regarding your PRTG
setup.

Logout (Off Symbol)

PRTG Main Menu: Logout Button

Logs out the current user and shows the login screen 102 .

Search Box

Use the search box to find objects and reports, and other items by name or tag, or to search
for help.

Context Menu

Additionally, there are Cont ext Menus 163 available for all objects. Right-click on an object to
open it.

186 28.05.2014
Part 6
Ajax Web Interface—Device and Sensor Setup

14.01.2014 187
Part 6: Ajax Web Interface—Device and Sensor Setup |

6 Ajax Web Interface—Device and Sensor


Setup
The Ajax-based web interface is your access to PRTG. It is used to configure devices and
sensors, and to set up notifications, as well as to review monitoring results and to create
reports. This web interface is highly interactive, uses Asynchronous Java Script and XML (AJAX)
to deliver a powerful and easy-to-use user experience. While the user is logged in 102 , the data
on the screen is permanently refreshed (via Ajax calls) so it always shows the current
monitoring results (refresh interval and method can be set 1856 by the user).

Because the web interface works as a Single Page Application (SPA), you will rarely see a full
page refresh to avoid this performance impact due to redundant processing. Only single page
elements will be refreshed when necessary. All object setting dialogs are shown as pop-up
layers, so you will never lose the current context. This speeds up the user experience
appreciably and makes the configuration of objects in PRTG comprehensible.

The following sections introduce device and sensor setup in the Ajax Graphical User Interface
(GUI).

188 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup |

Ajax Web Interface—Device and Sensor Setup—Topics


§ Aut o-Discovery 190

§ Creat e Object s Manually 204

§ Manage Device Tree 222

§ Root Group Set t ings 224

§ Probe Set t ings 238

§ Group Set t ings 253

§ Device Set t ings 272

§ Sensor Set t ings 290 —List of Available Sensor Ty pes 291

§ Sensor Channels Set t ings 1709

§ Sensor Not ificat ions Set t ings 1716

Other Ajax Web Interface Sections


§ Ajax Web Int erface—Basic Procedures 100

§ Ajax Web Int erface—Advanced Procedures 1726

Related Topics
§ Ent erprise Console 1894

§ Ot her User Int erfaces 1946

14.01.2014 189
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

6.1 Auto-Discovery
PRTG's auto-discovery function is a great way to automatically create a sophisticated and
concise set of sensors for your complete network. It is mainly suitable for LAN discovery since
it involves a lot of SNMP and WMI. For video instructions, please see the More 203 section
below.

For a quick start auto-discovery, please see TWO—Using t he Configurat ion Guru 36 section.

How Auto-Discovery Works

PRTG's auto-discovery process has three stages:

§ St ep 1
Scanning a network segment for devices using Ping (for groups only).
§ St ep 2
Assessing the device type for all devices discovered in Step 1 (using SNMP, WMI, and other
protocols).
§ St ep 3a
Creating sensor sets that match the discovered device types of step 2. This is done based
on built-in device templates with recommended sensors for many device types.

St ep 3b (opt ional)
Creating sensor sets using user created device templates (see Creat e Device Templat e 1741

section).

The auto-discovery can be used on a group level for a range of IP addresses, or for individual
devices which you might have created manually. It can be run just once, on demand via the
context menu, or scheduled every hour, day or week. Running the auto-discovery every day
or week will automatically create new sensors when new devices are connected to the
network. As soon as new devices or sensors are discovered, new Ticket s 149 are created
(which are mailed to the system administrator by default).

Please be aware of the following restrictions of the auto-discovery:

§ PRTG can not discover devices that can not be pinged, since Step 1 uses pings. If, for
example, a firewall blocks echo requests, a device behind it cannot be discovered.
§ You should supply authentication settings for Windows Sy st ems, Linux (SSH/WBEM)
Sy st ems, VMware/X EN Servers, and SNMP Devices in order to fully exploit the power of
this feature. We recommend defining these in the Root group settings 224 .
§ If a device has more than one IP address, it may show up more than once in the discovery
results, even though PRTG tries to identify these situations.
§ If a device already exists on the same probe, the auto-discovery will skip this device and not
create a duplicate.
§ Using frequent auto-discoveries of large network segments can lead to performance issues.
We therefore recommend to only schedule regular auto-discoveries where necessary. For
detailed information see the More 203 section below.

190 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Run Auto-Discovery Now

You can run an auto-discovery at any time for a group or a device. To do so, right-click on the
respective object and from the context menu, select Run Aut o-Discovery . PRTG will
immediately start searching for new objects which can be added to the device tree. If used for
a group, PRTG will add devices and sensors, if found. If used for a device, it will add new
sensors, if found.

Note: The auto-discovery will also re-add devices or sensors you have manually deleted. If you
do not want this, please create objects manually 204 only.

Creating an Auto-Discovery Group

There are several ways to start auto-discovery:

§ On the welcome screen 108 , click on the Perform Net work Aut o-Discovery option,
§ or select Devices | Add Aut o-Discovery Group from the main menu.

To start an automatic detection of devices and sensors in your network an assistant will
appear, leading you through two steps. For faster setup, you can select Add Aut o-Discovery
Group... in the context menu 163 of a probe or group to which you want to add the new
group. This will skip step 1 and lead you directly to step 2.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

28.05.2014 191
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Add Auto-Disc ov ery Group Dialog

§ St ep 1
Please choose a probe or group you want to add the new group to. Click on Cont inue.
§ St ep 2
Add auto-discovery settings as described below.

Add Auto-Discovery Group Settings

Group Name and Tags

Group Name Enter a meaningful name to identify the group. The name will be
shown by default in the devices tree and in all alarms.

Tags Enter one or more tags; confirm each tag by hitting the space,
comma, or enter key. You can use tags to group objects and use
tag-filtered views later on. Tags are not case sensitive. Tags are
automatically inherited 89 .

192 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Group Ty pe

Sensor Management Select the method for automatic network discovery. Choose
between:
§ Aut omat ic device ident ificat ion (st andard, recommended):
Detect mainly based on Ping, SNMP, and WMI. This option should
work fine for most installations.
§ Aut omat ic device ident ificat ion (det ailed, may creat e many
sensors): Detect in a more detailed way and create more
sensors. This option uses all standard device templates for auto-
discovery. It is suitable for small network segments and
whenever you want to monitor the maximum number of sensors
available.
§ Aut omat ic sensor creat ion using specific device t emplat e(s):
Manually define the device templates used for auto-discovery.
From the list below, select one or more templates.

Device Template(s) This option is only visible if using specific device templates (last
option) is enabled above. Please choose one or more templates by
adding a check mark in front of the respective template name. You
can also select and deselect all items by using the check box in the
table head. These will be used for auto-discovery on the current
device. Choose from:
§ ADSL
§ Cisco ASA VPN
§ Cisco Device (Generic)
§ Dell MDI
§ DNS Server
§ Environment Jacart a
§ Environment Poseidon
§ Frit zbox
§ FTP Server
§ Generic Device (PING only )
§ Generic Device (SNMP-enabled)
§ Generic Device (SNMP-enabled, Det ailed)
§ HTTP Web Server
§ Hy per V Host Server
§ Linux/UNIX Device (SNMP or SSH enabled)
§ Mail Server (Generic)

28.05.2014 193
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

§ Mail Server (MS Exchange)


§ Microsoft Sharepoint 2010
§ NAS LenovoEMC
§ NAS QNAP
§ NAS Sy nology
§ Net App
§ NTP Server
§ Print er (HP)
§ RDP Server
§ RMON compat ible device
§ Server (Compaq/HP agent s)
§ Server (Dell)
§ Sever Cisco UCS
§ Server IBM
§ SonicWALL
§ Swit ch (Cisco Cat aly st )
§ Swit ch (Cisco IOS Based)
§ Swit ch (HP Procurve)
§ UNIX /Linux Device
§ UPS (APC)
§ Virt uozzo Server
§ VMware ESX / vCent er Server
§ Windows (Det ailed via WMI)
§ Windows (via Remot e Powershell)
§ Windows (via WMI)
§ Windows IIS (via SNMP)
§ X EN Host s
§ X EN Virt ual Machines

Once the auto-discovery is finished, PRTG will create a new ticket


149 and list the device templates which were actually used to

create new sensors. Templates which were not applied will not be
shown in the ticket.

Discovery Schedule Define when the auto-discovery will be run. Choose between:

194 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

§ Once: Perform auto-discovery only once. New devices and


sensors will be added once. You can run auto-discovery manually
any time using an object's context menu 163 .
§ Hourly : Perform auto-discovery for new devices and sensors
every 60 minutes. Note: Please use this option with caution!
Frequently executed auto-discoveries might cause performance
issues, especially when large network segments are scanned
every hour.
§ Daily : Perform auto-discovery for new devices and sensors every
24 hours. The first auto-discovery will run immediately, all other
discoveries will start on the time defined in the Aut o-Discovery
Set t ings section of the Sy st em Administ rat ion—Monit oring
1841 settings.

§ Weekly : Perform auto-discovery for new devices and sensors


every 7 days. The first auto-discovery will run immediately, all
other discoveries will start on the time defined in the Aut o-
Discovery Set t ings section of the Sy st em Administ rat ion—
Monit oring 1841 settings.

IP Selection Method Define how you want to define the IP range for auto-discovery.
Choose between:
§ Class C base IP wit h st art /end (IPv4): Define an IPv4 class C
address range.
§ List of individual IPs and DNS names (IPv4): Enter a list of
individual IPv4 addresses or DNS names.
§ IP and Subnet (IPv4): Enter an IPv4 address and subnet mask.
§ IP wit h oct et range (IPv4): Enter an IPv4 address range for every
IP octet individually. With this, you can define very customizable IP
ranges.
§ List of individual IPs and DNS names (IPv6): Enter a list of
individual IPv6 addresses or DNS names.
§ Use comput ers from t he act ive direct ory (maximum 1000
comput ers): Search in the active directory for computers to
perform auto-discovery.
Note: Only subnets with up to 65,536 IP addresses can be
discovered! If you define a range with a higher number of
addresses, discovery will stop before it is completed.

IPv4 Base This field is only visible if Class C network detection is selected
above. Enter a class C network as IP base for the auto-discovery.
Enter the first three octets of an IPv4 IP address, for example,
192.168.0

28.05.2014 195
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

IPv4 Range Start This field is only visible if Class C network detection is selected
above. Enter the IP octet of the class C network specified above
from which PRTG will start the auto-discovery. This will complete
the IP base above to an IPv4 address. For example, enter 1 to
discover from 192.168.0.1.

IPv4 Range End This field is only visible if Class C network detection is selected
above. Enter the IP octet of the class C network specified above at
which PRTG will stop the auto-discovery. This will complete the IP
base above to an IPv4 address. For example, enter 254 to discover
up to 192.168.0.254.

IPv4/DNS Name List This field is only visible if the IP list option is selected above. Enter a
IPv6/DNS Name List list of IP addresses or DNS names which the auto-discovery will
scan. Enter each address in a separate line.

IPv4 and Subnet (IPv4) This field is only visible if the IP and subnet option is selected
above. Enter an expression in the format address/subnet , e.g.
192.168.3.0/255.255.255.0. You can also use the short form like
192.168.3.0/24 in this example. PRTG will scan the complete host
range (without network and broadcast address) defined by the IP
address and the subnet mask.

IP with Octet Range This field is only visible if the octet range option is selected above.
Enter an expression in the format a1.a2.a3.a4, where a1, a2, a3,
and a4 are each a number between 0-255, or a range with two
numbers and a hyphen like 1-127. All permutations of all ranges are
calculated, e.g. 10.0.1-10.1-100 results in 1,000 addresses that
PRTG will scan during auto-discovery.

Organizational Unit This field is only visible if active directory is selected above. Enter
an organizational unit (OU) to restrict the active directory search to
computers which are part of this OU. Just enter the name of the OU
without any other term (i.e., without "OU" in front). If you leave this
field empty, there will not be any restriction.
If you have sub-OUs, too, please consider the correct syntax in the
format Y,OU=X : OUs that are part of another OU have to be listed
together with their parent(s). Enter the sub-OU followed by ,OU=
and the name of the parent OU. For example, assuming that the
organizational unit 'Y' is part of the OU named 'X'. Then the syntax
would be Y,OU=X. For three OUs 'X', 'Y' part of 'X', and 'Z' part of 'Y',
the syntax would be Z,OU=Y,OU=X. Note that the order is
important, sub-OUs have to be listed left of its according parents!

Name Resolution Define how newly discovered devices will be monitored. This only
affects new devices. The setting for existing devices will be kept.
Choose between:
§ Use DNS / WMI / SNMP names (recommended): Monitor newly
discovered devices via their DNS, WMI, or SNMP names (if
available).

196 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

§ Use IP addresses: Monitor newly discovered devices via their IP


address.
We recommend using the default value.

Device Rescan Define if you want to rescan known devices. Choose between:
§ Skip aut o-discovery for known devices/IPs (recommended):
Do not re-scan known devices or IP addresses, but only scan for
new devices/IPs when auto-discovering. This can avoid re-
creation of manually deleted sensors. PRTG will also avoid adding
devices that are already included elsewhere in your configuration,
e.g. in other groups.
§ Perform aut o-discovery for known devices/IPs: Re-scan
known devices and IP addresses with every auto-discovery. This
will re-create manually deleted sensors on existing devices.
We recommend using the default value.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

If you have not set credentials yet, set them now before starting the auto-discovery in order
to fully exploit the power of this feature!

Credent ials for Windows Sy st ems

Domain or Computer Define the authority for Windows access. This is used for Windows
Name Management Instrumentation (WMI) and other Windows sensors. If
you want to use a Windows local user account on the target
device, please enter the computer name here. If you want to use a
Windows domain user account (recommended), please enter the
(Active Directory) domain name here. If not explicitly defined, PRTG
will automatically add a prefix in order to use the NT LAN Manager
(NTLM) protocol. Please do not leave this field empty.

Username Enter the username for Windows access. Usually, you will use
credentials with administrator privileges.

Password Enter the password for Windows access. Usually, you will use
credentials with administrator privileges.

28.05.2014 197
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Username Enter a login name for the access via SSH and WBEM. Usually, you
will use credentials with administrator privileges.

Login Define which authentication method will be used for login. Choose
between:
§ Login via Password: Provide a password for login. Enter below.
§ Login via Privat e Key : Provide a private key for authentication.
Note: PRTG can only handle keys in OpenSSH format which are
not encrypted. You cannot use password protected keys here. In
the text field, please paste the entire private key, including the
"BEGIN" and "END" lines. Please make sure the according public
key is provided on the target machine. For details, please see
Monit oring via SSH 1962 .

Password This field is only visible if password login is selected above. Enter a
password for the Linux access via SSH and WBEM. Usually, you will
use credentials with administrator privileges.

Private Key This field is only visible if private key login is selected above. Paste
a private key into the field (OpenSSH format, unencrypted). Usually,
you will use credentials with administrator privileges. Note: If you
do not insert a private key for the first time, but change the private
key, you need to restart your PRTG core server service in order for
the private key change to take effect! For details, please see
Monit oring via SSH 1962 .

For WBEM Use Protocol Define the protocol that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ HTTP: Use an unencrypted connection for WBEM.
§ HTTPS: Use an SSL-encrypted connection for WBEM.

For WBEM Use Port Define the port that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ Set aut omat ically (port 5988 or 5989): Use one of the
standard ports, depending on whether unencrypted or encrypted
connection is chosen above.
§ Set manually : Use a custom port. Define below.

WBEM Port This setting is only visible if manual port selection is enabled above.
Enter the WBEM port number.

SSH Port Define the port number which will be used for SSH connections.
Note: By default, this setting is automatically used for all SSH
sensors 296 , unless you define a different port number in the sensor
settings.

198 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

SSH Rights Elevation Define with which rights the command will be executed on the
target system. Choose between:
§ Run t he command as t he user connect ing (default ): Use the
rights of the user who establishes the SSH connection.
§ Run t he command as anot her user using 'sudo': Use the rights
of another user, for example, the administrator.
§ Run t he command as anot her user using 'su': Use the rights of
another target user.

Target Username This field is only visible if sudo or su is enabled above. Enter a
username to run the specified command as another user than root.
If you leave this field empty, the command will be run as root.
Ensure that you set the Linux password even you use a public/
private key for authentication. This is not necessary if the user is
allowed to execute the command without a password.

Password Target User This field is only visible if su is enabled above. Enter the password
for the specified target user.

Credent ials for VMware/X enServer

User Enter a login name for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

Password Enter a password for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

VMware Protocol Define the protocol used for the connection to VMware and
XenServer. Choose between:
§ HTTPS (recommended): Use an SSL-encrypted connection to
VMware and XenServers.
§ HTTP: Use an unencrypted connection to VMware and
XenServers.

Credent ials for SNMP Devices

SNMP Version Select the SNMP version that will be used for device connection.
Choose between:
§ v1: Use the simple standard v1 protocol for SNMP connections.
This protocol only offers clear-text data transmission, but it is
usually supported by all devices.

28.05.2014 199
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Credent ials for SNMP Devices

§ v2c: Use the more advanced v2c protocol for SNMP connections.
Data is still transferred as clear-text, but it supports 64-bit
counters.
§ v3: Use the latest v3 protocol for SNMP connections. It provides
secure authentication and data encryption.
Note for SNMP v3: Due to internal limitations you can only monitor
a limited number of sensors per second using SNMP v3. The limit is
somewhere between 1 and 50 sensors per second (depending on
the SNMP latency of your network). This means that using an
interval of 60 seconds you are limited to between 60 and 3000
SNMP v3 sensors for each probe. If you experience an increased
"Interval Delay" or "Open Requests" reading of the probe health
sensor, you need to distribute the load over multiple probes. SNMP
v1 and v2 do not have this limitation.

Community String This setting is only visible if SNMP version v1 or v2c are enabled
above. Enter the community string of your devices. This is a kind of
"clear-text password" used for simple authentication. We
recommend using the default value.

Authentication Type This setting is only visible if SNMP version v3 is enabled above.
Choose between:
§ MD5: Use Message-Digest Algorithm 5 (MD5) for authentication.
§ SHA: Use Secure Hash Algorithm (SHA) for authentication.
The chosen type has to match the authentication type of your
device.
Note: If you do not want to use authentication, but you need SNMP
v3, for example, because your device requires context, you can
leave the field password empty. In this case,
SNMP_SEC_LEVEL_NOAUTH will be used and authentication will be
deactivated entirely.

User This setting is only visible if SNMP version v3 is enabled above.


Enter a username for secure authentication. This value has to
match the username of your device.

Password This setting is only visible if SNMP version v3 is enabled above.


Enter a password for secure authentication. This value has to
match the password of your device.

Encryption Type This setting is only visible if SNMP version v3 is enabled above.
Select an encryption type. Choose between:
§ DES: Use Data Encryption Standard (DES) as encryption
algorithm.

200 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Credent ials for SNMP Devices

§ AES: Use Advanced Encryption Standard (AES) as encryption


algorithm.
The chosen type has to match the encryption type of your device.

Data Encryption Key This setting is only visible if SNMP version v3 is enabled above.
Enter an encryption key here. If you provide a key in this field,
SNMP data packets will be encrypted using the encryption
algorithm selected above, providing increased security. The
provided key here has to match the encryption key of your device.
Note: If the key entered in this field does not match the key
configured in the target SNMP device, you will not get an error
message! Please enter a string or leave the field empty.

Context Name This setting is only visible if SNMP version v3 is enabled above.
Enter a context name only if it is required by the configuration of
the device. Context is a collection of management information
accessible by an SNMP device. Please enter a string.

SNMP Port Enter the port used for SNMP communication. We recommend using
the default value.

SNMP Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

28.05.2014 201
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists.
§ Read: Users in this group can see the object and review its
settings.
§ Writ e: Users in this group can see the object, as well as review
and edit its settings. However, they cannot edit access rights
settings.
§ Full: Users in this group can see the object, as well as review and
edit its settings and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings.

Click on the Cont inue button to store your settings. If you change tabs or use the main menu,
all changes to the settings will be lost!

202 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 1 Auto-Discovery

Auto-Discovery in Progress

While auto-discovery is running you may experience a lower system performance as usual,
because PRTG works in the background in order to discover your network. Depending on the
IP ranges defined (up to 65,536 addresses) , the discovery may run up to several days before
complete. You can review the status of the discovery process as follows:

§ In the device tree, behind the group or device name, you will see a percentage value
showing the progress of auto-discovery.
§ During auto-discovery, the web interface will display a box in the lower right corner, showing
the number of active auto-discovery tasks.
§ In order to stop a running auto-discovery, right-click the group or device, and select Pause |
For 5 minut es... from the context menu 163 . Monitoring will be paused for 5 minutes, and
auto-discovery tasks will be shut down.

Related Topics

§ Creat e Device Templat e 1741

More
Video Tutorial: There is a video available on the Paessler video tutorials page.
§ http://www.paessler.com/support/video_tutorials

Knowledge Base: Why can automatic auto-discoveries evoke performance issues?


§ http://kb.paessler.com/en/topic/14423

28.05.2014 203
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually

6.2 Create Objects Manually


We recommend using the auto-discovery 190 function to create a basic monitoring setup for
your network. Afterwards, you can manually create devices that could not be discovered, or
arrange 1733 detected devices in groups.

The procedure depends on the kind of object you want to add. Choose between:

§ Add a Group 205

§ Add a Device 211

§ Add a Sensor 220

Add a Remote Probe

Please see Mult iple Probes and Remot e Probes 2049 section for more information.

204 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
1 Add a Group

6.2.1 Add a Group

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

In order to add a group manually, select Devices | Add Group from the main menu. An
assistant will appear, leading you through two steps. For faster setup, you can select Add
Group... in the context menu 163 of a probe or group to which you want to add the new
group. This will skip step 1 and lead you directly to step 2.

§ St ep 1
Please choose a probe or group you want to add the new group to. Click on Cont inue.

Add Group Assistant Step 2

§ St ep 2
Add group settings as described below.

Add Group Settings

Group Name and Tags

Group Name Enter a meaningful name to identify the group. The name will be
shown by default in the devices tree and in all alarms.

Tags Enter one or more tags; confirm each tag by hitting the space,
comma, or enter key. You can use tags to group objects and use
tag-filtered views later on. Tags are not case sensitive. Tags are
automatically inherited 89 .

14.01.2014 205
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
1 Add a Group

Credent ials for Windows Sy st ems

Domain or Computer Define the authority for Windows access. This is used for Windows
Name Management Instrumentation (WMI) and other Windows sensors. If
you want to use a Windows local user account on the target
device, please enter the computer name here. If you want to use a
Windows domain user account (recommended), please enter the
(Active Directory) domain name here. If not explicitly defined, PRTG
will automatically add a prefix in order to use the NT LAN Manager
(NTLM) protocol. Please do not leave this field empty.

Username Enter the username for Windows access. Usually, you will use
credentials with administrator privileges.

Password Enter the password for Windows access. Usually, you will use
credentials with administrator privileges.

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Username Enter a login name for the access via SSH and WBEM. Usually, you
will use credentials with administrator privileges.

Login Define which authentication method will be used for login. Choose
between:
§ Login via Password: Provide a password for login. Enter below.
§ Login via Privat e Key : Provide a private key for authentication.
Note: PRTG can only handle keys in OpenSSH format which are
not encrypted. You cannot use password protected keys here. In
the text field, please paste the entire private key, including the
"BEGIN" and "END" lines. Please make sure the according public
key is provided on the target machine. For details, please see
Monit oring via SSH 1962 .

Password This field is only visible if password login is selected above. Enter a
password for the Linux access via SSH and WBEM. Usually, you will
use credentials with administrator privileges.

Private Key This field is only visible if private key login is selected above. Paste
a private key into the field (OpenSSH format, unencrypted). Usually,
you will use credentials with administrator privileges. Note: If you
do not insert a private key for the first time, but change the private
key, you need to restart your PRTG core server service in order for
the private key change to take effect! For details, please see
Monit oring via SSH 1962 .

For WBEM Use Protocol Define the protocol that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ HTTP: Use an unencrypted connection for WBEM.

206 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
1 Add a Group

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

§ HTTPS: Use an SSL-encrypted connection for WBEM.

For WBEM Use Port Define the port that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ Set aut omat ically (port 5988 or 5989): Use one of the
standard ports, depending on whether unencrypted or encrypted
connection is chosen above.
§ Set manually : Use a custom port. Define below.

WBEM Port This setting is only visible if manual port selection is enabled above.
Enter the WBEM port number.

SSH Port Define the port number which will be used for SSH connections.
Note: By default, this setting is automatically used for all SSH
sensors 296 , unless you define a different port number in the sensor
settings.

SSH Rights Elevation Define with which rights the command will be executed on the
target system. Choose between:
§ Run t he command as t he user connect ing (default ): Use the
rights of the user who establishes the SSH connection.
§ Run t he command as anot her user using 'sudo': Use the rights
of another user, for example, the administrator.
§ Run t he command as anot her user using 'su': Use the rights of
another target user.

Target Username This field is only visible if sudo or su is enabled above. Enter a
username to run the specified command as another user than root.
If you leave this field empty, the command will be run as root.
Ensure that you set the Linux password even you use a public/
private key for authentication. This is not necessary if the user is
allowed to execute the command without a password.

Password Target User This field is only visible if su is enabled above. Enter the password
for the specified target user.

Credent ials for VMware/X enServer

User Enter a login name for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

Password Enter a password for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

14.01.2014 207
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
1 Add a Group

Credent ials for VMware/X enServer

VMware Protocol Define the protocol used for the connection to VMware and
XenServer. Choose between:
§ HTTPS (recommended): Use an SSL-encrypted connection to
VMware and XenServers.
§ HTTP: Use an unencrypted connection to VMware and
XenServers.

Credent ials for SNMP Devices

SNMP Version Select the SNMP version that will be used for device connection.
Choose between:
§ v1: Use the simple standard v1 protocol for SNMP connections.
This protocol only offers clear-text data transmission, but it is
usually supported by all devices.
§ v2c: Use the more advanced v2c protocol for SNMP connections.
Data is still transferred as clear-text, but it supports 64-bit
counters.
§ v3: Use the latest v3 protocol for SNMP connections. It provides
secure authentication and data encryption.
Note for SNMP v3: Due to internal limitations you can only monitor
a limited number of sensors per second using SNMP v3. The limit is
somewhere between 1 and 50 sensors per second (depending on
the SNMP latency of your network). This means that using an
interval of 60 seconds you are limited to between 60 and 3000
SNMP v3 sensors for each probe. If you experience an increased
"Interval Delay" or "Open Requests" reading of the probe health
sensor, you need to distribute the load over multiple probes. SNMP
v1 and v2 do not have this limitation.

Community String This setting is only visible if SNMP version v1 or v2c are enabled
above. Enter the community string of your devices. This is a kind of
"clear-text password" used for simple authentication. We
recommend using the default value.

Authentication Type This setting is only visible if SNMP version v3 is enabled above.
Choose between:
§ MD5: Use Message-Digest Algorithm 5 (MD5) for authentication.
§ SHA: Use Secure Hash Algorithm (SHA) for authentication.
The chosen type has to match the authentication type of your
device.

208 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
1 Add a Group

Credent ials for SNMP Devices

Note: If you do not want to use authentication, but you need SNMP
v3, for example, because your device requires context, you can
leave the field password empty. In this case,
SNMP_SEC_LEVEL_NOAUTH will be used and authentication will be
deactivated entirely.

User This setting is only visible if SNMP version v3 is enabled above.


Enter a username for secure authentication. This value has to
match the username of your device.

Password This setting is only visible if SNMP version v3 is enabled above.


Enter a password for secure authentication. This value has to
match the password of your device.

Encryption Type This setting is only visible if SNMP version v3 is enabled above.
Select an encryption type. Choose between:
§ DES: Use Data Encryption Standard (DES) as encryption
algorithm.
§ AES: Use Advanced Encryption Standard (AES) as encryption
algorithm.
The chosen type has to match the encryption type of your device.

Data Encryption Key This setting is only visible if SNMP version v3 is enabled above.
Enter an encryption key here. If you provide a key in this field,
SNMP data packets will be encrypted using the encryption
algorithm selected above, providing increased security. The
provided key here has to match the encryption key of your device.
Note: If the key entered in this field does not match the key
configured in the target SNMP device, you will not get an error
message! Please enter a string or leave the field empty.

Context Name This setting is only visible if SNMP version v3 is enabled above.
Enter a context name only if it is required by the configuration of
the device. Context is a collection of management information
accessible by an SNMP device. Please enter a string.

SNMP Port Enter the port used for SNMP communication. We recommend using
the default value.

SNMP Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

14.01.2014 209
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
1 Add a Group

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists.
§ Read: Users in this group can see the object and review its
settings.
§ Writ e: Users in this group can see the object, as well as review
and edit its settings. However, they cannot edit access rights
settings.
§ Full: Users in this group can see the object, as well as review and
edit its settings and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings.

Click on the Cont inue button to store your settings. If you change tabs or use the main menu,
all changes to the settings will be lost!

210 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

6.2.2 Add a Device

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

To manually add a device, select Devices | Add Device from the main menu. An assistant will
appear, leading you through two steps. For faster setup, you can select Add Device... in the
context menu 163 of a group to which you want to add the new device. This will skip step 1
and lead you directly to step 2.

§ St ep 1
Please choose a group you want to add the new device to. Click on Cont inue.

Add Dev ic e Assistant Step 2

§ St ep 2
Add device settings as described below.

Add Device Settings

Device Name and Address

Device Name Enter a meaningful name to identify the device. The name will be
shown by default in the device tree and in all alarms.

IP Version Define which IP protocol PRTG will use to connect to this device.
The setting is valid for all sensors created on this device. Choose
between:
§ Connect using IPv4: Use IP version 4 for all requests to this
device.

14.01.2014 211
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Device Name and Address

§ Connect using IPv6: Use IP version 6 for all requests to this


device.

IP Address/DNS Name Enter the IP address (either v4 or v6, depending on your selection
above) or DNS name for the device. Most sensors created on this
device will inherit this setting and they will try to connect to this
address for monitoring. Note: There are some sensor types that
still have their own setting for IP address/DNS name. Those
sensors will use their own settings.

Tags Enter one or more tags; confirm each tag by hitting space, comma,
or enter key. You can use tags to group sensors and use tag-
filtered views later on. Tags are not case sensitive. Tags are
automatically inherited 89 .

Device Icon Choose a device icon from the list. It will be shown in the device
tree.

Device Ty pe

Sensor Management Select which type of auto-discovery you would like to perform for
this device. Choose between:
§ Manual (no aut o-discovery ): Do not auto-discover any sensors,
but only add sensors manually.
§ Aut omat ic device ident ificat ion (st andard, recommended):
Use a small set of auto-discovery templates. This will scan your
LAN and usually create a view standard sensors on your device.
§ Aut omat ic device ident ificat ion (det ailed, may creat e many
sensors: Use an extended set of auto-discovery templates. This
will scan your LAN and usually create many sensors on your
device.
§ Aut omat ic sensor creat ion using specific device t emplat es:
Use specific auto-discovery templates only. Please select
templates below. This will scan your LAN and add sensors
defined in the template.

Discovery Schedule This option is only visible if one of the auto-discovery options is
selected above. Define when the auto-discovery will be run.
Choose between:
§ Once: Perform auto-discovery only once. For existing devices,
this will initiate a one-time sensor update for the current device.
§ Hourly : Perform auto-discovery for new sensors every hour.
§ Daily : Perform auto-discovery for new sensors every day.

212 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Device Ty pe

§ Weekly : Perform auto-discovery for new sensors every week.

Device Template(s) This option is only visible if using specific device templates (last
option) is enabled above. Please choose one or more templates by
adding a check mark in front of the respective template name. You
can also select and deselect all items by using the check box in the
table head. These will be used for auto-discovery on the current
device. Choose from:
§ ADSL
§ Cisco ASA VPN
§ Cisco Device (Generic)
§ Dell MDI
§ DNS Server
§ Environment Jacart a
§ Environment Poseidon
§ Frit zbox
§ FTP Server
§ Generic Device (PING only )
§ Generic Device (SNMP-enabled)
§ Generic Device (SNMP-enabled, Det ailed)
§ HTTP Web Server
§ Hy per V Host Server
§ Linux/UNIX Device (SNMP or SSH enabled)
§ Mail Server (Generic)
§ Mail Server (MS Exchange)
§ Microsoft Sharepoint 2010
§ NAS LenovoEMC
§ NAS QNAP
§ NAS Sy nology
§ Net App
§ NTP Server
§ Print er (HP)
§ RDP Server
§ RMON compat ible device

14.01.2014 213
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Device Ty pe

§ Server (Compaq/HP agent s)


§ Server (Dell)
§ Sever Cisco UCS
§ Server IBM
§ SonicWALL
§ Swit ch (Cisco Cat aly st )
§ Swit ch (Cisco IOS Based)
§ Swit ch (HP Procurve)
§ UNIX /Linux Device
§ UPS (APC)
§ Virt uozzo Server
§ VMware ESX / vCent er Server
§ Windows (Det ailed via WMI)
§ Windows (via Remot e Powershell)
§ Windows (via WMI)
§ Windows IIS (via SNMP)
§ X EN Host s
§ X EN Virt ual Machines

Once the auto-discovery is finished, PRTG will create a new ticket


149 and list the device templates which were actually used to

create new sensors. Templates which were not applied will not be
shown in the ticket.

Credent ials for Windows Sy st ems

Domain or Computer Define the authority for Windows access. This is used for Windows
Name Management Instrumentation (WMI) and other Windows sensors. If
you want to use a Windows local user account on the target
device, please enter the computer name here. If you want to use a
Windows domain user account (recommended), please enter the
(Active Directory) domain name here. If not explicitly defined, PRTG
will automatically add a prefix in order to use the NT LAN Manager
(NTLM) protocol. Please do not leave this field empty.

214 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Credent ials for Windows Sy st ems

Username Enter the username for Windows access. Usually, you will use
credentials with administrator privileges.

Password Enter the password for Windows access. Usually, you will use
credentials with administrator privileges.

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Username Enter a login name for the access via SSH and WBEM. Usually, you
will use credentials with administrator privileges.

Login Define which authentication method will be used for login. Choose
between:
§ Login via Password: Provide a password for login. Enter below.
§ Login via Privat e Key : Provide a private key for authentication.
Note: PRTG can only handle keys in OpenSSH format which are
not encrypted. You cannot use password protected keys here. In
the text field, please paste the entire private key, including the
"BEGIN" and "END" lines. Please make sure the according public
key is provided on the target machine. For details, please see
Monit oring via SSH 1962 .

Password This field is only visible if password login is selected above. Enter a
password for the Linux access via SSH and WBEM. Usually, you will
use credentials with administrator privileges.

Private Key This field is only visible if private key login is selected above. Paste
a private key into the field (OpenSSH format, unencrypted). Usually,
you will use credentials with administrator privileges. Note: If you
do not insert a private key for the first time, but change the private
key, you need to restart your PRTG core server service in order for
the private key change to take effect! For details, please see
Monit oring via SSH 1962 .

For WBEM Use Protocol Define the protocol that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ HTTP: Use an unencrypted connection for WBEM.
§ HTTPS: Use an SSL-encrypted connection for WBEM.

For WBEM Use Port Define the port that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ Set aut omat ically (port 5988 or 5989): Use one of the
standard ports, depending on whether unencrypted or encrypted
connection is chosen above.

14.01.2014 215
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

§ Set manually : Use a custom port. Define below.

WBEM Port This setting is only visible if manual port selection is enabled above.
Enter the WBEM port number.

SSH Port Define the port number which will be used for SSH connections.
Note: By default, this setting is automatically used for all SSH
sensors 296 , unless you define a different port number in the sensor
settings.

SSH Rights Elevation Define with which rights the command will be executed on the
target system. Choose between:
§ Run t he command as t he user connect ing (default ): Use the
rights of the user who establishes the SSH connection.
§ Run t he command as anot her user using 'sudo': Use the rights
of another user, for example, the administrator.
§ Run t he command as anot her user using 'su': Use the rights of
another target user.

Target Username This field is only visible if sudo or su is enabled above. Enter a
username to run the specified command as another user than root.
If you leave this field empty, the command will be run as root.
Ensure that you set the Linux password even you use a public/
private key for authentication. This is not necessary if the user is
allowed to execute the command without a password.

Password Target User This field is only visible if su is enabled above. Enter the password
for the specified target user.

Credent ials for VMware/X enServer

User Enter a login name for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

Password Enter a password for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

VMware Protocol Define the protocol used for the connection to VMware and
XenServer. Choose between:
§ HTTPS (recommended): Use an SSL-encrypted connection to
VMware and XenServers.
§ HTTP: Use an unencrypted connection to VMware and
XenServers.

216 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Credent ials for SNMP Devices

SNMP Version Select the SNMP version that will be used for device connection.
Choose between:
§ v1: Use the simple standard v1 protocol for SNMP connections.
This protocol only offers clear-text data transmission, but it is
usually supported by all devices.
§ v2c: Use the more advanced v2c protocol for SNMP connections.
Data is still transferred as clear-text, but it supports 64-bit
counters.
§ v3: Use the latest v3 protocol for SNMP connections. It provides
secure authentication and data encryption.
Note for SNMP v3: Due to internal limitations you can only monitor
a limited number of sensors per second using SNMP v3. The limit is
somewhere between 1 and 50 sensors per second (depending on
the SNMP latency of your network). This means that using an
interval of 60 seconds you are limited to between 60 and 3000
SNMP v3 sensors for each probe. If you experience an increased
"Interval Delay" or "Open Requests" reading of the probe health
sensor, you need to distribute the load over multiple probes. SNMP
v1 and v2 do not have this limitation.

Community String This setting is only visible if SNMP version v1 or v2c are enabled
above. Enter the community string of your devices. This is a kind of
"clear-text password" used for simple authentication. We
recommend using the default value.

Authentication Type This setting is only visible if SNMP version v3 is enabled above.
Choose between:
§ MD5: Use Message-Digest Algorithm 5 (MD5) for authentication.
§ SHA: Use Secure Hash Algorithm (SHA) for authentication.
The chosen type has to match the authentication type of your
device.
Note: If you do not want to use authentication, but you need SNMP
v3, for example, because your device requires context, you can
leave the field password empty. In this case,
SNMP_SEC_LEVEL_NOAUTH will be used and authentication will be
deactivated entirely.

User This setting is only visible if SNMP version v3 is enabled above.


Enter a username for secure authentication. This value has to
match the username of your device.

Password This setting is only visible if SNMP version v3 is enabled above.


Enter a password for secure authentication. This value has to
match the password of your device.

14.01.2014 217
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Credent ials for SNMP Devices

Encryption Type This setting is only visible if SNMP version v3 is enabled above.
Select an encryption type. Choose between:
§ DES: Use Data Encryption Standard (DES) as encryption
algorithm.
§ AES: Use Advanced Encryption Standard (AES) as encryption
algorithm.
The chosen type has to match the encryption type of your device.

Data Encryption Key This setting is only visible if SNMP version v3 is enabled above.
Enter an encryption key here. If you provide a key in this field,
SNMP data packets will be encrypted using the encryption
algorithm selected above, providing increased security. The
provided key here has to match the encryption key of your device.
Note: If the key entered in this field does not match the key
configured in the target SNMP device, you will not get an error
message! Please enter a string or leave the field empty.

Context Name This setting is only visible if SNMP version v3 is enabled above.
Enter a context name only if it is required by the configuration of
the device. Context is a collection of management information
accessible by an SNMP device. Please enter a string.

SNMP Port Enter the port used for SNMP communication. We recommend using
the default value.

SNMP Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

218 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
2 Add a Device

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Click on the Cont inue button to store your settings. If you change tabs or use the main menu,
all changes to the settings will be lost!

14.01.2014 219
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
3 Add a Sensor

6.2.3 Add a Sensor

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

In order to add a sensor manually, select Sensors | Add Sensor from the main menu. An
assistant will appear, leading you through two steps. For faster setup, you can select Add
Sensor... in the context menu 163 of a device to which you want to add the new sensor. This
will skip step 1 and lead you directly to step 2.

§ St ep 1
Please select Add sensor t o an exist ing device and choose a device you want to add the
new sensor to. Click on Cont inue.

Add Sensor Assistant

220 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 2 Create Objects Manually
3 Add a Sensor

§ St ep 2
The Add Sensor assistant is shown (see screenshot above). Select a sensor you want to
add and enter the needed settings. You can filter the listed sensors by type, by target
system, and by the used technology. You can choose one aspect per filter. Alternatively or
additionally, you can use the live search by typing in a key term (or a substring) in the Search
box. PRTG also suggests sensor types to create on the selected device; this
recommendation is automatically calculated based on the current user's sensor usage and
shows the ten commonest sensor types by default (if enough sensor types are already in
use). The chosen filter also applies to the recommendation. See section More if you want to
adjust the number of most used sensor types which are shown here or to hide this option
completely.

For more information about a sensor type, please see the manual section of the respective
sensor. See List of Available Sensor Ty pes 291 section to find detailed information about
every sensor type.

More
Knowledge Base: How can I change the number of entries in most used sensor types?
§ http://kb.paessler.com/en/topic/59788

28.05.2014 221
Part 6: Ajax Web Interface—Device and Sensor Setup | 3 Manage Device Tree

6.3 Manage Device Tree


While viewing the device tree (or parts of it), click on the Management tab to enter a different
tree view which shows your devices and sensors in a less colorful way. While in this view, you
can move monitoring objects using drag&drop in your browser window. You can also view and
edit object settings by selecting it. Changes take effect immediately. When done, leave the
Management tab.

In order to arrange objects in the tree, you have the following options:

Drag&Drop a Sensor

You can either move a sensor within the same device, or clone a sensor to another device.

§ Within the same device, drag any sensor and drop it to the place where you want to have it.
A shade will show the future position. When dropping, the sensor will be moved to this
position and existing sensors will be lined up after it. This is a very easy way to reposition
your sensors.

§ Drag any sensor from one device and drop it on another to clone a sensor. This will create
the same sensor type, with the same settings, on the new device, while maintaining the
original sensor. A shade will show the future position. Note: Cloned sensors are put to
Pause status initially to give you the chance to change any settings before monitoring
begins. Please check the settings 142 and resume 162 monitoring.

Note: You cannot clone 'fixed' objects, such as the root group or a probe device. You cannot
clone the sensor types QoS (Qualit y of Service) One Way Sensor 820 and QoS (Qualit y of
Service) Round Trip Sensor 826 .

Note: In order to clone entire groups or devices, please use the Clone Object 1734 functionality
accessible via the objects' Context Menu 163 .

Drag&Drop a Group or Device

You can change a group's or device's position by using drag&drop.

§ Within the same probe or group, drag any group or device and move it up or down in the
device tree. A small red arrow will appear, showing the future position. When dropping, the
group or device will be moved to this position and existing probes, groups, and devices will
be lined up underneath. This is a very easy way to reposition your groups or devices.

§ Drag any group or device from one probe or group and drop it on another probe or group.
A small red arrow will appear, showing the future position. When dropping, the group or
device will be moved to the new probe or group. Existing groups and devices will be lined
up underneath. This is a very easy way to change the probe a group or device is part of, or
to add groups or devices to other groups.

Note: The Local Probe and Remote Probes cannot be moved.

222 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 3 Manage Device Tree

Multi-Edit Object Properties

You can use Multi-Edit for object settings:

§ Hold down the Ctrl key and select multiple groups, devices, or sensors (one of a kind).
§ In the appearing dialog, select the settings you would like to edit, change the according
values and click on Save. The changes will be applied to all selected objects.

The dialog is the same as described in the Mult i-Edit 1738 (Edit Settings) section.

Related Topics

For other ways to arrange objects, please see

§ Arrange Object s 1733

§ Creat e Device Templat e 1741

§ Clone Object 1734

14.01.2014 223
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

6.4 Root Group Settings


On the Root group's overview page, click on the Set t ings tab to change settings.

The Root Group is Special

The Root group is the highest instance in the object hierarchy of your PRTG setup and parent
to all other objects. Therefore, all objects inherit settings from the Root group. If you define
important settings on this high level, work will be easier later on. So, before you create your
own sensors, it is a good idea to review the Root group's settings to ensure they suit your
network. There are already reasonable presets made with installation.

Note: If necessary, you can override every setting for every single child object later. To do so,
simply disable the respective Inherit option of an object.

Root Group Settings

The following settings are available in the Set t ings tab. As you may not need all of these, just
regard those settings you really need, ignoring the others. All settings you define here can
easily be inherited to all other objects in your setup.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Basic Group Set t ings

Group Name Enter a meaningful name to identify the group. The name will be
shown by default in the devices tree and in all alarms.

Status Define if monitoring for this group is started or paused. Choose


between:
§ St art ed: Monitor this group.
§ Paused: Pause monitoring for this group. All sensors on all
devices in this group will be paused until this setting is changed
again.

224 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Locat ion

Location (for geo When using geo maps using Google's API 1744 please enter a location
maps) in the first line. Objects will then be displayed on a geographical
map with a flag, showing the current status using a color code
similar to the sensor status icons 121 (green - yellow - orange - red).
You can enter a full postal address, city and country only, or
latitude and longitude. It is possible to enter any text before,
between, and after the coordinates, PRTG will parse latitude and
longitude automatically; for example: 49.452778 11.077778 or
enter 49.452778 any 11.077778 text
A minus sign (-) in the first line will hide an object from geo maps. In
this case you can enter location information in line two and
following.
You can define a specific label for each location: enter a string
denoting the label in the first line and provide geo coordinates in
the second line. This object will be displayed then with the label in
PRTG's geo map.

Credent ials for Windows Sy st ems

Domain or Computer Define the authority for Windows access. This is used for Windows
Name Management Instrumentation (WMI) and other Windows sensors. If
you want to use a Windows local user account on the target
device, please enter the computer name here. If you want to use a
Windows domain user account (recommended), please enter the
(Active Directory) domain name here. If not explicitly defined, PRTG
will automatically add a prefix in order to use the NT LAN Manager
(NTLM) protocol. Please do not leave this field empty.

Username Enter the username for Windows access. Usually, you will use
credentials with administrator privileges.

Password Enter the password for Windows access. Usually, you will use
credentials with administrator privileges.

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Username Enter a login name for the access via SSH and WBEM. Usually, you
will use credentials with administrator privileges.

Login Define which authentication method will be used for login. Choose
between:
§ Login via Password: Provide a password for login. Enter below.

14.01.2014 225
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

§ Login via Privat e Key : Provide a private key for authentication.


Note: PRTG can only handle keys in OpenSSH format which are
not encrypted. You cannot use password protected keys here. In
the text field, please paste the entire private key, including the
"BEGIN" and "END" lines. Please make sure the according public
key is provided on the target machine. For details, please see
Monit oring via SSH 1962 .

Password This field is only visible if password login is selected above. Enter a
password for the Linux access via SSH and WBEM. Usually, you will
use credentials with administrator privileges.

Private Key This field is only visible if private key login is selected above. Paste
a private key into the field (OpenSSH format, unencrypted). Usually,
you will use credentials with administrator privileges. Note: If you
do not insert a private key for the first time, but change the private
key, you need to restart your PRTG core server service in order for
the private key change to take effect! For details, please see
Monit oring via SSH 1962 .

For WBEM Use Protocol Define the protocol that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ HTTP: Use an unencrypted connection for WBEM.
§ HTTPS: Use an SSL-encrypted connection for WBEM.

For WBEM Use Port Define the port that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ Set aut omat ically (port 5988 or 5989): Use one of the
standard ports, depending on whether unencrypted or encrypted
connection is chosen above.
§ Set manually : Use a custom port. Define below.

WBEM Port This setting is only visible if manual port selection is enabled above.
Enter the WBEM port number.

SSH Port Define the port number which will be used for SSH connections.
Note: By default, this setting is automatically used for all SSH
sensors 296 , unless you define a different port number in the sensor
settings.

SSH Rights Elevation Define with which rights the command will be executed on the
target system. Choose between:
§ Run t he command as t he user connect ing (default ): Use the
rights of the user who establishes the SSH connection.

226 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

§ Run t he command as anot her user using 'sudo': Use the rights
of another user, for example, the administrator.
§ Run t he command as anot her user using 'su': Use the rights of
another target user.

Target Username This field is only visible if sudo or su is enabled above. Enter a
username to run the specified command as another user than root.
If you leave this field empty, the command will be run as root.
Ensure that you set the Linux password even you use a public/
private key for authentication. This is not necessary if the user is
allowed to execute the command without a password.

Password Target User This field is only visible if su is enabled above. Enter the password
for the specified target user.

Credent ials for VMware/X enServer

User Enter a login name for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

Password Enter a password for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

VMware Protocol Define the protocol used for the connection to VMware and
XenServer. Choose between:
§ HTTPS (recommended): Use an SSL-encrypted connection to
VMware and XenServers.
§ HTTP: Use an unencrypted connection to VMware and
XenServers.

Credent ials for SNMP Devices

SNMP Version Select the SNMP version that will be used for device connection.
Choose between:
§ v1: Use the simple standard v1 protocol for SNMP connections.
This protocol only offers clear-text data transmission, but it is
usually supported by all devices.
§ v2c: Use the more advanced v2c protocol for SNMP connections.
Data is still transferred as clear-text, but it supports 64-bit
counters.
§ v3: Use the latest v3 protocol for SNMP connections. It provides
secure authentication and data encryption.

14.01.2014 227
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Credent ials for SNMP Devices

Note for SNMP v3: Due to internal limitations you can only monitor
a limited number of sensors per second using SNMP v3. The limit is
somewhere between 1 and 50 sensors per second (depending on
the SNMP latency of your network). This means that using an
interval of 60 seconds you are limited to between 60 and 3000
SNMP v3 sensors for each probe. If you experience an increased
"Interval Delay" or "Open Requests" reading of the probe health
sensor, you need to distribute the load over multiple probes. SNMP
v1 and v2 do not have this limitation.

Community String This setting is only visible if SNMP version v1 or v2c are enabled
above. Enter the community string of your devices. This is a kind of
"clear-text password" used for simple authentication. We
recommend using the default value.

Authentication Type This setting is only visible if SNMP version v3 is enabled above.
Choose between:
§ MD5: Use Message-Digest Algorithm 5 (MD5) for authentication.
§ SHA: Use Secure Hash Algorithm (SHA) for authentication.
The chosen type has to match the authentication type of your
device.
Note: If you do not want to use authentication, but you need SNMP
v3, for example, because your device requires context, you can
leave the field password empty. In this case,
SNMP_SEC_LEVEL_NOAUTH will be used and authentication will be
deactivated entirely.

User This setting is only visible if SNMP version v3 is enabled above.


Enter a username for secure authentication. This value has to
match the username of your device.

Password This setting is only visible if SNMP version v3 is enabled above.


Enter a password for secure authentication. This value has to
match the password of your device.

Encryption Type This setting is only visible if SNMP version v3 is enabled above.
Select an encryption type. Choose between:
§ DES: Use Data Encryption Standard (DES) as encryption
algorithm.
§ AES: Use Advanced Encryption Standard (AES) as encryption
algorithm.
The chosen type has to match the encryption type of your device.

228 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Credent ials for SNMP Devices

Data Encryption Key This setting is only visible if SNMP version v3 is enabled above.
Enter an encryption key here. If you provide a key in this field,
SNMP data packets will be encrypted using the encryption
algorithm selected above, providing increased security. The
provided key here has to match the encryption key of your device.
Note: If the key entered in this field does not match the key
configured in the target SNMP device, you will not get an error
message! Please enter a string or leave the field empty.

Context Name This setting is only visible if SNMP version v3 is enabled above.
Enter a context name only if it is required by the configuration of
the device. Context is a collection of management information
accessible by an SNMP device. Please enter a string.

SNMP Port Enter the port used for SNMP communication. We recommend using
the default value.

SNMP Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Windows Compat ibilit y Opt ions

When experiencing problems while monitoring via Windows sensors, you can set some
compatibility options for trouble shooting.

Preferred Data Source Define the method Windows sensors will use to query data. This
setting is valid only for hybrid sensors offering performance
counter and Windows Management Instrumentation (WMI)
technology. The setting will be ignored for all other sensors!
Choose between:
§ Performance Count ers and fallback t o WMI (recommended):
Try to query data via performance counters. If this is not possible,
establish a connection via WMI. This is the recommended setting
to best balance resource usage and functionality.
§ Performance Count ers only : Query data via performance
counters only. If this is not possible, a sensor will return no data.
§ WMI only : Query data via WMI only. If this is not possible, a
sensor will return no data.

Timeout Method Specify the time the sensor will wait for the return of its WMI query
before aborting it with an error message. Choose between:

14.01.2014 229
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Windows Compat ibilit y Opt ions

§ Use 1.5x scanning int erval (recommended): Use a default of


one and a half times the scanning interval set for the sensor (see
below in this settings).
§ Set manually : Enter a timeout value manually.
We recommend using the default value. Only if you experience
ongoing timeout errors, try increasing the timeout value.

Timeout Value (Sec.) This field is only visible if the manual timeout method is selected
above. Specify the time the sensor will wait for the return of its
WMI query before aborting with an error message. Please enter an
integer value.

SNMP Compat ibilit y Opt ions

When experiencing problems while monitoring via Simple Network Management Protocol
(SNMP) sensors, you can set some compatibility options for trouble shooting.

SNMP Delay (ms) Add a time in milliseconds that will be waited between two SNMP
requests. This can help increase device compatibility. Please enter
an integer value. We recommend using the default value. If you
experience SNMP connection failures, please increase it. You can
define a delay between 0 and 100, higher delays are not supported
and will be discarded.

Failed Requests Define if an SNMP sensor will try again after a request fails.
§ Ret ry (recommended): Try again if an SNMP request fails. This
can help prevent false error messages due to temporary timeout
failures.
§ Do not ret ry : Do not retry if an SNMP request fails. With this
setting enabled an SNMP sensor will be set to error status earlier.

Overflow Values Define how PRTG will handle overflow values. Some devices do not
handle internal buffer overflows correctly. This can cause false
peaks.
§ Ignore overflow values (recommended): Ignore overflow
values and do not include them in the monitoring data.
§ Handle overflow values as valid result s: Regard all overflow
values as regular data and include them in the monitoring data.
We recommend using the default value. If you experience problems,
change this option.

Zero Values Define how PRTG will handle zero values. Some devices send
incorrect zero values. This can cause false peaks.

230 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

SNMP Compat ibilit y Opt ions

§ Ignore zero values for delt a sensors (recommended): Ignore


zero values and do not include them in the monitoring data.
§ Handle zero values as valid result s for delt a sensors: Regard
all zero values as regular data and include them in the monitoring
data.
We recommend using the default value. If you experience problems,
change this option.

32-bit/64-bit Counters Define which kind of traffic counters PRTG will search for on a
device.
§ Use 64-bit count ers if available (recommended): The interface
scan will use 64-bit traffic counters, if available. This can avoid
buffer overflows in the devices.
§ Use 32-bit count ers only : The interface scan will always use 32-
bit traffic counters, even if 64-bit counters are available. This can
lead to more reliable monitoring for some devices.
We recommend using the default value. If you experience problems,
change this option.

Request Mode Define which kind of request method PRTG uses for SNMP sensors.
§ Use mult i get (recommended): Bundle multiple SNMP requests
into one request.
§ Use single get : Use one request for each SNMP value. This can
increase compatibility with older devices.
We recommend using the default value. If you experience problems,
change this option.

Port Name Template Define how the name of SNMP sensors created on a device will be
put together. Enter a template using several variables. When adding
new sensors, PRTG scans the interface for available counters at
certain OIDs. At each OID usually several fields are available with
interface descriptions. They are different for every device/OID.
PRTG will use the information in these fields to name the sensors. If
a field is empty or not available, an empty string is added to the
name. As default, ([port ]) [ifalias] is set as port name template,
which will create a name such as (001) Ethernet1, for example. You
can use any field names available at a certain OID of your device,
among which are:
§ [port ]: The port number of the monitored interface.
§ [ifalias]: The 'alias' name for the monitored interface as specified
by a network manager, providing a non-volatile handling.
§ [ifname]: The textual name of the monitored interface as
assigned by the local device.

14.01.2014 231
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

SNMP Compat ibilit y Opt ions

§ [ifindex]: A unique value, greater than zero, for the monitored


interface.
§ [ifdescr]: A textual string containing information about the
monitored device or interface, for example, manufacturer,
product name, version.
§ [ifspeed]: An estimate of the monitored interface's current
bandwidth (KBit/s).
Combine them as you like to obtain suitable sensor names. See
the More section below for more information about SNMP sensor
names.

Port Name Update Define how PRTG will react if you change port names in your
physical device (e.g. a switch or router). Choose between:
§ Keep port names (use t his if y ou edit t he names in PRTG): Do
not automatically adjust sensor names. This is the best option if
you want to change names in PRTG manually.
§ Aut omat ic sensor name updat e if name changes in device: If
PRTG detects changes of port names in your physical device, it
will try to automatically adjust sensor names accordingly. For
detailed information please see More section below.

Port Identification Define which field will be used for SNMP interface identification.
Choose between:
§ Aut omat ic (recommended): Tries the ifAlias field first to identify
an SNMP interface and then ifDescr. Note: ifName will not be tried
automatically.
§ Use ifAlias: For most devices ifAlias is the best field to get
unique interface names.
§ Use ifDescr: Use this option if the port order of your device
changes after a reboot, and there is no ifAlias field available. For
example, this is the best option for Cisco ASA devices. Note:
When using this option it is important that your device returns
unique interface names in the ifDescr field.
§ Use ifName: You can also use this option if there is no unique
ifAlias available. Note: When using this option it is important that
your device returns unique interface names in the ifName field.
§ No Port Updat e: Use this option to disable automatic port
identification.

Start Port For SNMP Traffic sensors, define at which port number PRTG will
start to create sensors. Use 0 for automatic. We recommend using
the default value.

232 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

SNMP Compat ibilit y Opt ions

End Port For SNMP Traffic sensors, define at which port number PRTG will
stop to create sensors. Use 0 for automatic. We recommend using
the default value.

SNMP Debug Log Define if you want to create an SNMP log file for debugging
purposes. This is only recommended for debugging low level SNMP
issues. Choose between:
§ No log (recommended): No SNMP debug log file will be created.
§ Enable debug log: An SNMP log file is written to the Logs
(Debug) directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

14.01.2014 233
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to pause
monitoring for a certain time span (days, hours) throughout the
week. You can create new schedules and edit existing ones in the
account settings 1817 . Note: Schedules are generally inherited. New
schedules will be added to existing ones, so all schedules are
active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency settings are available only in Probe Settings 238 , Group Settings 253 , Device
Settings 272 , and Sensor Settings 290 .

234 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

14.01.2014 235
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

Aut omat ic Monit oring Dat a Analy sis

Unusual Detection Define if unusual detection is enabled for sensors. You can
configure the behavior of unusual detection (or disable it
completely) in the system settings 1839 .
§ Enabled: Enable unusual detection for this group. Sensors in this
group will turn to orange color if unusual activity is detected.
§ Disabled: Disable unusual detection for this group. Unusual
values will be ignored for sensors in this group; they will not
show an unusual sensor status.

Similar Sensors Define if similar sensors detection is enabled for sensors. You can
Detection configure the depth of analysis of similar sensors detection (or
disable it completely) in the system settings 1840 .
§ Enabled: Enable similar sensors detection for this group.
Sensors in this group will be considered during similarity analysis.
§ Disabled: Disable similar detection for this group. Sensors in this
group will not be taken into account during similarity analysis.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Notifications

The status or the data of a sensor can trigger notifications. Using this mechanism, you can
configure external alerting tailored to you needs. In an object's detail page, click on the
Not ificat ions tab to change sensor notification triggers. The defined triggers will be inherited
down to sensor level. For detailed information, please see Sensor Not ificat ions Set t ings 1716
section.

Others

For more general information about settings, please see Object Set t ings 142 section.

More
Knowledge Base: How does PRTG compute CPU Index, Traffic Index and Response Time Index?
§ http://kb.paessler.com/en/topic/313

Knowledge Base: How can I add my own device icons for use in the PRTG web interface?
§ http://kb.paessler.com/en/topic/7313

Knowledge Base: How can I change the defaults for names automatically generated for new
SNMP sensors?

236 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 4 Root Group Settings

§ http://kb.paessler.com/en/topic/7363

Knowledge Base: Automatically update port name and number for SNMP Traffic sensors when
the device changes them
§ http://kb.paessler.com/en/topic/25893

14.01.2014 237
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

6.5 Probe Settings


On a probe's overview page, click on the Set t ings tab to change settings.

Add Remote Probe

You can add additional remote probes to your setup to extend you monitoring to networks
that are not directly reachable by your PRTG core installation or cluster.

See Add Remot e Probe 2049 section for more details.

Probe Settings

The following settings are available in the Set t ings tab of every probe. As you may not need
all of these for every probe, just regard those settings you really need, ignoring the others.

We recommend defining as many settings as possible in the Root 224 group, so you can inherit
them to all other objects further down in the tree hierarchy.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Basic Probe Set t ings

Probe Name Enter a meaningful name to identify the probe. The name will be
shown by default in the devices tree and in all alarms.

Tags Enter one or more tags; confirm each tag by hitting space, comma,
or enter key. You can use tags to group objects and use tag-
filtered views later on. Tags are not case sensitive.

Status Choose if monitoring for this probe is started or paused.


§ St art ed: Monitor this probe.
§ Paused: Pause monitoring for this probe. All sensors on all
devices on this probe will be paused until this setting is changed
again.

Priority Select a priority for the probe. This setting determines where the
probe will be placed in list views. Top priority will be at the top of a
list. You can choose from one star (low priority) to five stars (top
priority).

238 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Locat ion

Location (for geo When using geo maps using Google's API 1744 please enter a location
maps) in the first line. Objects will then be displayed on a geographical
map with a flag, showing the current status using a color code
similar to the sensor status icons 121 (green - yellow - orange - red).
You can enter a full postal address, city and country only, or
latitude and longitude. It is possible to enter any text before,
between, and after the coordinates, PRTG will parse latitude and
longitude automatically; for example: 49.452778 11.077778 or
enter 49.452778 any 11.077778 text
A minus sign (-) in the first line will hide an object from geo maps. In
this case you can enter location information in line two and
following.
You can define a specific label for each location: enter a string
denoting the label in the first line and provide geo coordinates in
the second line. This object will be displayed then with the label in
PRTG's geo map.

Credent ials for Windows Sy st ems

Domain or Computer Define the authority for Windows access. This is used for Windows
Name Management Instrumentation (WMI) and other Windows sensors. If
you want to use a Windows local user account on the target
device, please enter the computer name here. If you want to use a
Windows domain user account (recommended), please enter the
(Active Directory) domain name here. If not explicitly defined, PRTG
will automatically add a prefix in order to use the NT LAN Manager
(NTLM) protocol. Please do not leave this field empty.

Username Enter the username for Windows access. Usually, you will use
credentials with administrator privileges.

Password Enter the password for Windows access. Usually, you will use
credentials with administrator privileges.

14.01.2014 239
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Username Enter a login name for the access via SSH and WBEM. Usually, you
will use credentials with administrator privileges.

Login Define which authentication method will be used for login. Choose
between:
§ Login via Password: Provide a password for login. Enter below.
§ Login via Privat e Key : Provide a private key for authentication.
Note: PRTG can only handle keys in OpenSSH format which are
not encrypted. You cannot use password protected keys here. In
the text field, please paste the entire private key, including the
"BEGIN" and "END" lines. Please make sure the according public
key is provided on the target machine. For details, please see
Monit oring via SSH 1962 .

Password This field is only visible if password login is selected above. Enter a
password for the Linux access via SSH and WBEM. Usually, you will
use credentials with administrator privileges.

Private Key This field is only visible if private key login is selected above. Paste
a private key into the field (OpenSSH format, unencrypted). Usually,
you will use credentials with administrator privileges. Note: If you
do not insert a private key for the first time, but change the private
key, you need to restart your PRTG core server service in order for
the private key change to take effect! For details, please see
Monit oring via SSH 1962 .

For WBEM Use Protocol Define the protocol that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ HTTP: Use an unencrypted connection for WBEM.
§ HTTPS: Use an SSL-encrypted connection for WBEM.

For WBEM Use Port Define the port that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ Set aut omat ically (port 5988 or 5989): Use one of the
standard ports, depending on whether unencrypted or encrypted
connection is chosen above.
§ Set manually : Use a custom port. Define below.

WBEM Port This setting is only visible if manual port selection is enabled above.
Enter the WBEM port number.

SSH Port Define the port number which will be used for SSH connections.
Note: By default, this setting is automatically used for all SSH
sensors 296 , unless you define a different port number in the sensor
settings.

240 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

SSH Rights Elevation Define with which rights the command will be executed on the
target system. Choose between:
§ Run t he command as t he user connect ing (default ): Use the
rights of the user who establishes the SSH connection.
§ Run t he command as anot her user using 'sudo': Use the rights
of another user, for example, the administrator.
§ Run t he command as anot her user using 'su': Use the rights of
another target user.

Target Username This field is only visible if sudo or su is enabled above. Enter a
username to run the specified command as another user than root.
If you leave this field empty, the command will be run as root.
Ensure that you set the Linux password even you use a public/
private key for authentication. This is not necessary if the user is
allowed to execute the command without a password.

Password Target User This field is only visible if su is enabled above. Enter the password
for the specified target user.

Credent ials for VMware/X enServer

User Enter a login name for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

Password Enter a password for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

VMware Protocol Define the protocol used for the connection to VMware and
XenServer. Choose between:
§ HTTPS (recommended): Use an SSL-encrypted connection to
VMware and XenServers.
§ HTTP: Use an unencrypted connection to VMware and
XenServers.

Credent ials for SNMP Devices

SNMP Version Select the SNMP version that will be used for device connection.
Choose between:
§ v1: Use the simple standard v1 protocol for SNMP connections.
This protocol only offers clear-text data transmission, but it is
usually supported by all devices.

14.01.2014 241
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Credent ials for SNMP Devices

§ v2c: Use the more advanced v2c protocol for SNMP connections.
Data is still transferred as clear-text, but it supports 64-bit
counters.
§ v3: Use the latest v3 protocol for SNMP connections. It provides
secure authentication and data encryption.
Note for SNMP v3: Due to internal limitations you can only monitor
a limited number of sensors per second using SNMP v3. The limit is
somewhere between 1 and 50 sensors per second (depending on
the SNMP latency of your network). This means that using an
interval of 60 seconds you are limited to between 60 and 3000
SNMP v3 sensors for each probe. If you experience an increased
"Interval Delay" or "Open Requests" reading of the probe health
sensor, you need to distribute the load over multiple probes. SNMP
v1 and v2 do not have this limitation.

Community String This setting is only visible if SNMP version v1 or v2c are enabled
above. Enter the community string of your devices. This is a kind of
"clear-text password" used for simple authentication. We
recommend using the default value.

Authentication Type This setting is only visible if SNMP version v3 is enabled above.
Choose between:
§ MD5: Use Message-Digest Algorithm 5 (MD5) for authentication.
§ SHA: Use Secure Hash Algorithm (SHA) for authentication.
The chosen type has to match the authentication type of your
device.
Note: If you do not want to use authentication, but you need SNMP
v3, for example, because your device requires context, you can
leave the field password empty. In this case,
SNMP_SEC_LEVEL_NOAUTH will be used and authentication will be
deactivated entirely.

User This setting is only visible if SNMP version v3 is enabled above.


Enter a username for secure authentication. This value has to
match the username of your device.

Password This setting is only visible if SNMP version v3 is enabled above.


Enter a password for secure authentication. This value has to
match the password of your device.

Encryption Type This setting is only visible if SNMP version v3 is enabled above.
Select an encryption type. Choose between:
§ DES: Use Data Encryption Standard (DES) as encryption
algorithm.

242 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Credent ials for SNMP Devices

§ AES: Use Advanced Encryption Standard (AES) as encryption


algorithm.
The chosen type has to match the encryption type of your device.

Data Encryption Key This setting is only visible if SNMP version v3 is enabled above.
Enter an encryption key here. If you provide a key in this field,
SNMP data packets will be encrypted using the encryption
algorithm selected above, providing increased security. The
provided key here has to match the encryption key of your device.
Note: If the key entered in this field does not match the key
configured in the target SNMP device, you will not get an error
message! Please enter a string or leave the field empty.

Context Name This setting is only visible if SNMP version v3 is enabled above.
Enter a context name only if it is required by the configuration of
the device. Context is a collection of management information
accessible by an SNMP device. Please enter a string.

SNMP Port Enter the port used for SNMP communication. We recommend using
the default value.

SNMP Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Windows Compat ibilit y Opt ions

When experiencing problems while monitoring via Windows sensors, you can set some
compatibility options for trouble shooting.

Preferred Data Source Define the method Windows sensors will use to query data. This
setting is valid only for hybrid sensors offering performance
counter and Windows Management Instrumentation (WMI)
technology. The setting will be ignored for all other sensors!
Choose between:
§ Performance Count ers and fallback t o WMI (recommended):
Try to query data via performance counters. If this is not possible,
establish a connection via WMI. This is the recommended setting
to best balance resource usage and functionality.
§ Performance Count ers only : Query data via performance
counters only. If this is not possible, a sensor will return no data.
§ WMI only : Query data via WMI only. If this is not possible, a
sensor will return no data.

14.01.2014 243
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Windows Compat ibilit y Opt ions

Timeout Method Specify the time the sensor will wait for the return of its WMI query
before aborting it with an error message. Choose between:
§ Use 1.5x scanning int erval (recommended): Use a default of
one and a half times the scanning interval set for the sensor (see
below in this settings).
§ Set manually : Enter a timeout value manually.
We recommend using the default value. Only if you experience
ongoing timeout errors, try increasing the timeout value.

Timeout Value (Sec.) This field is only visible if the manual timeout method is selected
above. Specify the time the sensor will wait for the return of its
WMI query before aborting with an error message. Please enter an
integer value.

SNMP Compat ibilit y Opt ions

When experiencing problems while monitoring via Simple Network Management Protocol
(SNMP) sensors, you can set some compatibility options for trouble shooting.

SNMP Delay (ms) Add a time in milliseconds that will be waited between two SNMP
requests. This can help increase device compatibility. Please enter
an integer value. We recommend using the default value. If you
experience SNMP connection failures, please increase it. You can
define a delay between 0 and 100, higher delays are not supported
and will be discarded.

Failed Requests Define if an SNMP sensor will try again after a request fails.
§ Ret ry (recommended): Try again if an SNMP request fails. This
can help prevent false error messages due to temporary timeout
failures.
§ Do not ret ry : Do not retry if an SNMP request fails. With this
setting enabled an SNMP sensor will be set to error status earlier.

Overflow Values Define how PRTG will handle overflow values. Some devices do not
handle internal buffer overflows correctly. This can cause false
peaks.
§ Ignore overflow values (recommended): Ignore overflow
values and do not include them in the monitoring data.
§ Handle overflow values as valid result s: Regard all overflow
values as regular data and include them in the monitoring data.
We recommend using the default value. If you experience problems,
change this option.

244 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

SNMP Compat ibilit y Opt ions

Zero Values Define how PRTG will handle zero values. Some devices send
incorrect zero values. This can cause false peaks.
§ Ignore zero values for delt a sensors (recommended): Ignore
zero values and do not include them in the monitoring data.
§ Handle zero values as valid result s for delt a sensors: Regard
all zero values as regular data and include them in the monitoring
data.
We recommend using the default value. If you experience problems,
change this option.

32-bit/64-bit Counters Define which kind of traffic counters PRTG will search for on a
device.
§ Use 64-bit count ers if available (recommended): The interface
scan will use 64-bit traffic counters, if available. This can avoid
buffer overflows in the devices.
§ Use 32-bit count ers only : The interface scan will always use 32-
bit traffic counters, even if 64-bit counters are available. This can
lead to more reliable monitoring for some devices.
We recommend using the default value. If you experience problems,
change this option.

Request Mode Define which kind of request method PRTG uses for SNMP sensors.
§ Use mult i get (recommended): Bundle multiple SNMP requests
into one request.
§ Use single get : Use one request for each SNMP value. This can
increase compatibility with older devices.
We recommend using the default value. If you experience problems,
change this option.

Port Name Template Define how the name of SNMP sensors created on a device will be
put together. Enter a template using several variables. When adding
new sensors, PRTG scans the interface for available counters at
certain OIDs. At each OID usually several fields are available with
interface descriptions. They are different for every device/OID.
PRTG will use the information in these fields to name the sensors. If
a field is empty or not available, an empty string is added to the
name. As default, ([port ]) [ifalias] is set as port name template,
which will create a name such as (001) Ethernet1, for example. You
can use any field names available at a certain OID of your device,
among which are:
§ [port ]: The port number of the monitored interface.
§ [ifalias]: The 'alias' name for the monitored interface as specified
by a network manager, providing a non-volatile handling.

14.01.2014 245
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

SNMP Compat ibilit y Opt ions

§ [ifname]: The textual name of the monitored interface as


assigned by the local device.
§ [ifindex]: A unique value, greater than zero, for the monitored
interface.
§ [ifdescr]: A textual string containing information about the
monitored device or interface, for example, manufacturer,
product name, version.
§ [ifspeed]: An estimate of the monitored interface's current
bandwidth (KBit/s).
Combine them as you like to obtain suitable sensor names. See
the More section below for more information about SNMP sensor
names.

Port Name Update Define how PRTG will react if you change port names in your
physical device (e.g. a switch or router). Choose between:
§ Keep port names (use t his if y ou edit t he names in PRTG): Do
not automatically adjust sensor names. This is the best option if
you want to change names in PRTG manually.
§ Aut omat ic sensor name updat e if name changes in device: If
PRTG detects changes of port names in your physical device, it
will try to automatically adjust sensor names accordingly. For
detailed information please see More section below.

Port Identification Define which field will be used for SNMP interface identification.
Choose between:
§ Aut omat ic (recommended): Tries the ifAlias field first to identify
an SNMP interface and then ifDescr. Note: ifName will not be tried
automatically.
§ Use ifAlias: For most devices ifAlias is the best field to get
unique interface names.
§ Use ifDescr: Use this option if the port order of your device
changes after a reboot, and there is no ifAlias field available. For
example, this is the best option for Cisco ASA devices. Note:
When using this option it is important that your device returns
unique interface names in the ifDescr field.
§ Use ifName: You can also use this option if there is no unique
ifAlias available. Note: When using this option it is important that
your device returns unique interface names in the ifName field.
§ No Port Updat e: Use this option to disable automatic port
identification.

246 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

SNMP Compat ibilit y Opt ions

Start Port For SNMP Traffic sensors, define at which port number PRTG will
start to create sensors. Use 0 for automatic. We recommend using
the default value.

End Port For SNMP Traffic sensors, define at which port number PRTG will
stop to create sensors. Use 0 for automatic. We recommend using
the default value.

SNMP Debug Log Define if you want to create an SNMP log file for debugging
purposes. This is only recommended for debugging low level SNMP
issues. Choose between:
§ No log (recommended): No SNMP debug log file will be created.
§ Enable debug log: An SNMP log file is written to the Logs
(Debug) directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

14.01.2014 247
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Clust er Usage

Scanning Distribution This box is only visible if you're running a PRTG cluster. Sometimes
you want to exclude a certain node from monitoring the sensors
running on this probe, group, or device, for example, if a device is
not reachable from every node configured in your cluster. In the list
of cluster nodes, please select the nodes that will not be included
in sensor scans. By default, this setting is inherited 87 to all objects
underneath.

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to pause
monitoring for a certain time span (days, hours) throughout the
week. You can create new schedules and edit existing ones in the
account settings 1817 . Note: Schedules are generally inherited. New
schedules will be added to existing ones, so all schedules are
active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance Ends At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

248 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current object if its parent object is in a
Down status, or if it is paused by another dependency.
§ Select object : Pause the current object if its parent object is in
a Down status, or if it is paused by another dependency.
Additionally, pause the current object if a specific other object in
the device tree is in a Down status, or if it is paused by another
dependency. Select below.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current object will be dependent
on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds.

14.01.2014 249
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

250 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

Aut omat ic Monit oring Dat a Analy sis

Unusual Detection Define if unusual detection is enabled for sensors. You can
configure the behavior of unusual detection (or disable it
completely) in the system settings 1839 .
§ Enabled: Enable unusual detection for this group. Sensors in this
group will turn to orange color if unusual activity is detected.
§ Disabled: Disable unusual detection for this group. Unusual
values will be ignored for sensors in this group; they will not
show an unusual sensor status.

Similar Sensors Define if similar sensors detection is enabled for sensors. You can
Detection configure the depth of analysis of similar sensors detection (or
disable it completely) in the system settings 1840 .
§ Enabled: Enable similar sensors detection for this group.
Sensors in this group will be considered during similarity analysis.
§ Disabled: Disable similar detection for this group. Sensors in this
group will not be taken into account during similarity analysis.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Notifications

The status or the data of a sensor can trigger notifications. Using this mechanism, you can
configure external alerting tailored to you needs. In an object's detail page, click on the
Not ificat ions tab to change sensor notification triggers. The defined triggers will be inherited
down to sensor level. For detailed information, please see Sensor Not ificat ions Set t ings 1716
section.

Others

For more general information about settings, please see Object Set t ings 142 section.

More
Knowledge Base: How does PRTG compute CPU Index, Traffic Index and Response Time Index?
§ http://kb.paessler.com/en/topic/313

Knowledge Base: How can I add my own device icons for use in the PRTG web interface?
§ http://kb.paessler.com/en/topic/7313

Knowledge Base: How can I change the defaults for names automatically generated for new
SNMP sensors?

14.01.2014 251
Part 6: Ajax Web Interface—Device and Sensor Setup | 5 Probe Settings

§ http://kb.paessler.com/en/topic/7363

Knowledge Base: Automatically update port name and number for SNMP Traffic sensors when
the device changes them
§ http://kb.paessler.com/en/topic/25893

252 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

6.6 Group Settings


On a group's overview page, click on the Set t ings tab to change settings.

Add Group

The Add Group dialog appears when adding a new group to a parent group. It only shows the
setting fields that are imperative for creating the group. Therefore, you will not see all setting
fields in this dialog. For example, the Group St at us option is not available in this step.

You can change all settings in the group's Set t ings tab later.

Group Settings

The following settings are available in the Set t ings tab of every group. As you may not need
all of these for every group, just regard those settings you really need, ignoring the others.

Note: This documentation does not refer to the setting of the special Root group. The
settings available there differ from those described here.

We recommend defining as many settings as possible in the Root 224 group, so you can inherit
them to all other objects further down in the tree hierarchy.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Basic Group Set t ings

Group Name Enter a meaningful name to identify the group. The name will be
shown by default in the devices tree and in all alarms.

Status Choose if monitoring for this group is started or paused. .We


recommend using the default value. You can add additional tags to
it, if you like.
§ St art ed: Monitor this group.
§ Paused: Pause monitoring for this group. All sensors on all
devices in this group will be paused until this setting is changed
again.

Tags Enter one or more tags; confirm each tag by hitting space, comma,
or enter key. You can use tags to group objects and use tag-
filtered views later on. Tags are not case sensitive.

14.01.2014 253
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Basic Group Set t ings

Priority Select a priority for the group. This setting determines where the
group will be placed in list views. Top priority will be at the top of a
list. You can choose from one star (low priority) to five stars (top
priority).

Group Ty pe

Sensor Management Select which type of auto-discovery you would like to perform for
this group. Choose between:
§ Manual (no aut o-discovery ): Do not auto-discover any sensors,
but only add sensors manually.
§ Aut omat ic device ident ificat ion (st andard, recommended):
Use a small set of auto-discovery templates. This will scan your
LAN and usually create a view standard sensors on your device.
§ Aut omat ic device ident ificat ion (det ailed, may creat e many
sensors: Use an extended set of auto-discovery templates. This
will scan your LAN and usually create many sensors on your
device.
§ Aut omat ic sensor creat ion using specific device t emplat es:
Use specific auto-discovery templates only. Please select
templates below. This will scan your LAN and add sensors
defined in the template.

Device Template(s) This option is only visible if using specific device templates (last
option) is enabled above. Please choose one or more templates by
adding a check mark in front of the respective template name. You
can also select and deselect all items by using the check box in the
table head. These will be used for auto-discovery on the current
device. Choose from:
§ ADSL
§ Cisco ASA VPN
§ Cisco Device (Generic)
§ Dell MDI
§ DNS Server
§ Environment Jacart a
§ Environment Poseidon
§ Frit zbox
§ FTP Server
§ Generic Device (PING only )

254 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

§ Generic Device (SNMP-enabled)


§ Generic Device (SNMP-enabled, Det ailed)
§ HTTP Web Server
§ Hy per V Host Server
§ Linux/UNIX Device (SNMP or SSH enabled)
§ Mail Server (Generic)
§ Mail Server (MS Exchange)
§ Microsoft Sharepoint 2010
§ NAS LenovoEMC
§ NAS QNAP
§ NAS Sy nology
§ Net App
§ NTP Server
§ Print er (HP)
§ RDP Server
§ RMON compat ible device
§ Server (Compaq/HP agent s)
§ Server (Dell)
§ Sever Cisco UCS
§ Server IBM
§ SonicWALL
§ Swit ch (Cisco Cat aly st )
§ Swit ch (Cisco IOS Based)
§ Swit ch (HP Procurve)
§ UNIX /Linux Device
§ UPS (APC)
§ Virt uozzo Server
§ VMware ESX / vCent er Server
§ Windows (Det ailed via WMI)
§ Windows (via Remot e Powershell)
§ Windows (via WMI)
§ Windows IIS (via SNMP)
§ X EN Host s

14.01.2014 255
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

§ X EN Virt ual Machines

Once the auto-discovery is finished, PRTG will create a new ticket


149 and list the device templates which were actually used to

create new sensors. Templates which were not applied will not be
shown in the ticket.

Discovery Schedule Define when the auto-discovery will be run. Choose between:
§ Once: Perform auto-discovery only once. New devices and
sensors will be added once. You can run auto-discovery manually
any time using an object's context menu 163 .
§ Hourly : Perform auto-discovery for new devices and sensors
every 60 minutes. Note: Please use this option with caution!
Frequently executed auto-discoveries might cause performance
issues, especially when large network segments are scanned
every hour.
§ Daily : Perform auto-discovery for new devices and sensors every
24 hours. The first auto-discovery will run immediately, all other
discoveries will start on the time defined in the Aut o-Discovery
Set t ings section of the Sy st em Administ rat ion—Monit oring
1841 settings.

§ Weekly : Perform auto-discovery for new devices and sensors


every 7 days. The first auto-discovery will run immediately, all
other discoveries will start on the time defined in the Aut o-
Discovery Set t ings section of the Sy st em Administ rat ion—
Monit oring 1841 settings.

IP Selection Method Define how you want to define the IP range for auto-discovery.
Choose between:
§ Class C base IP wit h st art /end (IPv4): Define an IPv4 class C
address range.
§ List of individual IPs and DNS names (IPv4): Enter a list of
individual IPv4 addresses or DNS names.
§ IP and Subnet (IPv4): Enter an IPv4 address and subnet mask.
§ IP wit h oct et range (IPv4): Enter an IPv4 address range for every
IP octet individually. With this, you can define very customizable IP
ranges.
§ List of individual IPs and DNS names (IPv6): Enter a list of
individual IPv6 addresses or DNS names.
§ Use comput ers from t he act ive direct ory (maximum 1000
comput ers): Search in the active directory for computers to
perform auto-discovery.
Note: Only subnets with up to 65,536 IP addresses can be
discovered! If you define a range with a higher number of
addresses, discovery will stop before it is completed.

256 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

IPv4 Base This field is only visible if Class C network detection is selected
above. Enter a class C network as IP base for the auto-discovery.
Enter the first three octets of an IPv4 IP address, for example,
192.168.0

IPv4 Range Start This field is only visible if Class C network detection is selected
above. Enter the IP octet of the class C network specified above
from which PRTG will start the auto-discovery. This will complete
the IP base above to an IPv4 address. For example, enter 1 to
discover from 192.168.0.1.

IPv4 Range End This field is only visible if Class C network detection is selected
above. Enter the IP octet of the class C network specified above at
which PRTG will stop the auto-discovery. This will complete the IP
base above to an IPv4 address. For example, enter 254 to discover
up to 192.168.0.254.

IPv4/DNS Name List This field is only visible if the IP list option is selected above. Enter a
IPv6/DNS Name List list of IP addresses or DNS names which the auto-discovery will
scan. Enter each address in a separate line.

IPv4 and Subnet (IPv4) This field is only visible if the IP and subnet option is selected
above. Enter an expression in the format address/subnet , e.g.
192.168.3.0/255.255.255.0. You can also use the short form like
192.168.3.0/24 in this example. PRTG will scan the complete host
range (without network and broadcast address) defined by the IP
address and the subnet mask.

IP with Octet Range This field is only visible if the octet range option is selected above.
Enter an expression in the format a1.a2.a3.a4, where a1, a2, a3,
and a4 are each a number between 0-255, or a range with two
numbers and a hyphen like 1-127. All permutations of all ranges are
calculated, e.g. 10.0.1-10.1-100 results in 1,000 addresses that
PRTG will scan during auto-discovery.

Organizational Unit This field is only visible if active directory is selected above. Enter
an organizational unit (OU) to restrict the active directory search to
computers which are part of this OU. Just enter the name of the OU
without any other term (i.e., without "OU" in front). If you leave this
field empty, there will not be any restriction.
If you have sub-OUs, too, please consider the correct syntax in the
format Y,OU=X : OUs that are part of another OU have to be listed
together with their parent(s). Enter the sub-OU followed by ,OU=
and the name of the parent OU. For example, assuming that the
organizational unit 'Y' is part of the OU named 'X'. Then the syntax
would be Y,OU=X. For three OUs 'X', 'Y' part of 'X', and 'Z' part of 'Y',
the syntax would be Z,OU=Y,OU=X. Note that the order is
important, sub-OUs have to be listed left of its according parents!

14.01.2014 257
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Name Resolution Define how newly discovered devices will be monitored. This only
affects new devices. The setting for existing devices will be kept.
Choose between:
§ Use DNS / WMI / SNMP names (recommended): Monitor newly
discovered devices via their DNS, WMI, or SNMP names (if
available).
§ Use IP addresses: Monitor newly discovered devices via their IP
address.
We recommend using the default value.

Device Rescan Define if you want to rescan known devices. Choose between:
§ Skip aut o-discovery for known devices/IPs (recommended):
Do not re-scan known devices or IP addresses, but only scan for
new devices/IPs when auto-discovering. This can avoid re-
creation of manually deleted sensors. PRTG will also avoid adding
devices that are already included elsewhere in your configuration,
e.g. in other groups.
§ Perform aut o-discovery for known devices/IPs: Re-scan
known devices and IP addresses with every auto-discovery. This
will re-create manually deleted sensors on existing devices.
We recommend using the default value.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Locat ion

Location (for geo When using geo maps using Google's API 1744 please enter a location
maps) in the first line. Objects will then be displayed on a geographical
map with a flag, showing the current status using a color code
similar to the sensor status icons 121 (green - yellow - orange - red).
You can enter a full postal address, city and country only, or
latitude and longitude. It is possible to enter any text before,
between, and after the coordinates, PRTG will parse latitude and
longitude automatically; for example: 49.452778 11.077778 or
enter 49.452778 any 11.077778 text
A minus sign (-) in the first line will hide an object from geo maps. In
this case you can enter location information in line two and
following.

258 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Locat ion

You can define a specific label for each location: enter a string
denoting the label in the first line and provide geo coordinates in
the second line. This object will be displayed then with the label in
PRTG's geo map.

Credent ials for Windows Sy st ems

Domain or Computer Define the authority for Windows access. This is used for Windows
Name Management Instrumentation (WMI) and other Windows sensors. If
you want to use a Windows local user account on the target
device, please enter the computer name here. If you want to use a
Windows domain user account (recommended), please enter the
(Active Directory) domain name here. If not explicitly defined, PRTG
will automatically add a prefix in order to use the NT LAN Manager
(NTLM) protocol. Please do not leave this field empty.

Username Enter the username for Windows access. Usually, you will use
credentials with administrator privileges.

Password Enter the password for Windows access. Usually, you will use
credentials with administrator privileges.

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Username Enter a login name for the access via SSH and WBEM. Usually, you
will use credentials with administrator privileges.

Login Define which authentication method will be used for login. Choose
between:
§ Login via Password: Provide a password for login. Enter below.
§ Login via Privat e Key : Provide a private key for authentication.
Note: PRTG can only handle keys in OpenSSH format which are
not encrypted. You cannot use password protected keys here. In
the text field, please paste the entire private key, including the
"BEGIN" and "END" lines. Please make sure the according public
key is provided on the target machine. For details, please see
Monit oring via SSH 1962 .

Password This field is only visible if password login is selected above. Enter a
password for the Linux access via SSH and WBEM. Usually, you will
use credentials with administrator privileges.

14.01.2014 259
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Private Key This field is only visible if private key login is selected above. Paste
a private key into the field (OpenSSH format, unencrypted). Usually,
you will use credentials with administrator privileges. Note: If you
do not insert a private key for the first time, but change the private
key, you need to restart your PRTG core server service in order for
the private key change to take effect! For details, please see
Monit oring via SSH 1962 .

For WBEM Use Protocol Define the protocol that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ HTTP: Use an unencrypted connection for WBEM.
§ HTTPS: Use an SSL-encrypted connection for WBEM.

For WBEM Use Port Define the port that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ Set aut omat ically (port 5988 or 5989): Use one of the
standard ports, depending on whether unencrypted or encrypted
connection is chosen above.
§ Set manually : Use a custom port. Define below.

WBEM Port This setting is only visible if manual port selection is enabled above.
Enter the WBEM port number.

SSH Port Define the port number which will be used for SSH connections.
Note: By default, this setting is automatically used for all SSH
sensors 296 , unless you define a different port number in the sensor
settings.

SSH Rights Elevation Define with which rights the command will be executed on the
target system. Choose between:
§ Run t he command as t he user connect ing (default ): Use the
rights of the user who establishes the SSH connection.
§ Run t he command as anot her user using 'sudo': Use the rights
of another user, for example, the administrator.
§ Run t he command as anot her user using 'su': Use the rights of
another target user.

Target Username This field is only visible if sudo or su is enabled above. Enter a
username to run the specified command as another user than root.
If you leave this field empty, the command will be run as root.
Ensure that you set the Linux password even you use a public/
private key for authentication. This is not necessary if the user is
allowed to execute the command without a password.

260 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Password Target User This field is only visible if su is enabled above. Enter the password
for the specified target user.

Credent ials for VMware/X enServer

User Enter a login name for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

Password Enter a password for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

VMware Protocol Define the protocol used for the connection to VMware and
XenServer. Choose between:
§ HTTPS (recommended): Use an SSL-encrypted connection to
VMware and XenServers.
§ HTTP: Use an unencrypted connection to VMware and
XenServers.

Credent ials for SNMP Devices

SNMP Version Select the SNMP version that will be used for device connection.
Choose between:
§ v1: Use the simple standard v1 protocol for SNMP connections.
This protocol only offers clear-text data transmission, but it is
usually supported by all devices.
§ v2c: Use the more advanced v2c protocol for SNMP connections.
Data is still transferred as clear-text, but it supports 64-bit
counters.
§ v3: Use the latest v3 protocol for SNMP connections. It provides
secure authentication and data encryption.
Note for SNMP v3: Due to internal limitations you can only monitor
a limited number of sensors per second using SNMP v3. The limit is
somewhere between 1 and 50 sensors per second (depending on
the SNMP latency of your network). This means that using an
interval of 60 seconds you are limited to between 60 and 3000
SNMP v3 sensors for each probe. If you experience an increased
"Interval Delay" or "Open Requests" reading of the probe health
sensor, you need to distribute the load over multiple probes. SNMP
v1 and v2 do not have this limitation.

14.01.2014 261
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Credent ials for SNMP Devices

Community String This setting is only visible if SNMP version v1 or v2c are enabled
above. Enter the community string of your devices. This is a kind of
"clear-text password" used for simple authentication. We
recommend using the default value.

Authentication Type This setting is only visible if SNMP version v3 is enabled above.
Choose between:
§ MD5: Use Message-Digest Algorithm 5 (MD5) for authentication.
§ SHA: Use Secure Hash Algorithm (SHA) for authentication.
The chosen type has to match the authentication type of your
device.
Note: If you do not want to use authentication, but you need SNMP
v3, for example, because your device requires context, you can
leave the field password empty. In this case,
SNMP_SEC_LEVEL_NOAUTH will be used and authentication will be
deactivated entirely.

User This setting is only visible if SNMP version v3 is enabled above.


Enter a username for secure authentication. This value has to
match the username of your device.

Password This setting is only visible if SNMP version v3 is enabled above.


Enter a password for secure authentication. This value has to
match the password of your device.

Encryption Type This setting is only visible if SNMP version v3 is enabled above.
Select an encryption type. Choose between:
§ DES: Use Data Encryption Standard (DES) as encryption
algorithm.
§ AES: Use Advanced Encryption Standard (AES) as encryption
algorithm.
The chosen type has to match the encryption type of your device.

Data Encryption Key This setting is only visible if SNMP version v3 is enabled above.
Enter an encryption key here. If you provide a key in this field,
SNMP data packets will be encrypted using the encryption
algorithm selected above, providing increased security. The
provided key here has to match the encryption key of your device.
Note: If the key entered in this field does not match the key
configured in the target SNMP device, you will not get an error
message! Please enter a string or leave the field empty.

262 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Credent ials for SNMP Devices

Context Name This setting is only visible if SNMP version v3 is enabled above.
Enter a context name only if it is required by the configuration of
the device. Context is a collection of management information
accessible by an SNMP device. Please enter a string.

SNMP Port Enter the port used for SNMP communication. We recommend using
the default value.

SNMP Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Windows Compat ibilit y Opt ions

When experiencing problems while monitoring via Windows sensors, you can set some
compatibility options for trouble shooting.

Preferred Data Source Define the method Windows sensors will use to query data. This
setting is valid only for hybrid sensors offering performance
counter and Windows Management Instrumentation (WMI)
technology. The setting will be ignored for all other sensors!
Choose between:
§ Performance Count ers and fallback t o WMI (recommended):
Try to query data via performance counters. If this is not possible,
establish a connection via WMI. This is the recommended setting
to best balance resource usage and functionality.
§ Performance Count ers only : Query data via performance
counters only. If this is not possible, a sensor will return no data.
§ WMI only : Query data via WMI only. If this is not possible, a
sensor will return no data.

Timeout Method Specify the time the sensor will wait for the return of its WMI query
before aborting it with an error message. Choose between:
§ Use 1.5x scanning int erval (recommended): Use a default of
one and a half times the scanning interval set for the sensor (see
below in this settings).
§ Set manually : Enter a timeout value manually.
We recommend using the default value. Only if you experience
ongoing timeout errors, try increasing the timeout value.

14.01.2014 263
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Windows Compat ibilit y Opt ions

Timeout Value (Sec.) This field is only visible if the manual timeout method is selected
above. Specify the time the sensor will wait for the return of its
WMI query before aborting with an error message. Please enter an
integer value.

SNMP Compat ibilit y Opt ions

When experiencing problems while monitoring via Simple Network Management Protocol
(SNMP) sensors, you can set some compatibility options for trouble shooting.

SNMP Delay (ms) Add a time in milliseconds that will be waited between two SNMP
requests. This can help increase device compatibility. Please enter
an integer value. We recommend using the default value. If you
experience SNMP connection failures, please increase it. You can
define a delay between 0 and 100, higher delays are not supported
and will be discarded.

Failed Requests Define if an SNMP sensor will try again after a request fails.
§ Ret ry (recommended): Try again if an SNMP request fails. This
can help prevent false error messages due to temporary timeout
failures.
§ Do not ret ry : Do not retry if an SNMP request fails. With this
setting enabled an SNMP sensor will be set to error status earlier.

Overflow Values Define how PRTG will handle overflow values. Some devices do not
handle internal buffer overflows correctly. This can cause false
peaks.
§ Ignore overflow values (recommended): Ignore overflow
values and do not include them in the monitoring data.
§ Handle overflow values as valid result s: Regard all overflow
values as regular data and include them in the monitoring data.
We recommend using the default value. If you experience problems,
change this option.

Zero Values Define how PRTG will handle zero values. Some devices send
incorrect zero values. This can cause false peaks.
§ Ignore zero values for delt a sensors (recommended): Ignore
zero values and do not include them in the monitoring data.
§ Handle zero values as valid result s for delt a sensors: Regard
all zero values as regular data and include them in the monitoring
data.
We recommend using the default value. If you experience problems,
change this option.

264 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

SNMP Compat ibilit y Opt ions

32-bit/64-bit Counters Define which kind of traffic counters PRTG will search for on a
device.
§ Use 64-bit count ers if available (recommended): The interface
scan will use 64-bit traffic counters, if available. This can avoid
buffer overflows in the devices.
§ Use 32-bit count ers only : The interface scan will always use 32-
bit traffic counters, even if 64-bit counters are available. This can
lead to more reliable monitoring for some devices.
We recommend using the default value. If you experience problems,
change this option.

Request Mode Define which kind of request method PRTG uses for SNMP sensors.
§ Use mult i get (recommended): Bundle multiple SNMP requests
into one request.
§ Use single get : Use one request for each SNMP value. This can
increase compatibility with older devices.
We recommend using the default value. If you experience problems,
change this option.

Port Name Template Define how the name of SNMP sensors created on a device will be
put together. Enter a template using several variables. When adding
new sensors, PRTG scans the interface for available counters at
certain OIDs. At each OID usually several fields are available with
interface descriptions. They are different for every device/OID.
PRTG will use the information in these fields to name the sensors. If
a field is empty or not available, an empty string is added to the
name. As default, ([port ]) [ifalias] is set as port name template,
which will create a name such as (001) Ethernet1, for example. You
can use any field names available at a certain OID of your device,
among which are:
§ [port ]: The port number of the monitored interface.
§ [ifalias]: The 'alias' name for the monitored interface as specified
by a network manager, providing a non-volatile handling.
§ [ifname]: The textual name of the monitored interface as
assigned by the local device.
§ [ifindex]: A unique value, greater than zero, for the monitored
interface.
§ [ifdescr]: A textual string containing information about the
monitored device or interface, for example, manufacturer,
product name, version.
§ [ifspeed]: An estimate of the monitored interface's current
bandwidth (KBit/s).

14.01.2014 265
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

SNMP Compat ibilit y Opt ions

Combine them as you like to obtain suitable sensor names. See


the More section below for more information about SNMP sensor
names.

Port Name Update Define how PRTG will react if you change port names in your
physical device (e.g. a switch or router). Choose between:
§ Keep port names (use t his if y ou edit t he names in PRTG): Do
not automatically adjust sensor names. This is the best option if
you want to change names in PRTG manually.
§ Aut omat ic sensor name updat e if name changes in device: If
PRTG detects changes of port names in your physical device, it
will try to automatically adjust sensor names accordingly. For
detailed information please see More section below.

Port Identification Define which field will be used for SNMP interface identification.
Choose between:
§ Aut omat ic (recommended): Tries the ifAlias field first to identify
an SNMP interface and then ifDescr. Note: ifName will not be tried
automatically.
§ Use ifAlias: For most devices ifAlias is the best field to get
unique interface names.
§ Use ifDescr: Use this option if the port order of your device
changes after a reboot, and there is no ifAlias field available. For
example, this is the best option for Cisco ASA devices. Note:
When using this option it is important that your device returns
unique interface names in the ifDescr field.
§ Use ifName: You can also use this option if there is no unique
ifAlias available. Note: When using this option it is important that
your device returns unique interface names in the ifName field.
§ No Port Updat e: Use this option to disable automatic port
identification.

Start Port For SNMP Traffic sensors, define at which port number PRTG will
start to create sensors. Use 0 for automatic. We recommend using
the default value.

End Port For SNMP Traffic sensors, define at which port number PRTG will
stop to create sensors. Use 0 for automatic. We recommend using
the default value.

SNMP Debug Log Define if you want to create an SNMP log file for debugging
purposes. This is only recommended for debugging low level SNMP
issues. Choose between:
§ No log (recommended): No SNMP debug log file will be created.

266 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

SNMP Compat ibilit y Opt ions

§ Enable debug log: An SNMP log file is written to the Logs


(Debug) directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Clust er Usage

Scanning Distribution This box is only visible if you're running a PRTG cluster. Sometimes
you want to exclude a certain node from monitoring the sensors
running on this probe, group, or device, for example, if a device is
not reachable from every node configured in your cluster. In the list
of cluster nodes, please select the nodes that will not be included
in sensor scans. By default, this setting is inherited 87 to all objects
underneath.

14.01.2014 267
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to pause
monitoring for a certain time span (days, hours) throughout the
week. You can create new schedules and edit existing ones in the
account settings 1817 . Note: Schedules are generally inherited. New
schedules will be added to existing ones, so all schedules are
active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance Ends At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current object if its parent object is in a
Down status, or if it is paused by another dependency.
§ Select object : Pause the current object if its parent object is in
a Down status, or if it is paused by another dependency.
Additionally, pause the current object if a specific other object in
the device tree is in a Down status, or if it is paused by another
dependency. Select below.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

268 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Schedules, Dependencies, and Maint enance Window

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current object will be dependent
on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds.

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

14.01.2014 269
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Aut omat ic Monit oring Dat a Analy sis

Unusual Detection Define if unusual detection is enabled for sensors. You can
configure the behavior of unusual detection (or disable it
completely) in the system settings 1839 .
§ Enabled: Enable unusual detection for this group. Sensors in this
group will turn to orange color if unusual activity is detected.
§ Disabled: Disable unusual detection for this group. Unusual
values will be ignored for sensors in this group; they will not
show an unusual sensor status.

Similar Sensors Define if similar sensors detection is enabled for sensors. You can
Detection configure the depth of analysis of similar sensors detection (or
disable it completely) in the system settings 1840 .
§ Enabled: Enable similar sensors detection for this group.
Sensors in this group will be considered during similarity analysis.
§ Disabled: Disable similar detection for this group. Sensors in this
group will not be taken into account during similarity analysis.

Number of Sensors Limit at ion

Sensor Limit This setting allows the administrator to set a limit for the maximum
number of sensors in this group. Subgroups are also included. If
sensors exceed this limitation, they will be paused. This is of
special interest for a Managed Service Provider (MSP). Choose
between:
§ Allow unlimit ed number of sensors: Disable a limitation of the
number of sensors for this group. Any number of sensors can be
added to this group.

270 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 6 Group Settings

Number of Sensors Limit at ion

§ Limit number of sensors in t his group: Enables a limitation of


the number of sensors for this group. Only a limited number of
sensors can be added to this group.

Maximum Number of This field is only visible if limitation is enabled above. Define how
Sensors many sensors can be added to this group. Please enter an integer
value.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Notifications

The status or the data of a sensor can trigger notifications. Using this mechanism, you can
configure external alerting tailored to you needs. In an object's detail page, click on the
Not ificat ions tab to change sensor notification triggers. The defined triggers will be inherited
down to sensor level. For detailed information, please see Sensor Not ificat ions Set t ings 1716
section.

Others

For more general information about settings, please see Object Set t ings 142 section.

More
Knowledge Base: How does PRTG compute CPU Index, Traffic Index and Response Time Index?
§ http://kb.paessler.com/en/topic/313

Knowledge Base: How can I add my own device icons for use in the PRTG web interface?
§ http://kb.paessler.com/en/topic/7313

Knowledge Base: How can I change the defaults for names automatically generated for new
SNMP sensors?
§ http://kb.paessler.com/en/topic/7363

Knowledge Base: Automatically update port name and number for SNMP Traffic sensors when
the device changes them
§ http://kb.paessler.com/en/topic/25893

14.01.2014 271
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

6.7 Device Settings


On a device's details page, click on the Set t ings tab to change settings.

Add Device

The Add Device dialog appears when adding a new device to a group. It only shows the
setting fields that are imperative for creating the device. Therefore, you will not see all setting
fields in this dialog. For example, the Device St at us option is not available in this step.

You can change all settings in the device's Set t ings tab later.

Device Settings

The following settings are available in the Set t ings tab of every device. As you may not need
all of these for every device, just regard those settings you really need, ignoring the others.

We recommend defining as many settings as possible in the Root 224 group, so you can inherit
them to all other objects further down in the tree hierarchy.

For device settings, there is also multi-edit available. This enables you to change properties of
many devices at a time. For more details, please see Mult i-Edit List s 1736 section.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Basic Device Set t ings

Device Name Enter a meaningful name to identify the device. The name will be
shown by default in the device tree and in all alarms.

Status Choose if monitoring for this device is started or paused.


§ St art ed: Monitor this device.
§ Paused: Pause monitoring for this device. All sensors on it will be
paused until this setting is changed again.

IP Version Define which IP protocol PRTG will use to connect to this device.
The setting is valid for all sensors created on this device. Choose
between:
§ Connect using IPv4: Use IP version 4 for all requests to this
device.
§ Connect using IPv6: Use IP version 6 for all requests to this
device.

272 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Basic Device Set t ings

IP Address/DNS Name Enter the IP address (either v4 or v6, depending on your selection
above) or DNS name for the device. Most sensors created on this
device will inherit this setting and they will try to connect to this
address for monitoring. (However, some sensor types still have
their own setting for IP address/DNS name.)

Tags Enter one or more tags; confirm each tag by hitting space, comma,
or enter key. You can use tags to group sensors and use tag-
filtered views later on. Tags are not case sensitive. We recommend
using the default value. You can add additional tags to it, if you like.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Addit ional Device Informat ion

Device Icon Choose a device icon from the list. It will be shown in the device
tree. For information on how to add your custom icons, please see
the link in the More 288 section below.

Service URL Specify a URL you would like to open directly when choosing
Device Tools | Go To Service URL from the device's context menu
168 . For example, you can configure this option to call the address

http://www.example.com/service.html. Enter a valid URL or leave


the field empty.

Device Ty pe

Sensor Management Select which type of auto-discovery you would like to perform for
this device. Choose between:
§ Manual (no aut o-discovery ): Do not auto-discover any sensors,
but only add sensors manually.
§ Aut omat ic device ident ificat ion (st andard, recommended):
Use a small set of auto-discovery templates. This will scan your
LAN and usually create a view standard sensors on your device.
§ Aut omat ic device ident ificat ion (det ailed, may creat e many
sensors: Use an extended set of auto-discovery templates. This
will scan your LAN and usually create many sensors on your
device.

14.01.2014 273
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Device Ty pe

§ Aut omat ic sensor creat ion using specific device t emplat es:
Use specific auto-discovery templates only. Please select
templates below. This will scan your LAN and add sensors
defined in the template.

Discovery Schedule This option is only visible if one of the auto-discovery options is
selected above. Define when the auto-discovery will be run.
Choose between:
§ Once: Perform auto-discovery only once. For existing devices,
this will initiate a one-time sensor update for the current device.
§ Hourly : Perform auto-discovery for new sensors every hour.
§ Daily : Perform auto-discovery for new sensors every day.
§ Weekly : Perform auto-discovery for new sensors every week.

Device Template(s) This option is only visible if using specific device templates (last
option) is enabled above. Please choose one or more templates by
adding a check mark in front of the respective template name. You
can also select and deselect all items by using the check box in the
table head. These will be used for auto-discovery on the current
device. Choose from:
§ ADSL
§ Cisco ASA VPN
§ Cisco Device (Generic)
§ Dell MDI
§ DNS Server
§ Environment Jacart a
§ Environment Poseidon
§ Frit zbox
§ FTP Server
§ Generic Device (PING only )
§ Generic Device (SNMP-enabled)
§ Generic Device (SNMP-enabled, Det ailed)
§ HTTP Web Server
§ Hy per V Host Server
§ Linux/UNIX Device (SNMP or SSH enabled)
§ Mail Server (Generic)
§ Mail Server (MS Exchange)

274 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Device Ty pe

§ Microsoft Sharepoint 2010


§ NAS LenovoEMC
§ NAS QNAP
§ NAS Sy nology
§ Net App
§ NTP Server
§ Print er (HP)
§ RDP Server
§ RMON compat ible device
§ Server (Compaq/HP agent s)
§ Server (Dell)
§ Sever Cisco UCS
§ Server IBM
§ SonicWALL
§ Swit ch (Cisco Cat aly st )
§ Swit ch (Cisco IOS Based)
§ Swit ch (HP Procurve)
§ UNIX /Linux Device
§ UPS (APC)
§ Virt uozzo Server
§ VMware ESX / vCent er Server
§ Windows (Det ailed via WMI)
§ Windows (via Remot e Powershell)
§ Windows (via WMI)
§ Windows IIS (via SNMP)
§ X EN Host s
§ X EN Virt ual Machines

Once the auto-discovery is finished, PRTG will create a new ticket


149 and list the device templates which were actually used to

create new sensors. Templates which were not applied will not be
shown in the ticket.

14.01.2014 275
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Locat ion

Location (for geo When using geo maps using Google's API 1744 please enter a location
maps) in the first line. Objects will then be displayed on a geographical
map with a flag, showing the current status using a color code
similar to the sensor status icons 121 (green - yellow - orange - red).
You can enter a full postal address, city and country only, or
latitude and longitude. It is possible to enter any text before,
between, and after the coordinates, PRTG will parse latitude and
longitude automatically; for example: 49.452778 11.077778 or
enter 49.452778 any 11.077778 text
A minus sign (-) in the first line will hide an object from geo maps. In
this case you can enter location information in line two and
following.
You can define a specific label for each location: enter a string
denoting the label in the first line and provide geo coordinates in
the second line. This object will be displayed then with the label in
PRTG's geo map.

Credent ials for Windows Sy st ems

Domain or Computer Define the authority for Windows access. This is used for Windows
Name Management Instrumentation (WMI) and other Windows sensors. If
you want to use a Windows local user account on the target
device, please enter the computer name here. If you want to use a
Windows domain user account (recommended), please enter the
(Active Directory) domain name here. If not explicitly defined, PRTG
will automatically add a prefix in order to use the NT LAN Manager
(NTLM) protocol. Please do not leave this field empty.

Username Enter the username for Windows access. Usually, you will use
credentials with administrator privileges.

Password Enter the password for Windows access. Usually, you will use
credentials with administrator privileges.

276 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

Username Enter a login name for the access via SSH and WBEM. Usually, you
will use credentials with administrator privileges.

Login Define which authentication method will be used for login. Choose
between:
§ Login via Password: Provide a password for login. Enter below.
§ Login via Privat e Key : Provide a private key for authentication.
Note: PRTG can only handle keys in OpenSSH format which are
not encrypted. You cannot use password protected keys here. In
the text field, please paste the entire private key, including the
"BEGIN" and "END" lines. Please make sure the according public
key is provided on the target machine. For details, please see
Monit oring via SSH 1962 .

Password This field is only visible if password login is selected above. Enter a
password for the Linux access via SSH and WBEM. Usually, you will
use credentials with administrator privileges.

Private Key This field is only visible if private key login is selected above. Paste
a private key into the field (OpenSSH format, unencrypted). Usually,
you will use credentials with administrator privileges. Note: If you
do not insert a private key for the first time, but change the private
key, you need to restart your PRTG core server service in order for
the private key change to take effect! For details, please see
Monit oring via SSH 1962 .

For WBEM Use Protocol Define the protocol that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ HTTP: Use an unencrypted connection for WBEM.
§ HTTPS: Use an SSL-encrypted connection for WBEM.

For WBEM Use Port Define the port that will be used for WBEM. This setting is only
relevant when using WBEM sensors. Choose between:
§ Set aut omat ically (port 5988 or 5989): Use one of the
standard ports, depending on whether unencrypted or encrypted
connection is chosen above.
§ Set manually : Use a custom port. Define below.

WBEM Port This setting is only visible if manual port selection is enabled above.
Enter the WBEM port number.

SSH Port Define the port number which will be used for SSH connections.
Note: By default, this setting is automatically used for all SSH
sensors 296 , unless you define a different port number in the sensor
settings.

14.01.2014 277
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems

SSH Rights Elevation Define with which rights the command will be executed on the
target system. Choose between:
§ Run t he command as t he user connect ing (default ): Use the
rights of the user who establishes the SSH connection.
§ Run t he command as anot her user using 'sudo': Use the rights
of another user, for example, the administrator.
§ Run t he command as anot her user using 'su': Use the rights of
another target user.

Target Username This field is only visible if sudo or su is enabled above. Enter a
username to run the specified command as another user than root.
If you leave this field empty, the command will be run as root.
Ensure that you set the Linux password even you use a public/
private key for authentication. This is not necessary if the user is
allowed to execute the command without a password.

Password Target User This field is only visible if su is enabled above. Enter the password
for the specified target user.

Credent ials for VMware/X enServer

User Enter a login name for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

Password Enter a password for access to VMware and XEN servers. Usually,
you will use credentials with administrator privileges.

VMware Protocol Define the protocol used for the connection to VMware and
XenServer. Choose between:
§ HTTPS (recommended): Use an SSL-encrypted connection to
VMware and XenServers.
§ HTTP: Use an unencrypted connection to VMware and
XenServers.

Credent ials for SNMP Devices

SNMP Version Select the SNMP version that will be used for device connection.
Choose between:
§ v1: Use the simple standard v1 protocol for SNMP connections.
This protocol only offers clear-text data transmission, but it is
usually supported by all devices.

278 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Credent ials for SNMP Devices

§ v2c: Use the more advanced v2c protocol for SNMP connections.
Data is still transferred as clear-text, but it supports 64-bit
counters.
§ v3: Use the latest v3 protocol for SNMP connections. It provides
secure authentication and data encryption.
Note for SNMP v3: Due to internal limitations you can only monitor
a limited number of sensors per second using SNMP v3. The limit is
somewhere between 1 and 50 sensors per second (depending on
the SNMP latency of your network). This means that using an
interval of 60 seconds you are limited to between 60 and 3000
SNMP v3 sensors for each probe. If you experience an increased
"Interval Delay" or "Open Requests" reading of the probe health
sensor, you need to distribute the load over multiple probes. SNMP
v1 and v2 do not have this limitation.

Community String This setting is only visible if SNMP version v1 or v2c are enabled
above. Enter the community string of your devices. This is a kind of
"clear-text password" used for simple authentication. We
recommend using the default value.

Authentication Type This setting is only visible if SNMP version v3 is enabled above.
Choose between:
§ MD5: Use Message-Digest Algorithm 5 (MD5) for authentication.
§ SHA: Use Secure Hash Algorithm (SHA) for authentication.
The chosen type has to match the authentication type of your
device.
Note: If you do not want to use authentication, but you need SNMP
v3, for example, because your device requires context, you can
leave the field password empty. In this case,
SNMP_SEC_LEVEL_NOAUTH will be used and authentication will be
deactivated entirely.

User This setting is only visible if SNMP version v3 is enabled above.


Enter a username for secure authentication. This value has to
match the username of your device.

Password This setting is only visible if SNMP version v3 is enabled above.


Enter a password for secure authentication. This value has to
match the password of your device.

Encryption Type This setting is only visible if SNMP version v3 is enabled above.
Select an encryption type. Choose between:
§ DES: Use Data Encryption Standard (DES) as encryption
algorithm.

14.01.2014 279
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Credent ials for SNMP Devices

§ AES: Use Advanced Encryption Standard (AES) as encryption


algorithm.
The chosen type has to match the encryption type of your device.

Data Encryption Key This setting is only visible if SNMP version v3 is enabled above.
Enter an encryption key here. If you provide a key in this field,
SNMP data packets will be encrypted using the encryption
algorithm selected above, providing increased security. The
provided key here has to match the encryption key of your device.
Note: If the key entered in this field does not match the key
configured in the target SNMP device, you will not get an error
message! Please enter a string or leave the field empty.

Context Name This setting is only visible if SNMP version v3 is enabled above.
Enter a context name only if it is required by the configuration of
the device. Context is a collection of management information
accessible by an SNMP device. Please enter a string.

SNMP Port Enter the port used for SNMP communication. We recommend using
the default value.

SNMP Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Windows Compat ibilit y Opt ions

When experiencing problems while monitoring via Windows sensors, you can set some
compatibility options for trouble shooting.

Preferred Data Source Define the method Windows sensors will use to query data. This
setting is valid only for hybrid sensors offering performance
counter and Windows Management Instrumentation (WMI)
technology. The setting will be ignored for all other sensors!
Choose between:
§ Performance Count ers and fallback t o WMI (recommended):
Try to query data via performance counters. If this is not possible,
establish a connection via WMI. This is the recommended setting
to best balance resource usage and functionality.
§ Performance Count ers only : Query data via performance
counters only. If this is not possible, a sensor will return no data.
§ WMI only : Query data via WMI only. If this is not possible, a
sensor will return no data.

280 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Windows Compat ibilit y Opt ions

Timeout Method Specify the time the sensor will wait for the return of its WMI query
before aborting it with an error message. Choose between:
§ Use 1.5x scanning int erval (recommended): Use a default of
one and a half times the scanning interval set for the sensor (see
below in this settings).
§ Set manually : Enter a timeout value manually.
We recommend using the default value. Only if you experience
ongoing timeout errors, try increasing the timeout value.

Timeout Value (Sec.) This field is only visible if the manual timeout method is selected
above. Specify the time the sensor will wait for the return of its
WMI query before aborting with an error message. Please enter an
integer value.

SNMP Compat ibilit y Opt ions

When experiencing problems while monitoring via Simple Network Management Protocol
(SNMP) sensors, you can set some compatibility options for trouble shooting.

SNMP Delay (ms) Add a time in milliseconds that will be waited between two SNMP
requests. This can help increase device compatibility. Please enter
an integer value. We recommend using the default value. If you
experience SNMP connection failures, please increase it. You can
define a delay between 0 and 100, higher delays are not supported
and will be discarded.

Failed Requests Define if an SNMP sensor will try again after a request fails.
§ Ret ry (recommended): Try again if an SNMP request fails. This
can help prevent false error messages due to temporary timeout
failures.
§ Do not ret ry : Do not retry if an SNMP request fails. With this
setting enabled an SNMP sensor will be set to error status earlier.

Overflow Values Define how PRTG will handle overflow values. Some devices do not
handle internal buffer overflows correctly. This can cause false
peaks.
§ Ignore overflow values (recommended): Ignore overflow
values and do not include them in the monitoring data.
§ Handle overflow values as valid result s: Regard all overflow
values as regular data and include them in the monitoring data.
We recommend using the default value. If you experience problems,
change this option.

14.01.2014 281
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

SNMP Compat ibilit y Opt ions

Zero Values Define how PRTG will handle zero values. Some devices send
incorrect zero values. This can cause false peaks.
§ Ignore zero values for delt a sensors (recommended): Ignore
zero values and do not include them in the monitoring data.
§ Handle zero values as valid result s for delt a sensors: Regard
all zero values as regular data and include them in the monitoring
data.
We recommend using the default value. If you experience problems,
change this option.

32-bit/64-bit Counters Define which kind of traffic counters PRTG will search for on a
device.
§ Use 64-bit count ers if available (recommended): The interface
scan will use 64-bit traffic counters, if available. This can avoid
buffer overflows in the devices.
§ Use 32-bit count ers only : The interface scan will always use 32-
bit traffic counters, even if 64-bit counters are available. This can
lead to more reliable monitoring for some devices.
We recommend using the default value. If you experience problems,
change this option.

Request Mode Define which kind of request method PRTG uses for SNMP sensors.
§ Use mult i get (recommended): Bundle multiple SNMP requests
into one request.
§ Use single get : Use one request for each SNMP value. This can
increase compatibility with older devices.
We recommend using the default value. If you experience problems,
change this option.

Port Name Template Define how the name of SNMP sensors created on a device will be
put together. Enter a template using several variables. When adding
new sensors, PRTG scans the interface for available counters at
certain OIDs. At each OID usually several fields are available with
interface descriptions. They are different for every device/OID.
PRTG will use the information in these fields to name the sensors. If
a field is empty or not available, an empty string is added to the
name. As default, ([port ]) [ifalias] is set as port name template,
which will create a name such as (001) Ethernet1, for example. You
can use any field names available at a certain OID of your device,
among which are:
§ [port ]: The port number of the monitored interface.
§ [ifalias]: The 'alias' name for the monitored interface as specified
by a network manager, providing a non-volatile handling.

282 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

SNMP Compat ibilit y Opt ions

§ [ifname]: The textual name of the monitored interface as


assigned by the local device.
§ [ifindex]: A unique value, greater than zero, for the monitored
interface.
§ [ifdescr]: A textual string containing information about the
monitored device or interface, for example, manufacturer,
product name, version.
§ [ifspeed]: An estimate of the monitored interface's current
bandwidth (KBit/s).
Combine them as you like to obtain suitable sensor names. See
the More section below for more information about SNMP sensor
names.

Port Name Update Define how PRTG will react if you change port names in your
physical device (e.g. a switch or router). Choose between:
§ Keep port names (use t his if y ou edit t he names in PRTG): Do
not automatically adjust sensor names. This is the best option if
you want to change names in PRTG manually.
§ Aut omat ic sensor name updat e if name changes in device: If
PRTG detects changes of port names in your physical device, it
will try to automatically adjust sensor names accordingly. For
detailed information please see More section below.

Port Identification Define which field will be used for SNMP interface identification.
Choose between:
§ Aut omat ic (recommended): Tries the ifAlias field first to identify
an SNMP interface and then ifDescr. Note: ifName will not be tried
automatically.
§ Use ifAlias: For most devices ifAlias is the best field to get
unique interface names.
§ Use ifDescr: Use this option if the port order of your device
changes after a reboot, and there is no ifAlias field available. For
example, this is the best option for Cisco ASA devices. Note:
When using this option it is important that your device returns
unique interface names in the ifDescr field.
§ Use ifName: You can also use this option if there is no unique
ifAlias available. Note: When using this option it is important that
your device returns unique interface names in the ifName field.
§ No Port Updat e: Use this option to disable automatic port
identification.

14.01.2014 283
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

SNMP Compat ibilit y Opt ions

Start Port For SNMP Traffic sensors, define at which port number PRTG will
start to create sensors. Use 0 for automatic. We recommend using
the default value.

End Port For SNMP Traffic sensors, define at which port number PRTG will
stop to create sensors. Use 0 for automatic. We recommend using
the default value.

SNMP Debug Log Define if you want to create an SNMP log file for debugging
purposes. This is only recommended for debugging low level SNMP
issues. Choose between:
§ No log (recommended): No SNMP debug log file will be created.
§ Enable debug log: An SNMP log file is written to the Logs
(Debug) directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

284 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Clust er Usage

Scanning Distribution This box is only visible if you're running a PRTG cluster. Sometimes
you want to exclude a certain node from monitoring the sensors
running on this probe, group, or device, for example, if a device is
not reachable from every node configured in your cluster. In the list
of cluster nodes, please select the nodes that will not be included
in sensor scans. By default, this setting is inherited 87 to all objects
underneath.

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to pause
monitoring for a certain time span (days, hours) throughout the
week. You can create new schedules and edit existing ones in the
account settings 1817 . Note: Schedules are generally inherited. New
schedules will be added to existing ones, so all schedules are
active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance Ends At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

14.01.2014 285
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current object if its parent object is in a
Down status, or if it is paused by another dependency.
§ Select object : Pause the current object if its parent object is in
a Down status, or if it is paused by another dependency.
Additionally, pause the current object if a specific other object in
the device tree is in a Down status, or if it is paused by another
dependency. Select below.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current object will be dependent
on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds.

286 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

14.01.2014 287
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

Aut omat ic Monit oring Dat a Analy sis

Unusual Detection Define if unusual detection is enabled for sensors. You can
configure the behavior of unusual detection (or disable it
completely) in the system settings 1839 .
§ Enabled: Enable unusual detection for this group. Sensors in this
group will turn to orange color if unusual activity is detected.
§ Disabled: Disable unusual detection for this group. Unusual
values will be ignored for sensors in this group; they will not
show an unusual sensor status.

Similar Sensors Define if similar sensors detection is enabled for sensors. You can
Detection configure the depth of analysis of similar sensors detection (or
disable it completely) in the system settings 1840 .
§ Enabled: Enable similar sensors detection for this group.
Sensors in this group will be considered during similarity analysis.
§ Disabled: Disable similar detection for this group. Sensors in this
group will not be taken into account during similarity analysis.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Notifications

The status or the data of a sensor can trigger notifications. Using this mechanism, you can
configure external alerting tailored to you needs. In an object's detail page, click on the
Not ificat ions tab to change sensor notification triggers. The defined triggers will be inherited
down to sensor level. For detailed information, please see Sensor Not ificat ions Set t ings 1716
section.

Others

For more general information about settings, please see Object Set t ings 142 section.

More
Knowledge Base: How does PRTG compute CPU Index, Traffic Index and Response Time Index?
§ http://kb.paessler.com/en/topic/313

Knowledge Base: How can I add my own device icons for use in the PRTG web interface?
§ http://kb.paessler.com/en/topic/7313

Knowledge Base: How can I change the defaults for names automatically generated for new
SNMP sensors?

288 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 7 Device Settings

§ http://kb.paessler.com/en/topic/7363

Knowledge Base: Automatically update port name and number for SNMP Traffic sensors when
the device changes them
§ http://kb.paessler.com/en/topic/25893

14.01.2014 289
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings

6.8 Sensor Settings


There are more than 210 different sensor types available. In the Add Sensor dialog, all sensors
are categorized into groups to help you quickly find what you need. Once you are familiar with
the interface, you will probably enter the first letters of a sensor type's name into the Search
field in the upper left corner and get to a sensor even faster.

Available Sensor Types

There is a dedicated manual section for every sensor type with details about the available
settings. For more information, please see List of Available Sensors 291 section.

For sensor settings, there is also multi-edit available. This enables you to change properties of
many sensors at a time. For more details, please see Mult i-Edit List s 1736 section.

In order to detect unexpected correlations between your network components, PRTG


provides a Similar Sensors 138 analysis.

Sensor Settings Overview

For information about sensor settings, please see the following sections:

· Sensor Set t ings 290

· List of Available Sensor Ty pes 291

· Addit ional Sensor Ty pes (Cust om Sensors) 1706

· Sensor Channels Set t ings 1709

· Sensor Not ificat ions Set t ings 1716

290 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

6.8.1 List of Available Sensor Ty pes

This chapter lists all available sensors, arranged both by different categories and in alphabetical
order. Note: In the Add a Sensor 220 assistant, PRTG offers you various options to filter for
fitting sensor types easily.

§ Common Sensors 291

§ Bandwidth Monitoring Sensors 291

§ Web Servers (HTTP) Sensors 292

§ SNMP Sensors 293

§ Windows WMI/Performance Counters Sensors 294

§ Linux/Unix/OS X Sensors 296

§ Virtual Servers Sensors 296

§ Mail Servers Sensors 297

§ SQL Database Servers Sensors 298

§ File Servers Sensors 298

§ Various Servers Sensors 298

§ VoIP and QoS Sensors 299

§ Hardware Parameters Sensors 299

§ Custom Sensors 301

§ PRTG Internal Sensors 301

§ All Sensors in Alphabetical Order 301

§ More 308

Common Sensors
§ HTTP Sensor 486

§ Ping Sensor 775

§ Port Sensor 804

§ Port Range Sensor 811

§ SNMP Traffic Sensor 1259

§ Windows Network Card Sensor 1476

Bandwidth Monitoring Sensors


§ AVM FRITZ!Box WAN Interface Sensor 331

28.05.2014 291
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ IPFIX Sensor 641

§ IPFIX (Custom) Sensor 649

§ jFlow V5 Sensor 664

§ jFlow V5 (Custom) Sensor 672

§ NetFlow V5 Sensor 700

§ NetFlow V5 (Custom) Sensor 708

§ NetFlow V9 Sensor 716

§ NetFlow V9 (Custom) Sensor 724

§ Packet Sniffer Sensor 740

§ Packet Sniffer (Custom) Sensor 748

§ sFlow Sensor 871

§ sFlow (Custom) Sensor 879

§ SNMP Cisco ADSL Sensor 933

§ SNMP Cisco ASA VPN Traffic Sensor 943

§ SNMP Library Sensor 1113

§ SNMP NetApp Network Interface Sensor 1184

§ SNMP RMON Sensor 1222

§ SNMP Traffic Sensor 1259

§ Windows Network Card Sensor 1476

Web Servers (HTTP) Sensors


§ Google Analytics Sensor 479

§ HTTP Sensor 486

§ HTTP Advanced Sensor 493

§ HTTP Apache ModStatus PerfStats Sensor 505

§ HTTP Apache ModStatus Totals Sensor 512

§ HTTP Content Sensor 519

§ HTTP Full Web Page Sensor 528

§ HTTP Push Count Sensor 536

§ HTTP Push Data Sensor 542

§ HTTP Push Data Advanced Sensor 549

§ HTTP SSL Certificate Expiry Sensor 556

§ HTTP Transaction Sensor 562

292 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ HTTP XML/REST Value Sensor 572

§ Windows IIS Application Sensor 1450

SNMP Sensors
§ SNMP APC Hardware Sensor 927

§ SNMP Cisco ADSL Sensor 933

§ SNMP Cisco ASA VPN Connections Sensor 938

§ SNMP Cisco ASA VPN Traffic Sensor 943

§ SNMP Cisco ASA VPN Users Sensor 948

§ SNMP Cisco CBQoS Sensor 953

§ SNMP Cisco System Health Sensor 958

§ SNMP Cisco UCS Chassis Sensor 964

§ SNMP Cisco UCS Physical Disk Sensor 970

§ SNMP Cisco UCS System Health Sensor 976

§ SNMP CPU Load Sensor 982

§ SNMP Custom Sensor 987

§ SNMP Custom String Sensor 994

§ SNMP Dell Hardware Sensor 1002

§ SNMP Dell PowerEdge Physical Disk Sensor 1008

§ SNMP Dell PowerEdge System Health Sensor 1014

§ SNMP Disk Free Sensor 1020

§ SNMP GSA System Health Sensor 1026

§ SNMP Hardware Status Sensor 1031

§ SNMP HP LaserJet Hardware Sensor 1036

§ SNMP HP ProLiant Logical Disk Sensor 1042

§ SNMP HP ProLiant Memory Controller Sensor 1048

§ SNMP HP ProLiant Network Interface Sensor 1054

§ SNMP HP ProLiant Physical Disk Sensor 1060

§ SNMP HP ProLiant System Health Sensor 1066

§ SNMP IBM System X Logical Disk Sensor 1072

§ SNMP IBM System X Physical Disk Sensor 1078

§ SNMP IBM System X Physical Memory Sensor 1084

§ SNMP IBM System X System Health Sensor 1090

28.05.2014 293
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ SNMP interSeptor Pro Environment Sensor 1096

§ SNMP LenovoEMC Physical Disk Sensor 1102

§ SNMP LenovoEMC System Health Sensor 1108

§ SNMP Library Sensor 1113

§ SNMP Linux Disk Free Sensor 1122

§ SNMP Linux Load Average Sensor 1130

§ SNMP Linux Meminfo Sensor 1135

§ SNMP Linux Physical Disk Sensor 1140

§ SNMP Memory Sensor 1148

§ SNMP NetApp Disk Free Sensor 1154

§ SNMP NetApp Enclosure Sensor 1160

§ SNMP NetApp I/O Sensor 1166

§ SNMP NetApp License Sensor 1172

§ SNMP NetApp Logical Unit Sensor 1178

§ SNMP NetApp Network Interface Sensor 1184

§ SNMP NetApp System Health Sensor 1190

§ SNMP Poseidon Environment Sensor 1196

§ SNMP Printer Sensor 1201

§ SNMP QNAP Logical Disk Sensor 1206

§ SNMP QNAP Physical Disk Sensor 1211

§ SNMP QNAP System Health Sensor 1217

§ SNMP RMON Sensor 1222

§ SNMP SonicWALL System Health Sensor 1228

§ SNMP SonicWALL VPN Traffic Sensor 1233

§ SNMP Synology Logical Disk Sensor 1239

§ SNMP Synology Physical Disk Sensor 1244

§ SNMP Synology System Health Sensor 1249

§ SNMP System Uptime Sensor 1254

§ SNMP Traffic Sensor 1259

§ SNMP Trap Receiver Sensor 1267

§ SNMP Windows Service Sensor 1276

Windows WMI/Performance Counters Sensors


§ Active Directory Replication Errors Sensor 309

294 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ Event Log (Windows API) Sensor 389

§ PerfCounter Custom Sensor 761

§ PerfCounter IIS Application Pool Sensor 768

§ Windows CPU Load Sensor 1432

§ Windows Last Update Sensor 1457

§ Windows Logged In Users Sensor 1463

§ Windows MSMQ Queue Length Sensor 1469

§ Windows Print Queue Sensor 1496

§ Windows Registry Sensor 1502

§ Windows Scheduled Task Sensor 1510

§ Windows Updates Status (Powershell) Sensor 1523

§ WMI Custom Sensor 1529

§ WMI Custom String Sensor 1536

§ WMI Event Log Sensor 1545

§ WMI Exchange Server Sensor 1553

§ WMI Exchange Transport Queue Sensor 1560

§ WMI File Sensor 1567

§ WMI Free Disk Space (Multi Drive) Sensor 1573

§ WMI HDD Health Sensor 1581

§ Windows IIS 6.0 SMTP Received Sensor 1438

§ Windows IIS 6.0 SMTP Sent Sensor 1444

§ WMI Logical Disk Sensor 1587

§ WMI Memory Sensor 1593

§ WMI Microsoft SQL Server 2005 Sensor 1598

§ WMI Microsoft SQL Server 2008 Sensor 1607

§ WMI Microsoft SQL Server 2012 Sensor 1615

§ Windows Network Card Sensor 1476

§ Windows Pagefile Sensor 1483

§ Windows Physical Disk Sensor 1489

§ WMI Process Sensor 1623

§ WMI Remote Ping Sensor 1629

§ WMI Security Center Sensor 1634

§ WMI Service Sensor 1640

§ WMI Share Sensor 1646

28.05.2014 295
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ WMI SharePoint Process Sensor 1653

§ Windows System Uptime Sensor 1517

§ WMI Terminal Services (Windows 2008) Sensor 1659

§ WMI Terminal Services (Windows XP/Vista/2003) Sensor 1664

§ WMI UTC Time Sensor 1669

§ WMI Vital System Data (V2) Sensor 1674

§ WMI Volume Sensor 1680

§ WMI Windows Version Sensor 1693

§ WSUS Statistics Sensor 1699

Linux/Unix/OS X Sensors
§ SNMP Linux Disk Free Sensor 1122

§ SNMP Linux Load Average Sensor 1130

§ SNMP Linux Meminfo Sensor 1135

§ SNMP Linux Physical Disk Sensor 1140

§ SSH Disk Free Sensor 1286

§ SSH INodes Free Sensor 1295

§ SSH Load Average Sensor 1301

§ SSH Meminfo Sensor 1307

§ SSH Remote Ping Sensor 1313

§ SSH Script Sensor 1341

§ SSH Script Advanced Sensor 1350

§ SSH SAN Logical Disk Sensor 1320

§ SSH SAN Physical Disk Sensor 1327

§ SSH SAN System Health Sensor 1334

§ WBEM Custom Sensor 1426

Virtual Servers Sensors


§ Amazon CloudWatch Sensor 323

§ Citrix XenServer Host Sensor 343

§ Citrix XenServer Virtual Machine Sensor 349

§ Enterprise Virtual Array Sensor 382

§ Hyper-V Cluster Shared Volume Disk Free Sensor 583

296 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ Hyper-V Host Server Sensor 590

§ Hyper-V Virtual Machine Sensor 596

§ Hyper-V Virtual Network Adapter Sensor 604

§ Hyper-V Virtual Storage Device Sensor 611

§ SCVMM Host Sensor 842

§ SCVMM Virtual Machine Sensor 849

§ SSH VMWare ESX(i) Disk Sensor 1358

§ Virtuozzo Container Disk Sensor 1389

§ Virtuozzo Container Network Sensor 1395

§ VMware Host Hardware (WBEM) Sensor 1401

§ VMware Host Hardware Status (SOAP) Sensor 1407

§ VMware Host Performance (SOAP) Sensor 1413

§ VMware Virtual Machine (SOAP) Sensor 1419

Mail Servers Sensors


§ Exchange Backup (Powershell) Sensor 397

§ Exchange Database (Powershell) Sensor 404

§ Exchange Mailbox (Powershell) Sensor 411

§ Exchange Mail Queue (Powershell) Sensor 418

§ Exchange Public Folder (Powershell) Sensor 424

§ IMAP Sensor 618

§ IP on DNS Blacklist Sensor 635

§ POP3 Sensor 792

§ POP3 Email Count Sensor 798

§ SMTP Sensor 905

§ SMTP&IMAP Round Trip Sensor 911

§ SMTP&POP3 Round Trip Sensor 919

§ WMI Exchange Server Sensor 1553

§ WMI Exchange Transport Queue Sensor 1560

§ Windows IIS 6.0 SMTP Received Sensor 1438

§ Windows IIS 6.0 SMTP Sent Sensor 1444

28.05.2014 297
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

SQL Database Servers Sensors

§ ADO SQL Sensor 316

§ Microsoft SQL Sensor 685

§ MySQL Sensor 693

§ Oracle SQL Sensor 732

§ WMI Microsoft SQL Server 2005 Sensor 1598

§ WMI Microsoft SQL Server 2008 Sensor 1607

§ WMI Microsoft SQL Server 2012 Sensor 1615

File Servers Sensors


§ Dell PowerVault MDi Sensor 363

§ File Sensor 449

§ File Content Sensor 455

§ Folder Sensor 461

§ FTP Sensor 467

§ FTP Server File Count Sensor 473

§ INI File Content Check Sensor 629

§ SFTP Secure File Transfer Protocol Sensor 887

§ Share Disk Free Sensor 893

§ SNMP NetApp Disk Free Sensor 1154

§ SNMP NetApp Enclosure Sensor 1160

§ SNMP NetApp I/O Sensor 1166

§ SNMP NetApp License Sensor 1172

§ SNMP NetApp Network Interface Sensor 1184

§ SNMP NetApp System Health Sensor 1190

§ TFTP Sensor 1377

§ WMI File Sensor 1567

§ WMI Free Disk Space (Multi Drive) Sensor 1573

§ WMI Volume Sensor 1680

Various Servers Sensors


§ DHCP Sensor 369

298 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ DNS Sensor 376

§ IPMI System Health Sensor 657

§ LDAP Sensor 680

§ Ping Sensor 775

§ Ping Jitter Sensor 781

§ Pingdom Sensor 786

§ Port Sensor 804

§ Port Range Sensor 811

§ RADIUS Sensor 832

§ RDP (Remote Desktop) Sensor 837

§ SNMP Trap Receiver Sensor 1267

§ SNTP Sensor 1281

§ Syslog Receiver Sensor 1364

§ Traceroute Hop Count Sensor 1383

VoIP and QoS Sensors


§ Cisco IP SLA Sensor 337

§ SIP Options Ping Sensor 899

§ QoS (Quality of Service) One Way Sensor 820

§ QoS (Quality of Service) Round Trip Sensor 826

§ SNMP Cisco CBQoS Sensor 953

Hardware Parameter Sensors


§ Dell PowerVault MDi Sensor 363

§ Enterprise Virtual Array Sensor 382

§ SNMP APC Hardware Sensor 927

§ SNMP Cisco System Health Sensor 958

§ SNMP Cisco UCS Chassis Sensor 964

§ SNMP Cisco UCS Physical Disk Sensor 970

§ SNMP Cisco UCS System Health Sensor 976

§ SNMP CPU Load Sensor 982

§ SNMP Dell Hardware Sensor 1002

§ SNMP Dell PowerEdge Physical Disk Sensor 1008

28.05.2014 299
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ SNMP Dell PowerEdge System Health Sensor 1014

§ SNMP Disk Free Sensor 1020

§ SNMP GSA System Health Sensor 1026

§ SNMP Hardware Status Sensor 1031

§ SNMP HP LaserJet Hardware Sensor 1036

§ SNMP HP ProLiant Memory Controller Sensor 1048

§ SNMP HP ProLiant Network Interface Sensor 1054

§ SNMP HP ProLiant Physical Disk Sensor 1060

§ SNMP HP ProLiant System Health Sensor 1066

§ SNMP IBM System X Physical Disk Sensor 1078

§ SNMP IBM System X Physical Memory Sensor 1084

§ SNMP IBM System X System Health Sensor 1090

§ SNMP LenovoEMC Physical Disk Sensor 1102

§ SNMP LenovoEMC System Health Sensor 1108

§ SNMP Library Sensor 1113

§ SNMP Memory Sensor 1148

§ SNMP NetApp I/O Sensor 1166

§ SNMP NetApp Enclosure Sensor 1160

§ SNMP NetApp Logical Unit Sensor 1178

§ SNMP NetApp Network Interface Sensor 1184

§ SNMP NetApp System Health Sensor 1190

§ SNMP QNAP Physical Disk Sensor 1211

§ SNMP QNAP System Health Sensor 1217

§ SNMP SonicWALL System Health Sensor 1228

§ SNMP SonicWALL VPN Traffic Sensor 1233

§ SNMP Synology Physical Disk Sensor 1244

§ SNMP Synology System Health Sensor 1249

§ SSH SAN Logical Disk Sensor 1320

§ SSH SAN Physical Disk Sensor 1327

§ SSH SAN System Health Sensor 1334

§ WMI HDD Health Sensor 1581

300 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

Custom Sensors

§ EXE/Script Sensor 431

§ EXE/Script Advanced Sensor 440

§ IPFIX (Custom) Sensor 649

§ jFlow V5 (Custom) Sensor 672

§ NetFlow V5 (Custom) Sensor 708

§ NetFlow V9 (Custom) Sensor 724

§ Packet Sniffer (Custom) Sensor 748

§ Pingdom Sensor 786

§ Sensor Factory Sensor 856

§ sFlow (Custom) Sensor 879

§ SNMP Custom Sensor 987

§ SNMP Custom String Sensor 994

§ SSH Script Sensor 1341

§ WBEM Custom Sensor 1426

§ WMI Custom Sensor 1529

§ WMI Custom String Sensor 1536

PRTG Internal Sensors


§ Core Health Sensor 359

§ Probe Health Sensor 816

§ System Health Sensor 1373

All Sensors in Alphabetical Order

The version numbers show when the respective sensor type was originally introduced to
PRTG.

§ Active Directory Replication Errors Sensor 309 (v8.3.0)


§ ADO SQL Sensor 316 (v8.1.0)
§ Amazon CloudWatch Sensor 323 (v7)
§ AVM FRITZ!Box WAN Interface Sensor 331 (v12.x.1)
§ Cisco IP SLA Sensor 337 (v7)
§ Citrix XenServer Host Sensor 343 (v12.x.1)

28.05.2014 301
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ Citrix XenServer Virtual Machine Sensor 349 (v8.1.0)


§ Cluster Probe Health Sensor 355 (v9.1.0)
§ Core Health Sensor 359 (v9.1.0)
§ Dell PowerVault MDi Sensor 363 (v12.x.1)
§ DHCP Sensor 369 (v8.2.0)
§ DNS Sensor 376 (v7)
§ Enterprise Virtual Array Sensor 382 (v13.x.6)
§ Event Log (Windows API) Sensor 389 (v7)
§ Exchange Backup (Powershell) Sensor 397 (v13.x.5)
§ Exchange Database (Powershell) Sensor 404 (v13.x.5)
§ Exchange Mailbox (Powershell) Sensor 411 (v13.x.5)
§ Exchange Mail Queue (Powershell) Sensor 418 (v13.x.5)
§ Exchange Public Folder (Powershell) Sensor 424 (v13.x.5)
§ EXE/Script Sensor 431 (v7)
§ EXE/Script Advanced Sensor 440 (v7)
§ File Sensor 449 (v7)
§ File Content Sensor 455 (v7)
§ Folder Sensor 461 (v7)
§ FTP Sensor 467 (v7)
§ FTP Server File Count Sensor 473 (v8.3.0)
§ Google Analytics Sensor 479 (v12.x.1)
§ HTTP Sensor 486 (v7)
§ HTTP Advanced Sensor 493 (v7)
§ HTTP Apache ModStatus PerfStats Sensor 505 (v12.x.3)
§ HTTP Apache ModStatus Totals Sensor 512 (v12.x.3)
§ HTTP Content Sensor 519 (v7)
§ HTTP Full Web Page Sensor 528 (v7)
§ HTTP Push Count Sensor 536 (v13.4.8)
§ HTTP Push Data Sensor 542 (v14.1.9)
§ HTTP Push Data Advanced Sensor 549 (14.1.10)
§ HTTP SSL Certificate Expiry Sensor 556 (v8.3.0)
§ HTTP Transaction Sensor 562 (v7)
§ HTTP XML/REST Value Sensor 572 (v8.3.0)
§ Hyper-V Cluster Shared Volume Disk Free Sensor 583 (v12.3.4)

302 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ Hyper-V Host Server Sensor 590 (v7)


§ Hyper-V Virtual Machine Sensor 596 (v7)
§ Hyper-V Virtual Network Adapter Sensor 604 (v9.1.0)
§ Hyper-V Virtual Storage Device Sensor 611 (v12.4.4)
§ IMAP Sensor 618 (v7)
§ INI File Content Check Sensor 629 (v8.3.0)
§ IP on DNS Blacklist Sensor 635 (v8.3.0)
§ IPFIX Sensor 641 (v13.x.7)
§ IPFIX (Custom) Sensor 649 (v13.x.7)
§ IPMI System Health Sensor 657 (v14.x.11)
§ jFlow V5 Sensor 664 (v8.2.0)
§ jFlow V5 (Custom) Sensor 672 (v8.2.0)
§ LDAP Sensor 680 (v8.1.0)
§ Microsoft SQL Sensor 685 (v7)
§ MySQL Sensor 693 (v7)
§ NetFlow V5 Sensor 700 (v7)
§ NetFlow V5 (Custom) Sensor 708 (v7)
§ NetFlow V9 Sensor 716 (v7)
§ NetFlow V9 (Custom) Sensor 724 (v7)
§ Oracle SQL Sensor 732 (v7)
§ Packet Sniffer Sensor 740 (v7)
§ Packet Sniffer (Custom) Sensor 748 (v7)
§ Passive Application Performance Sensor 755 (v13.x.4)
§ PerfCounter Custom Sensor 761 (v12.x.3)
§ PerfCounter IIS Application Pool Sensor 768 (v12.x.6)
§ Ping Sensor 775 (v7)
§ Ping Jitter Sensor 781 (v8.3.0)
§ Pingdom Sensor 786 (v8.4.0)
§ POP3 Sensor 792 (v7)
§ POP3 Email Count Sensor 798 (v8.3.0)
§ Port Sensor 804 (v7)
§ Port Range Sensor 811 (v12.x.4)
§ Probe Health Sensor 816 (v9.1.0)
§ QoS (Quality of Service) One Way Sensor 820 (v7)

28.05.2014 303
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ QoS (Quality of Service) Round Trip Sensor 826 (v9.1.0)


§ RADIUS Sensor 832 (v7)
§ RDP (Remote Desktop) Sensor 837 (v7)
§ SCVMM Host Sensor 842 (v12.x.6)
§ SCVMM Virtual Machine Sensor 849 (v12.x.6)
§ Sensor Factory Sensor 856 (v7)
§ sFlow Sensor 871 (v7)
§ sFlow (Custom) Sensor 879 (v7)
§ SFTP Secure File Transfer Protocol Sensor 887 (v12.x.6)
§ Share Disk Free Sensor 893 (v7)
§ SIP Options Ping Sensor 899 (v12.x.1)
§ SMTP Sensor 905 (v7)
§ SMTP&IMAP Round Trip Sensor 911 (v7)
§ SMTP&POP3 Round Trip Sensor 919 (v7)
§ SNMP APC Hardware Sensor 927 (v9.1.0)
§ SNMP Cisco ADSL Sensor 933 (v12.x.1)
§ SNMP Cisco ASA VPN Connections Sensor 938 (v12.x.1)
§ SNMP Cisco ASA VPN Traffic Sensor 943 (v12.x.1)
§ SNMP Cisco ASA VPN Users Sensor 948 (v12.x.5)
§ SNMP Cisco CBQoS Sensor 953 (v13.x.5)
§ SNMP Cisco System Health Sensor 958 (v12.x.4)
§ SNMP Cisco UCS Chassis Sensor 964 (v13.x.8)
§ SNMP Cisco UCS Physical Disk Sensor 970 (v14.1.10)
§ SNMP Cisco UCS System Health Sensor 976 (v13.x.8)
§ SNMP CPU Load Sensor 982 (v12.x.4)
§ SNMP Custom Sensor 987 (v7)
§ SNMP Custom String Sensor 994 (v9.1.0)
§ SNMP Dell Hardware Sensor 1002 (v7)
§ SNMP Dell PowerEdge Physical Disk Sensor 1008 (v12.x.4)
§ SNMP Dell PowerEdge System Health Sensor 1014 (v12.x.4)
§ SNMP Disk Free Sensor 1020 (v12.x.4)
§ SNMP GSA System Health Sensor 1026 (v13.x.5)
§ SNMP Hardware Status Sensor 1031 (v13.x.5)
§ SNMP HP LaserJet Hardware Sensor 1036 (v9.1.0)

304 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ SNMP HP ProLiant Logical Disk Sensor 1042 (v12.x.6)


§ SNMP HP ProLiant Memory Controller Sensor 1048 (v12.x.6)
§ SNMP HP ProLiant Network Interface Sensor 1054 (v12.x.4)
§ SNMP HP ProLiant Physical Disk Sensor 1060 (v12.x.6)
§ SNMP HP ProLiant System Health Sensor 1066 (v12.x.4)
§ SNMP IBM System X Logical Disk Sensor 1072 (v13.x.4)
§ SNMP IBM System X Physical Disk Sensor 1078 (v13.x.4)
§ SNMP IBM System X Physical Memory Sensor 1084 (v13.x.4)
§ SNMP IBM System X System Health Sensor 1090 (v13.x.4)
§ SNMP interSeptor Pro Environment Sensor 1096 (v14.1.10)
§ SNMP LenovoEMC Physical Disk Sensor 1102 (v13.x.8)
§ SNMP LenovoEMC System Health Sensor 1108 (v13.x.8)
§ SNMP Library Sensor 1113 (v7)
§ SNMP Linux Disk Free Sensor 1122 (v8.1.0)
§ SNMP Linux Load Average Sensor 1130 (v8.1.0)
§ SNMP Linux Meminfo Sensor 1135 (v8.1.0)
§ SNMP Linux Physical Disk Sensor 1140 (v13.x.5)
§ SNMP Memory Sensor 1148 (v12.x.4)
§ SNMP NetApp Disk Free Sensor 1154 (v12.x.3)
§ SNMP NetApp Enclosure Sensor 1160 (v12.x.4)
§ SNMP NetApp I/O Sensor 1166 (v12.x.3)
§ SNMP NetApp License Sensor 1172 (v12.x.4)
§ SNMP NetApp Logical Unit Sensor 1178 (v13.x.7)
§ SNMP NetApp Network Interface Sensor 1184 (v12.x.3)
§ SNMP NetApp System Health Sensor 1190 (v12.x.3)
§ SNMP Poseidon Environment Sensor 1196 (v13.x.5)
§ SNMP Printer Sensor 1201 (v14.x.11)
§ SNMP QNAP Logical Disk Sensor 1206 (v13.x.4)
§ SNMP QNAP Physical Disk Sensor 1211 (v13.x.4)
§ SNMP QNAP System Health Sensor 1217 (v13.x.4)
§ SNMP RMON Sensor 1222 (v12.x.1)
§ SNMP SonicWALL System Health Sensor 1228 (v13.x.5)
§ SNMP SonicWALL VPN Traffic Sensor 1233 (v13.x.6)
§ SNMP Synology Logical Disk Sensor 1239 (v13.x.4)

28.05.2014 305
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ SNMP Synology Physical Disk Sensor 1244 (v13.x.4)


§ SNMP Synology System Health Sensor 1249 (v13.x.4)
§ SNMP System Uptime Sensor 1254 (v7)
§ SNMP Traffic Sensor 1259 (v7)
§ SNMP Trap Receiver Sensor 1267 (v7)
§ SNMP Windows Service Sensor 1276 (v13.x.8)
§ SNTP Sensor 1281 (v8.1.0)
§ SSH Disk Free Sensor 1286 (v8.1.0)
§ SSH INodes Free Sensor 1295 (v8.1.1)
§ SSH Load Average Sensor 1301 (v8.1.0)
§ SSH Meminfo Sensor 1307 (v8.1.0)
§ SSH Remote Ping Sensor 1313 (v12.x.1)
§ SSH SAN Logical Disk Sensor 1320 (v14.1.9)
§ SSH SAN Physical Disk Sensor 1327 (v14.1.9)
§ SSH SAN System Health Sensor 1334 (v14.1.9)
§ SSH Script Sensor 1341 (v12.x.1)
§ SSH Script Advanced Sensor 1350 (v12.x.6)
§ SSH VMWare ESX(i) Disk Sensor 1358 (v8.2.0)
§ Syslog Receiver Sensor 1364 (v7)
§ System Health Sensor 1373 (v9.1.0)
§ TFTP Sensor 1377 (v8.1.0)
§ Traceroute Hop Count Sensor 1383 (v8.3.0)
§ Virtuozzo Container Disk Sensor 1389 (v8.2.1)
§ Virtuozzo Container Network Sensor 1395 (v8.2.1)
§ VMware Host Hardware (WBEM) Sensor 1401 (v8.1.0)
§ VMware Host Hardware Status (SOAP) Sensor 1407 (v12.x.1)
§ VMware Host Performance (SOAP) Sensor 1413 (v12.x.1)
§ VMware Virtual Machine (SOAP) Sensor 1419 (v7)
§ WBEM Custom Sensor 1426 (v8.1.0)
§ Windows CPU Load Sensor 1432 (v7)
§ Windows IIS 6.0 SMTP Received Sensor 1438 (v8.1.0)
§ Windows IIS 6.0 SMTP Sent Sensor 1444 (v8.1.0)
§ Windows IIS Application Sensor 1450 (v12.x.1)
§ Windows Last Update Sensor 1457 (v8.3.0)

306 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ Windows Logged In Users Sensor 1463 (v8.3.0)


§ Windows MSMQ Queue Length Sensor 1469 (v8.3.0)
§ Windows Network Card Sensor 1476 (v7)
§ Windows Pagefile Sensor 1483 (v12.x.4)
§ Windows Physical Disk Sensor 1489 (v9.1.0)
§ Windows Print Queue Sensor 1496 (v8.3.0)
§ Windows Registry Sensor 1502 (v9.1.0)
§ Windows Scheduled Task Sensor 1510 (v9.1.1)
§ Windows System Uptime Sensor 1517 (v8.1.0)
§ Windows Updates Status (Powershell) Sensor 1523 (v13.x.6)
§ WMI Custom Sensor 1529 (v7)
§ WMI Custom String Sensor 1536 (v12.x.4)
§ WMI Event Log Sensor 1545 (v7)
§ WMI Exchange Server Sensor 1553 (v7.1.1)
§ WMI Exchange Transport Queue Sensor 1560 (v12.x.1)
§ WMI File Sensor 1567 (v7)
§ WMI Free Disk Space (Multi Drive) Sensor 1573 (v7)
§ WMI HDD Health Sensor 1581 (v12.x.1)
§ WMI Logical Disk Sensor 1587

§ WMI Memory Sensor 1593 (v7)


§ WMI Microsoft SQL Server 2005 Sensor 1598 (v8.1.0)
§ WMI Microsoft SQL Server 2008 Sensor 1607 (v8.1.0)
§ WMI Microsoft SQL Server 2012 Sensor 1615 (v12.x.6)
§ WMI Process Sensor 1623 (v7)
§ WMI Remote Ping Sensor 1629 (v12.x.1)
§ WMI Security Center Sensor 1634 (v9)
§ WMI Service Sensor 1640 (v7)
§ WMI Share Sensor 1646 (v8.1.0)
§ WMI SharePoint Process Sensor 1653 (v12.x.1)
§ WMI Terminal Services (Windows 2008) Sensor 1659 (v8.1.0)
§ WMI Terminal Services (Windows XP/Vista/2003) Sensor 1664 (v8.1.0)
§ WMI UTC Time Sensor 1669 (v9.2.0)
§ WMI Vital System Data (V2) Sensor 1674 (v7)
§ WMI Volume Sensor 1680 (v7)

28.05.2014 307
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
1 List of Available Sensor Types

§ WMI Volume Fragmentation Sensor 1686 (v13.x.8)


§ WMI Windows Version Sensor 1693 (v8.3.0)
§ WSUS Statistics Sensor 1699 (v9.1.0)

More

Did not find what you are looking for? Have a look into the Additional Sensor Types (Custom
Sensors) 1706 section.

308 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
2 Active Directory Replication Errors Sensor

6.8.2 Active Directory Replication Errors Sensor

The Active Directory Replication Errors sensor uses its parent device's Windows credentials to
check domain controllers for replication errors. It can show the number of consecutive sync
failures, if the source is deleted, if the scheduled sync is disabled, when the last sync attempt
took place, the result of the last sync, when there was the last sync success, the number of
modified consecutive sync failures, and the number of pending replication operations.

Please make sure you enter valid domain credentials in the parent device's settings.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Requirement: Member of Windows Domain

This sensor only works if the computer running the PRTG probe is part of the domain whose
AD should be monitored. The probe runs either on the local system (on every node, if on a
cluster probe), or on the system running the remote probe 2050 . If this requirement is not met,
the sensor will fail.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

12.05.2014 309
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
2 Active Directory Replication Errors Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor replications, PRTG will create one sensor for each replication neighbor you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Replication Neighbor Select the replication neighbor whose replication you want to add
a sensor for. A list of all available items is shown with their name.
Select the desired items by adding check marks in front of the
respective lines. One sensor will be created for each selection. You
can also select and deselect all items by using the check box in the
table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

310 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
2 Active Directory Replication Errors Sensor

Sensor Set t ings

Replication Neighbor Shows the replication neighbor whose replication this sensor
monitors. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

12.05.2014 311
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
2 Active Directory Replication Errors Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

312 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
2 Active Directory Replication Errors Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 313
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
2 Active Directory Replication Errors Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

314 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
2 Active Directory Replication Errors Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 315
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
3 ADO SQL Sensor

6.8.3 ADO SQL Sensor

The ADO SQL sensor monitors a database using an ActiveX Data Objects (ADO) connection. It
connects to the server and shows the response time. Additionally, it can read the number of
records and a value.

Note: For security reasons, you can only create a sensor on a device for which Windows
Credentials have been defined. With these credentials, the PRTG probe must be able to
connect to the Windows domain. If you don't enter valid credentials, you will get an Access
denied error message when scanning. For detailed information, please see More 322 section
below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

316 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
3 ADO SQL Sensor

ADO Specific Dat a

Connection String Enter the string that will be used to connect to the database. For
example, such a string could be: Provider=SQLOLEDB.1;Data
Source=10.0.0.200\SQLEXPRESS;User
ID=user;Password=userpass;Initial Catalog=Northwind. For more
information on how to build connection strings, please see More
322 section below.

Dat a

SQL Expression Enter a valid SQL statement to execute on the server. In your
SELECT statement, please specify the field name explicitly. Do not
use SELECT *! For example, a correct expression could be: SELECT
AVG(UnitPrice) FROM Products. When a cursor is returned (i.e. with
a SELECT statement), only the first row of data will be processed.

Record Count If you want to know how many records in your database were
affected by your SQL expression as defined above, you can count
the number of concerned records. Choose between:
§ Do not count number of records: Affected records will not be
counted.
§ Count number of records: The number of affected records will
be counted. Note: Enabling this option might increase the
execution time of this sensor.

Post-Processing If the SQL expression returns a result set, please define if you want
to further process it. Choose between:
§ Ignore result set : Do not do anything with the data returned.
§ Process numerical result : Regard the result set returned as
integer or float. You can set the sensor to Warning or Down
status for specific thresholds. Define below.
§ Process st ring result : Regard the result set returned as a string.
You can set the sensor to error for certain sub-strings contained
or missing. Define below.
§ Monit or for changes: Monitor if the result set has changed
since last check. The sensor will send an internal message
indicating that its value has changed. In combination with a
Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever a sensor value changes.

Condition "Warning" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Warning status. Choose between:

28.05.2014 317
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
3 ADO SQL Sensor

§ none: Do not set the sensor to Warning status for any


condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.
§ does not equal: Result set must be unequal to the value
provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor into a Warning status. Please enter an integer or float
value.

Condition "Down" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Down status. Choose between:
§ none: Do not set the sensor to Down status for any condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.
§ does not equal: Result set must be unequal to the value
provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor to a Down status. Please enter an integer value.

Response Must Include This field is only visible if string results is enabled above. Enter a
string that must be part of the returned SQL string. If it is not, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Response Must Not This field is only visible if string results is enabled above. Enter a
include string that must not be part of the returned SQL string. If it is, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

318 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
3 ADO SQL Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 319
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
3 ADO SQL Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

320 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
3 ADO SQL Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 321
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
3 ADO SQL Sensor

More

Knowledge Base: Monitoring (Almost) Any SQL Server Through ADO with PRTG Network
Monitor
§ http://kb.paessler.com/en/topic/2053

Knowledge Base: How do I correctly configure credentials for ADO SQL sensors?
§ http://kb.paessler.com/en/topic/13103

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

322 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

6.8.4 Amazon CloudWatch Sensor

The Amazon CloudWatch sensor monitors performance of Amazon Cloud services, such as
Elastic Compute Cloud (EC2), Simple Queue Service (SQS), Elastic Load Balancing (ELB), Elastic
Block Store (EBS), Simple Notification Service (SNS), Relational Database Service (RDS), and
ElastiCache.

Depending on the selected service, the sensor can show CPU utilization, network load in and
out, and disk read and write speed.

Note: The CloudWatch option must be enabled for the instance you want to monitor (you can
do this, for example, using Amazon's AWS console). Amazon will charge you (a small amount)
for each "Amazon CloudWatch API Request" query the sensor sends to the Amazon servers.
Depending on the service, each Amazon CloudWatch sensor sends about 10 to 30 requests
with each scanning interval. Last time we checked the Amazon price list, they charged max.
US$ 0.014 per 1,000 requests (depending on your region). Please see More 329 section for
detailed information.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

PRTG will perform a meta scan before you actually add this sensor type and requires basic
information for this scan in advance. Provide the requested information in the appearing
window. During the scan, PRTG will recognize all items available for monitoring based on your
input. The following settings differ in comparison to the sensor's settings page:

28.05.2014 323
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

Amazon Credent ials

Region Select the region in which the instance to be monitored is running.


The settings you make in this dialog are valid for all of the sensors
that are created. Choose between:
§ US East (Nort hern Virginia)
§ US West (Oregon)
§ US West (Nort hern California)
§ EU (Ireland)
§ Asia Pacific (Singapore)
§ Asia Pacific (Toky o)
§ Asia Pacific (Sy dney )
§ Sout h America (Sao Paulo)

Note: The CloudWatch option must be enabled for the instance you
want to monitor (you can do this e.g. using Amazon's AWS
console).

Select which service instances you want to monitor. PRTG will create one sensor for each
instance you choose. The settings you make in this dialog are valid for all of the sensors that
are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Amazon CloudWat ch Specific

Service Instance Select the instances you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

324 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Amazon Credent ials

AWS Access Key ID Enter your access key. You can obtain it from aws.amazon.com.

AWS Secret Access Enter your secret access key. You can obtain it from
Key aws.amazon.com.

Region Shows the region your instance is located at. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Amazon CloudWat ch Specific

Period (Interval) Define in what granularity you want to receive datapoints from
CloudWatch. Choose between:
§ 1 Minut e
§ 2 Minut es
§ 5 Minut es
§ 10 Minut es
§ 30 Minut es
§ 1 Hour

28.05.2014 325
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

Amazon CloudWat ch Specific

Service Shows the service this sensor is monitoring. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Instance Shows the Instance ID of the Amazon Web Services instance this
sensor is monitoring. When using the "Simple Notification Service
(SNS)" service, this field is not visible. Once a sensor is created this
value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

Topic Name This field is only visible if you selected a "Simple Notification Service
(SNS)" instance before. It shows the topic name that is monitored
by this sensor. The sensor will show the number and size of
messages published, and the number of notifications delivered and
failed. Each sensor can monitor one topic name only. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Availability Zone This field is only visible if you selected a "Elastic Load Balancing
(ELB)" instance before. Enter the name of the Availability Zone of
your Load Balancer you want to monitor. If you leave this field
empty, the average value of all zones will be taken.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

326 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Note: For Amazon CloudWatch sensors, the scanning interval cannot be inherited. Please use
the individual settings of the sensor to define the interval in which data is received.

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

28.05.2014 327
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

328 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How do I define access rights for Amazon CloudWatch queries?

28.05.2014 329
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
4 Amazon CloudWatch Sensor

§ http://kb.paessler.com/en/topic/38083

Knowledge Base: How much does Amazon charge for using the CloudWatch API?
§ http://kb.paessler.com/en/topic/37543

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

330 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
5 AVM FRITZ!Box WAN Interface Sensor

6.8.5 AVM FRITZ!Box WAN Interface Sensor

The AVM FRITZ!Box WAN Interface Sensor monitors the internet traffic of a FRITZ!Box internet
access router from European manufacturer AVM. It returns the incoming and outgoing internet
traffic.

Note: There are no credentials necessary, but transmission of status information via Universal
Plug and Play (UPnP) must be enabled in the network settings of your FRITZ!Box. See More 335
section below for detailed information.

Note: This sensor type might not support FRITZ!Boxes with firmware of Kabel Deutschland.
Also, it might only support FRITZ!Boxes until operating system version 6.03. See section More
335 below for details.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

28.05.2014 331
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
5 AVM FRITZ!Box WAN Interface Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

332 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
5 AVM FRITZ!Box WAN Interface Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

28.05.2014 333
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
5 AVM FRITZ!Box WAN Interface Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

334 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
5 AVM FRITZ!Box WAN Interface Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How do I activate UPnP for my Fritz!Box?

28.05.2014 335
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
5 AVM FRITZ!Box WAN Interface Sensor

§ http://kb.paessler.com/en/topic/38603

Knowledge Base: FRITZ!Box Sensor shows 401


§ http://kb.paessler.com/en/topic/59909

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

336 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
6 Cisco IP SLA Sensor

6.8.6 Cisco IP SLA Sensor

The Cisco IP SLA sensor monitors Voice over IP (VoIP) network parameters using IP Service
Level Agreement (SLA) from Cisco via Simple Network Management Protocol (SNMP). It shows
different aspects provided by the queried device.

For a general introduction to the technology behind Quality of Service monitoring, please see
Monit oring Qualit y of Service 1971 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

IP SLA Specific

IP SLAs Select the IP SLAs you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head. The list options
depend on the configuration of the queried device. If you're
missing a type here, please check your device's configuration. PRTG
can support the following operations:
§ echo
§ pat hEcho
§ fileIO
§ script
§ udpEcho
§ t cpConnect
§ ht t p
§ dns
§ jit t er
§ dlsw
§ dhcp
§ ft p
§ pat h-jit t er

07.02.2013 337
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
6 Cisco IP SLA Sensor

IP SLA Specific

Note: Packet Loss values are summarized, but have no explicit


channel for Source—Destination or Destination—Source values

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

IP SLA Specific

ID

Type
These fields show SLA specific settings provided by the queried
SLA device. Once a sensor is created this value cannot be changed.
Name (Tag)
It is shown for reference purposes only. If you need to change this,
please add the sensor anew.
Owner

Frequency

338 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
6 Cisco IP SLA Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

07.02.2013 339
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
6 Cisco IP SLA Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

340 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
6 Cisco IP SLA Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

07.02.2013 341
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
6 Cisco IP SLA Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

342 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
7 Citrix XenServer Host Sensor

6.8.7 Citrix XenServer Host Sensor

The Citrix XenServer Host Sensor monitors a Xen host server via Hypertext Transfer Protocol
(HTTP). It shows CPU, memory, and network usage, as well as the number of running virtual
machines and load average.

Note: The parent device must be a Citrix XenServer (version 5.0 or later).

For this sensor type credentials for Xen servers must be defined for the device you want to
use the sensor on.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Monitoring a XenServer Pool

In a XenServer pool there is one "pool master" that manages the pool. Incoming queries on
any host are automatically forwarded to the pool master. If you want to monitor your virtual
machines, or host servers, simply create respective sensors on a device that represents one
host server of your pool. Internal processes will make sure that monitoring will take place and
continue independently from the physical host. Note: In PRTG's device tree, the sensors for
virtual machines will always remain on the host you originally created it on, also if it is currently
running on a different host.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one host, multiple sensors are created at once in the Add Sensor
dialog. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

07.02.2013 343
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
7 Citrix XenServer Host Sensor

Host Set t ings

Host Select the hosts you want to add a sensor for, including the ones
that are not running. A list of all available items is shown with their
name. Select the desired items by adding check marks in front of
the respective lines. One sensor will be created for each selection.
You can also select and deselect all items by using the check box
in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Host Set t ings

UUID Shows the Universally Unique Identifier (UUID) of the host


monitored by this sensor. Once a sensor is created this value
cannot be changed. It is shown for reference purposes only. If you
need to change this, please add the sensor anew.

Name Shows the name of the host monitored by this sensor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

344 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
7 Citrix XenServer Host Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

07.02.2013 345
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
7 Citrix XenServer Host Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

346 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
7 Citrix XenServer Host Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

07.02.2013 347
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
7 Citrix XenServer Host Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

348 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
8 Citrix XenServer Virtual Machine Sensor

6.8.8 Citrix XenServer Virtual M achine Sensor

The Citrix XenServer Virtual Machine Sensor monitors a virtual machine on a Xen server via
Hypertext Transfer Protocol (HTTP). It shows CPU usage and free memory in percent.

Note: The parent device must be a Citrix XenServer (version 5.0 or later).

For this sensor type credentials for Xen servers must be defined for the device you want to
use the sensor on.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Monitoring a XenServer Pool

In a XenServer pool there is one "pool master" that manages the pool. Incoming queries on
any host are automatically forwarded to the pool master. If you want to monitor your virtual
machines, or host servers, simply create respective sensors on a device that represents one
host server of your pool. Internal processes will make sure that monitoring will take place and
continue independently from the physical host. Note: In PRTG's device tree, the sensors for
virtual machines will always remain on the host you originally created it on, also if it is currently
running on a different host.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Note: PRTG requests a full list of all virtual machines configured on the device. Therefore, it may
take a few seconds before the dialog is loaded.

If you select more than one virtual machine, multiple sensors are created at once in the Add
Sensor dialog. The following settings for this sensor differ in the 'Add Sensor' dialog in
comparison to the sensor's settings page:

07.02.2013 349
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
8 Citrix XenServer Virtual Machine Sensor

Virt ual Machine Set t ings

Virtual Machine Select the Virtual Machine (VM) you want to add a sensor for,
including the ones that are not running. A list of all available items
is shown with their name. Select the desired items by adding check
marks in front of the respective lines. One sensor will be created
for each selection. You can also select and deselect all items by
using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Virt ual Machine Set t ings

UUID Shows the Universally Unique Identifier (UUID) of the virtual


machine. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Name Shows the name of the virtual machine. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

350 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
8 Citrix XenServer Virtual Machine Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

07.02.2013 351
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
8 Citrix XenServer Virtual Machine Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

352 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
8 Citrix XenServer Virtual Machine Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

07.02.2013 353
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
8 Citrix XenServer Virtual Machine Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

354 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
9 Cluster Probe Health Sensor

6.8.9 Cluster Probe Health Sensor

The Cluster Probe Health sensor is a system device indicating PRTG's own system health
status. It is created automatically with a PRTG cluster installation and cannot be deleted. It
measures various internal system parameters of the cluster system and the probe's internal
processes and then computes a resulting value. Frequent or repeated health values below 100
% should be investigated, please check the sensor's channels for details.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

27.11.2012 355
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
9 Cluster Probe Health Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

356 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
9 Cluster Probe Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

27.11.2012 357
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
9 Cluster Probe Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

358 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
10 Core Health Sensor

6.8.10 Core Health Sensor

The Core Health sensor monitors internal PRTG parameters. It shows the state of the PRTG
core server. It is created automatically by PRTG and cannot be deleted. This sensor type
checks various parameters of your PRTG core which have an impact on the stability of the
system:

§ Healt h: This index value sums up the core state into a value between 100% (healthy) and 0%
(failing). Frequent or repeated health values below 100% should be investigated.
§ CPU Load: This channel shows the current percentage CPU load. Extensive CPU load can lead
to false, incomplete, and incorrect monitoring results. This value usually should stay below
50%.
§ Handles: This is a counter for the data structures of the operating system. It is responsible
for internal resource management. Repeated obviously increasing values should be
investigated.
§ Commit t ed Memory : This channel shows the amount of memory committed to the PRTG
core server as reported by the memory manager.
§ Free Page File Memory : This channel shows the amount of free page file memory currently
available on the system. Page file memory is aggregated RAM and the size of page file. It is
the maximum amount of memory that is available on the system to be used for all currently
running processes. If it gets too low the system can crash, at least some applications will
throw "Out of memory" errors.
§ Free Phy sical Memory : This channel shows the amount of free physical memory currently
available on the system. This is the RAM that is physically built-in in the computer. If it gets
too low the system will become very slow and PRTG is not usable in a reasonable way
anymore. It can happen that some sensors will not be displayed correctly in that case, they
will appear disabled (grayed out).
§ Free Virt ual Memory : This channel shows the accessible address space on the system for
PRTG. PRTG cannot use more memory than reported here, independently from free page file
and physical memory. On a 32bit OS (operating system) the maximum is 2 GB (3 GB with
special settings under Windows); on a 64bit OS it is 4 GB if PRTG is running as 32bit version,
and unlimited as 64bit version (only Core). If free virtual memory gets too low, PRTG will
throw "Out of memory" errors or the message "not enough storage to process this
command" (visible in the Core log).
§ Threads: This channel shows the number of program parts which are currently running
simultaneously. This number can increase with heavy load. The number should not exceed
100 in normal operation.

This sensor can be set up on a Probe Device only!

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

03.05.2013 359
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
10 Core Health Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

360 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
10 Core Health Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

03.05.2013 361
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
10 Core Health Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

362 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
11 Dell PowerVault MDi Sensor

6.8.11 Dell PowerVault M Di Sensor

The Dell PowerVault MDi sensor monitors a virtual disk on a Dell PowerVault MD3000i,
MD3620i, MD3000f, or MD3620f. It may work with additional models, too. This sensor can
show current, maximum, and total IOs, current and maximum speed, as well as read and cache
hit percentages.

Requirement: Dell Modular Disk Storage Manager

This sensor requires an installation of Dell's "Modular Disk Storage Manager" program. This has
to be installed on the computer running the PRTG probe: Either on the local system (on every
node, if on a cluster probe), or on the system running the remote probe 2050 . For details about
setup, please see More 367 section below.

Note: Please create this sensor on a device which has the SAN's IP address configured in the
"IP address/DNS name" field.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one disk, multiple sensors are created at once in the Add Sensor
dialog. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Virtual Disks Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

28.05.2014 363
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
11 Dell PowerVault MDi Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Virtual Disk Shows the name of the virtual disk monitored by this sensor. Once
a sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

364 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
11 Dell PowerVault MDi Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

28.05.2014 365
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
11 Dell PowerVault MDi Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

366 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
11 Dell PowerVault MDi Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Where do I find the Dell PowerVault Modular Disk Storage Manager for use with my MDi SAN?
§ http://kb.paessler.com/en/topic/38743

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

28.05.2014 367
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
11 Dell PowerVault MDi Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

368 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
12 DHCP Sensor

6.8.12 DHCP Sensor

The DHCP sensor monitors a Dynamic Host Configuration Protocol (DHCP) server. It sends a
broadcast message to the network and waits for a DHCP server to respond. If a server
responds, the sensor shows both the address of the server and the offered IP in the sensor's
Message field. You can check the server's response using Regular Expressions 2048 . The
sensor's channels include response time (msec) and the lease time given by the server (in
days).

This sensor can be set up on a Probe Device only! On sensor creation, choose the network
card on the probe system which will be used to send the broadcast message.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor DHCP servers, PRTG will create one sensor for each network interface you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

DHCP Specific

Specify Network Select the network adapters you want to add a sensor for. A list of
Interface all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

08.10.2013 369
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
12 DHCP Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

DHCP Specific

MAC Shows the MAC address of the network adapter that is used to
send the broadcast message to the network. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Client IP Specify if you want to check the returned client IP with a regular
expression. Choose between:
§ Don't check: The IP will only appear in the sensor message
without further processes.
§ Check: Enter the regular expression you want to use below.

Client IP Must Include This field will only appear if you chose to check the client IP above.
In the response of the DHCP server, search using a regular
expression. If the answer for the client IP does not contain the
defined string, the sensor will change to a Down status. For
example, enter 10\.0\.5\..* to make sure any answering DHCP
server returns an client IP address starting with "10.0.5.". If it
doesn't, the sensor will show an error. For more details, see
Regular Expressions 2048 section. Leave empty to not use this field.

Client IP Must Not This field will only appear if you chose to check the client IP above.
Include In the response of the DHCP server, search using a regular
expression. If the answer for the client IP contains the defined
string, the sensor will change to a Down status. See example
above. For more details, see Regular Expressions 2048 section.
Leave empty to not use this field.

Server IP Specify if you want to check the returned server IP with a regular
expression. Choose between:

370 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
12 DHCP Sensor

DHCP Specific

§ Don't check: The IP will only appear in the sensor message


without further processes.
§ Check: Enter the regular expression you want to use below.

Server IP Must Include This field will only appear if you chose to check the server IP above.
In the response of the DHCP server, search using a regular
expression. If the answer for the server IP does not contain the
defined string, the sensor will change to a Down status. See
example above. For more details, see Regular Expressions 2048
section. Leave empty to not use this field.

Server IP Must Not This field will only appear if you chose to check the server IP above.
Include In the response of the DHCP server, search using a regular
expression. If the answer for the server IP contains the defined
string, the sensor will change to a Down status. See example
above. For more details, see Regular Expressions 2048 section.
Leave empty to not use this field.

Timeout (sec) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

DHCP Server Change If there is more than one DHCP server in the network that may
answer to the broadcast message, the sensor can receive an
answer from a different DHCP server, compared to the last scan of
the sensor. In this case, PRTG can write an entry to the system
Logs 147 . Choose between:
§ Ignore: Do not write a log entry if the DHCP server changes.
§ Writ e log ent ry : Write an entry to the system Logs whenever
the DHCP server changes between two sensor scans.
Note: Regardless of this setting, those entries will always be added
to the sensor Log.

Offered IP Change If the IP address offered by the DHCP server changes between two
sensor scans, PRTG can write an entry to the system Logs 147 .
Choose between:

§ Ignore: Do not write a log entry if the offered IP address


changes.

§ Writ e log ent ry : Write an entry to the system Logs whenever


the DHCP server offers a different IP address compared to the
last sensor scan.
Note: Regardless of this setting, those entries will always be added
to the sensor Log.

08.10.2013 371
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
12 DHCP Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

372 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
12 DHCP Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

08.10.2013 373
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
12 DHCP Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

374 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
12 DHCP Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

08.10.2013 375
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
13 DNS Sensor

6.8.13 DNS Sensor

The DNS sensor monitors a Domain Name Service (DNS) server. It resolves a domain name and
compares it to a given IP address. The sensor shows the response time and goes to an error
state if the DNS server does not resolve a given domain name correctly.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

DNS Specific

Timeout (sec) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

376 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
13 DNS Sensor

DNS Specific

Port Enter the number of the port the sensor will try to connect to. This
must be the port the sensor's parent device is running the DNS
service on. Usually you will use port 53. We recommend using the
default value. Note: The sensor will connect to the IP Address or
DNS Name value of the device it is created on.

Domain Enter the domain name that will be resolved by the sensor using
the Domain Name Service (DNS) server specified in the sensor's
parent device's settings. You can enter an internet domain name
here (for example, example.com), or a DNS name in your internal
network (such as computer-xyz); depending on the type of DNS
server you will monitor. You can also enter an IP address here.

Query Type Select the type of query that should be sent to the DNS server.
Choose between:
§ Host address IPv4 (A)
§ Host address IPv6 (AAAA)
§ Aut horit at ive name server (NS)
§ St art of a zone of aut horit y marker (SOA)
§ Domain name point er (PTR)
§ Mail exchange (MX )
§ Canonical name for an alias (CNAME)

Check Result Define if the result received from the DNS server will be checked.
Choose between:
§ Ignore result : Any valid answer of the DNS server will be
accepted by the sensor.
§ Check result : Check if the response contains certain strings.
Define below.

Value This field is only visible if result checking is enabled above. Enter
elements that must be contained in the response of the DNS
server. Enter each entry in one line. At least one of the elements
must be contained in the received result. If none of the element
matches the response, the sensor will show a red Down status.
For example, you can enter an IP address here if your Domain field
contains a host name. Only if the host name is resolved to the
correct IP address your sensor will show a green Up status.

Write Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.

27.11.2012 377
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
13 DNS Sensor

DNS Specific

§ Writ e sensor result t o disk (Filename: "Result of Sensor


(ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

378 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
13 DNS Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

27.11.2012 379
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
13 DNS Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

380 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
13 DNS Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 381
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
14 Enterprise Virtual Array Sensor

6.8.14 Enterprise Virtual Array Sensor

The Enterprise Virtual Array sensor monitors an HP StorageWorks Enterprise Virtual Array (EVA)
using the sssu.exe from HP Command View EVA Software. It can show the status of several
EVA modules, for example, status of system, controllers, enclosures, disks, disk groups,
folders, hosts, snapshots, data replication, cabinets, and many more, depending on the
available measurement components. If devices have measuring tools for fans and temperature,
the corresponding data will be displayed as well.

For these EVA components, this sensor type can show the operational status, predicted
failures, accessible media, allocation in percent, availability for VRaids in bytes, exaggerated
bytes, group host access, the number of grouped and ungrouped disks, the age of snapshots,
and the license status.

Note: You have to explicitly specify the credentials of the EVA in the sensor settings.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

Important notice: Currently, this sensor type is in bet a status. The methods of operating can
change at any time, as well as the available settings. Do not expect that all functions will work
properly, or that this sensor works as expected at all. Be aware that this type of sensor can be
removed again from PRTG at any time.

Requirement: Command View

The EVA sensor needs the HP Command View EVA Software to be installed on the probe
system. If you do not want to install the whole command view tool, you can alternatively use
another approach. For details, please see section More 387 .

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

PRTG will perform a meta scan before you actually add this sensor type and requires basic
information for this scan in advance. Provide the requested information in the appearing
window. During the scan, PRTG will recognize all items available for monitoring based on your
input. The following settings differ in comparison to the sensor's settings page:

EVA Credent ials

Scanning Mode Specify the depth of the meta scan. Choose between:
§ Basic: We recommend using this scanning mode. Various
modules of your EVA will be available for monitoring.

382 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
14 Enterprise Virtual Array Sensor

EVA Credent ials

§ Full Det ail: PRTG will scan for each disk of your EVA. Every disk
will be listed in the module selection.

Select which modules you want to monitor. PRTG will create one sensor for each module you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

EVA Set t ings

Modules Select the modules you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 383
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
14 Enterprise Virtual Array Sensor

EVA Credent ials

Username Enter the username for the EVA.

Password Enter the password for the EVA.

EVA Set t ings

Module Shows the monitored module. You can adjust this setting if the
module was renamed or moved to another folder. This way, PRTG
can find the module again and the monitoring history will not be
lost.

System Shows further information about the monitored module. Once a


sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
Module Type
the sensor anew.

Description

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

384 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
14 Enterprise Virtual Array Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

28.05.2014 385
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
14 Enterprise Virtual Array Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

386 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
14 Enterprise Virtual Array Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
HP Command View EVA Software

28.05.2014 387
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
14 Enterprise Virtual Array Sensor

§ http://www8.hp.com/us/en/products/storage-software/product-detail.html?oid=471497
Knowledge Base: Do I really have to install the whole Command View on the probe to use the
EVA sensor?
§ http://kb.paessler.com/en/topic/55983

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

388 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

6.8.15 Event Log (Windows API) Sensor

The Event Log (Windows API) sensor monitors Event Log entries using Windows Application
Programming Interface (API). It shows the number of new records per second (speed).

You can set the sensor to a desired status individually according to a new event log entry. For
details and how to find out the correct filter, see section More 395 .

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 389
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

Windows API Event Log Specific

Log File Specify the log file the sensor will monitor. The Windows event log
provides several different log files which are shown below. Choose
between:
§ Applicat ion
§ Sy st em
§ Securit y
§ Direct ory Service
§ DNS Server
§ File Replicat ion Service

Filt er Event Log Ent ries

Event Type Specify the type of event that will be considered by this sensor.
Other event type will not be processed. Choose between the
following event types:
§ Any
§ Error
§ Warning
§ Informat ion
§ Securit y Audit Success
§ Securit y Audit Failure

Filter by Source Filter all received events for a certain event source. If enabled, only
messages matching the defined value will be considered by the
sensor. Choose between:
· Off: Do not filter by event source.
· On: Enable filtering by event source.

Match String (Event This field is only visible if filtering is enabled above. Enter a source
Source) from which the events are to come from. Only events from a
source matching this string will be regarded, others ignored. Please
enter a string.

Filter by ID Filter all received events for a certain event ID. If enabled, only
messages matching the defined value(s) will be considered by the
sensor. Choose between:
· Off: Do not filter by event ID.

390 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

Filt er Event Log Ent ries

· On: Enable filtering by event ID.

Match Value (Event ID) This field is only visible if filtering is enabled above. Enter one or
more event IDs (comma separated) from which the events are to
come from. Only events with an ID matching one of the values will
be regarded. Please enter one integer value or more comma
separated integer values.

Filter by Category Filter all received events for a certain event category. If enabled,
only messages matching the defined value will be considered by
the sensor. Choose between:
· Off: Do not filter by event category.
· On: Enable filtering by event category.

Match String (Event This field is only visible if filtering is enabled above. Enter a category
Category) which the events are to have. Only events with a category
matching this string will be regarded. Please enter a string.

Filter by Event User Filter all received events for a certain event user. If enabled, only
messages matching the defined value will be considered by the
sensor. Choose between:
· Off: Do not filter by event user.
· On: Enable filtering by event user.

Match String (Event This field is only visible if filtering is enabled above. Enter a user
User) name which the event are to be assigned to. Only events with a
user name matching this string will be regarded. Please enter a
string.

Filter by Event Filter all received events for a certain event computer. If enabled,
Computer only messages matching the defined value will be considered by
the sensor. Choose between:
· Off: Do not filter by event computer.
· On: Enable filtering by event computer.

Match String (Event This field is only visible if filtering is enabled above. Enter a
Computer) computer name which the events are to be assigned to. Only
events with a computer name matching this string will be regarded.
Please enter a string.

Filter by Event Filter all received events for a certain event message. If enabled,
Message only messages matching the defined value will be considered by
the sensor. Choose between:

28.05.2014 391
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

Filt er Event Log Ent ries

· Off: Do not filter by event message.


· On: Enable filtering by event message.

Match String (Event This field is only visible if filtering is enabled above. Enter a message
Message) which the event must contain. Only events with a message
matching this string will be regarded. Please enter a string.

Note: The Event Log (Windows API) Sensor always performs a substring match. Please do not
use any placeholder character. For example, enter RAS for any event source containing this
string in partial or whole form.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

392 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

28.05.2014 393
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

394 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Event Log Sensors: Setting Correct Status and Source Filter
§ http://kb.paessler.com/en/topic/59803

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

28.05.2014 395
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
15 Event Log (Windows API) Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

396 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
16 Exchange Backup (Powershell) Sensor

6.8.16 Exchange Backup (Powershell) Sensor

The Exchange Backup (Powershell) sensor monitors backups of an Exchange server using
Remote PowerShell. It shows several states of an Exchange database backup, for example, the
last full backup, the last differential backup, and if currently a backup is running.

Note: The parent device for this sensor must be an Exchange server version 2010 or higher.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Requirement: Remote PowerShell and Remote Exchange Management Shell

This sensor type uses PowerShell commands. In order to monitor devices with this sensor,
Remot e PowerShell and Remot e Exchange Management Shell have to be enabled on the
server. Ensure that you have installed PowerShell 2.0 or later on your probe machine. For
more information, please see section More below.

Requirement: Fully Qualified Domain Name (FQDN)

In order to connect to Exchange servers, this sensor type needs the fully qualified domain
name (FQDN). In PRTG's device settings of the Exchange server, provide the FQDN instead of
the IP address. For more information, please see section More below.

Requirement: Elevated Rights

The user of this sensor needs elevated rights on the Exchange system. It is not sufficient to
have administrator rights. Please see section More below for detailed information on rights
management.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor backups of Exchange server databases, PRTG will create one sensor for
each database you choose. The settings you make in this dialog are valid for all of the sensors
that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

03.04.2014 397
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
16 Exchange Backup (Powershell) Sensor

Sensor Set t ings

Exchange Databases Select the databases you want to add a sensor for. A list of all
to be monitored on available items is shown with their name. Select the desired items
this server by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Database Shows the name of the monitored database. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.

398 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
16 Exchange Backup (Powershell) Sensor

Sensor Set t ings

§ Writ e sensor result t o disk (Filename: "Result of Sensor


[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

03.04.2014 399
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
16 Exchange Backup (Powershell) Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

400 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
16 Exchange Backup (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

03.04.2014 401
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
16 Exchange Backup (Powershell) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Resolving Exchange PowerShell Sensors Issues
§ http://kb.paessler.com/en/topic/54353
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

402 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
16 Exchange Backup (Powershell) Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.04.2014 403
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
17 Exchange Database (Powershell) Sensor

6.8.17 Exchange Database (Powershell) Sensor

The Exchange Database (Powershell) sensor monitors database information of an Exchange


server using Remote PowerShell. It shows several states of an Exchange database, for
example, its size, if the database is mounted, and if the database is recognized as valid.

Note: The parent device for this sensor must be an Exchange server version 2010 or higher.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Requirement: Remote PowerShell and Remote Exchange Management Shell

This sensor type uses PowerShell commands. In order to monitor devices with this sensor,
Remot e PowerShell and Remot e Exchange Management Shell have to be enabled on the
server. Ensure that you have installed PowerShell 2.0 or later on your probe machine. For
more information, please see section More below.

Requirement: Fully Qualified Domain Name (FQDN)

In order to connect to Exchange servers, this sensor type needs the fully qualified domain
name (FQDN). In PRTG's device settings of the Exchange server, provide the FQDN instead of
the IP address. For more information, please see section More below.

Requirement: Elevated Rights

The user of this sensor needs elevated rights on the Exchange system. It is not sufficient to
have administrator rights. Please see section More below for detailed information on rights
management.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor databases of an Exchange server, PRTG will create one sensor for each
database you choose. The settings you make in this dialog are valid for all of the sensors that
are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

404 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
17 Exchange Database (Powershell) Sensor

Sensor Set t ings

Exchange Databases Select the databases you want to add a sensor for. A list of all
to be monitored on available items is shown with their name. Select the desired items
this server by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Database Shows the name of the monitored database. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

AutoRemount Define if you want the sensor to try to remount the database
Database automatically if it is unmounted. Choose between:
§ Try t o remount
§ Just report t he current reading, keep unmount ed if so

03.04.2014 405
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
17 Exchange Database (Powershell) Sensor

Sensor Set t ings

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

406 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
17 Exchange Database (Powershell) Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

03.04.2014 407
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
17 Exchange Database (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

408 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
17 Exchange Database (Powershell) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Resolving Exchange PowerShell Sensors Issues
§ http://kb.paessler.com/en/topic/54353
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

03.04.2014 409
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
17 Exchange Database (Powershell) Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

410 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
18 Exchange Mailbox (Powershell) Sensor

6.8.18 Exchange M ailbox (Powershell) Sensor

The Exchange Mailbox (Powershell) sensor monitors mailboxes of an Exchange server using
Remote PowerShell. It shows several states of a mailbox, for example, total size of items, the
number of items, and the time of the last login.

Note: The parent device for this sensor must be an Exchange server version 2010 or higher.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Requirement: Remote PowerShell and Remote Exchange Management Shell

This sensor type uses PowerShell commands. In order to monitor devices with this sensor,
Remot e PowerShell and Remot e Exchange Management Shell have to be enabled on the
server. Ensure that you have installed PowerShell 2.0 or later on your probe machine. For
more information, please see section More below.

Requirement: Fully Qualified Domain Name (FQDN)

In order to connect to Exchange servers, this sensor type needs the fully qualified domain
name (FQDN). In PRTG's device settings of the Exchange server, provide the FQDN instead of
the IP address. For more information, please see section More below.

Requirement: Elevated Rights

The user of this sensor needs elevated rights on the Exchange system. It is not sufficient to
have administrator rights. Please see section More below for detailed information on rights
management.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor mailboxes of Exchange servers, PRTG will create one sensor for each
mailbox you choose. The settings you make in this dialog are valid for all of the sensors that
are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

03.04.2014 411
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
18 Exchange Mailbox (Powershell) Sensor

Sensor Set t ings

Mailboxes to be Select the mailboxes you want to add a sensor for. A list of all
monitored available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Mailbox Name Shows the name of the monitored mailbox. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.

412 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
18 Exchange Mailbox (Powershell) Sensor

Sensor Set t ings

§ Writ e sensor result t o disk (Filename: "Result of Sensor


[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

03.04.2014 413
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
18 Exchange Mailbox (Powershell) Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

414 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
18 Exchange Mailbox (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

03.04.2014 415
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
18 Exchange Mailbox (Powershell) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Resolving Exchange PowerShell Sensors Issues
§ http://kb.paessler.com/en/topic/54353
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

416 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
18 Exchange Mailbox (Powershell) Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.04.2014 417
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
19 Exchange Mail Queue (Powershell) Sensor

6.8.19 Exchange M ail Queue (Powershell) Sensor

The Exchange Mail Queue (Powershell) sensor monitors the number of items in the outgoing
mail queue of an Exchange server using Remote PowerShell. It shows, for example, queued
mails, retrying mails, unreachable mails, and poisonous mails. See section More 423 below for
an explanation of the transport queue types.

Note: The parent device for this sensor must be an Exchange server version 2010 or higher.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Requirement: Remote PowerShell and Remote Exchange Management Shell

This sensor type uses PowerShell commands. In order to monitor devices with this sensor,
Remot e PowerShell and Remot e Exchange Management Shell have to be enabled on the
server. Ensure that you have installed PowerShell 2.0 or later on your probe machine. For
more information, please see section More below.

Requirement: Fully Qualified Domain Name (FQDN)

In order to connect to Exchange servers, this sensor type needs the fully qualified domain
name (FQDN). In PRTG's device settings of the Exchange server, provide the FQDN instead of
the IP address. For more information, please see section More below.

Requirement: Elevated Rights

The user of this sensor needs elevated rights on the Exchange system. It is not sufficient to
have administrator rights. Please see section More below for detailed information on rights
management.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor message queues of Exchange servers, PRTG will create one sensor for
each role you choose. The settings you make in this dialog are valid for all of the sensors that
are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

418 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
19 Exchange Mail Queue (Powershell) Sensor

Sensor Set t ings

Hub-Transport or Edge- Select the roles you want to add a sensor for. A list of all available
Server items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

28.05.2014 419
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
19 Exchange Mail Queue (Powershell) Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

420 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
19 Exchange Mail Queue (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

28.05.2014 421
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
19 Exchange Mail Queue (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

422 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
19 Exchange Mail Queue (Powershell) Sensor

More

Knowledge Base: Resolving Exchange PowerShell Sensors Issues


§ http://kb.paessler.com/en/topic/54353
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745
Knowledge Base: Types of Transport Queues in Microsoft Exchange
§ http://kb.paessler.com/en/topic/55413

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 423
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
20 Exchange Public Folder (Powershell) Sensor

6.8.20 Exchange Public Folder (Powershell) Sensor

The Exchange Public Folder (Powershell) sensor monitors public folders of an Exchange server
using Remote PowerShell. It shows several states of a public folder, for example, its total size,
the number of items, and the time of the last access.

Note: The parent device for this sensor must be an Exchange server version 2010 or higher.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Requirement: Remote PowerShell and Remote Exchange Management Shell

This sensor type uses PowerShell commands. In order to monitor devices with this sensor,
Remot e PowerShell and Remot e Exchange Management Shell have to be enabled on the
server. Ensure that you have installed PowerShell 2.0 or later on your probe machine. For
more information, please see section More below.

Requirement: Fully Qualified Domain Name (FQDN)

In order to connect to Exchange servers, this sensor type needs the fully qualified domain
name (FQDN). In PRTG's device settings of the Exchange server, provide the FQDN instead of
the IP address. For more information, please see section More below.

Requirement: Elevated Rights

The user of this sensor needs elevated rights on the Exchange system. It is not sufficient to
have administrator rights. Please see section More below for detailed information on rights
management.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor public folders of Exchange servers, PRTG will create one sensor for each
folder you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

424 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
20 Exchange Public Folder (Powershell) Sensor

Sensor Set t ings

Public Folder Select the folders you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Public Folder Shows the name of the monitored folder. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.

03.04.2014 425
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
20 Exchange Public Folder (Powershell) Sensor

Sensor Set t ings

§ Writ e sensor result t o disk (Filename: "Result of Sensor


[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

426 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
20 Exchange Public Folder (Powershell) Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

03.04.2014 427
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
20 Exchange Public Folder (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

428 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
20 Exchange Public Folder (Powershell) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Resolving Exchange PowerShell Sensors Issues
§ http://kb.paessler.com/en/topic/54353
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

03.04.2014 429
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
20 Exchange Public Folder (Powershell) Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

430 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

6.8.21 EXE/Script Sensor

The EXE/Script sensor runs an executable file (EXE, DLL) or a script (batch file, VBScript,
Powershell) on the computer running the local or remote probe. This option is provided as
part of PRTG's Application Programming Interface (API). The sensor shows the execution time,
and can show one value returned by the executable file or script (in one channel only). For
details about the return value format please see the Applicat ion Programming Int erface
(API) Definit ion 2031 .

Note: The executable or script file must be stored on the system of the probe the sensor is
created on: If used on a remote probe, the file must be stored on the system running the
remote probe. In a cluster setup, please copy the file to every cluster node.

Note: If you want to execute a custom Windows Management Instrumentation Query Language
(WQL) script, please use the WMI Cust om Sensor 1529 .

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

19.07.2013 431
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

Sensor Set t ings

Script Select an executable file from the list. It will be executed with every
scanning interval. In this list, files in the corresponding /Cust om
Sensors/EX E sub-directory of the probe system's PRTG program
directory are shown (see Dat a St orage 2074 ). In order for the files
to appear in this list, please store them into this folder. Store files
ending in BAT, CMD, DLL, EXE, PS1, and VBS. In order for the sensor
to show the expected values and sensor status, your files must
use the right format for the returned values (in this case,
value:message to standard output). The file's exitcode will
determine the sensor status. For detailed information on how to
build custom sensors and for the expected return format, please
see the API documentation (Applicat ion Programming Int erface
(API) Definit ion 2031 ). There, find detailed information the the
"Custom Sensors" tab.
Note: Please do not use the folder \Custom Sensors\Powershell
Scripts to store your files. This remnant from previous software
versions is not used any more and may usually be deleted.
Note: When using custom sensors on the Clust er Probe, please
copy your files to every cluster node installation.

Value Type Define what kind of values your executable or script file gives back.
Choose between:
§ Int eger: An integer is expected as return value. If the script gives
back a float, PRTG will display the value 0.
§ Float : A float is expected as return value, with a dot (.) between
pre-decimal position and decimal places. In this setting, the
sensor will also display integer values unless they don't produce
a buffer overflow.
§ Count er: Your script returns an integer which increases. PRTG
will show the difference between the values of two sensor
scans. Note: A counter must return an integer; float is not
supported here!

Channel Name Enter a name for the channel in which the returned values will be
shown. This is for display purposes only. Please enter a string.

Unit String Enter a string describing the unit of the returned values. This is for
display purposes only. Please enter a string.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

432 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

EXE/Script Shows the executable or script file that is executed with each
sensor scan, as defined on sensor creation. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Parameters If your executable or script file catches command line parameters,


you can define them here. Placeholders can be used as well. For a
full list of all placeholders please see the API documentation
(Applicat ion Programming Int erface (API) Definit ion 2031 ). Note:
Please make sure you write the placeholders in quotes to ensure
that they are working properly if their values contain blanks. Use
single quotation marks ' ' with PowerShell scripts, and double
quotes " " with all others. Please enter a string or leave the field
empty.

Environment Choose if PRTG's command line parameters will also be available as


environment parameters.
§ Default Environment : Do not provide PRTG placeholders' values
in the environment. Choose this secure option if you're not sure.

19.07.2013 433
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

Sensor Set t ings

§ Set placeholders as environment values: From within your


executable or script, the values of PRTG's command line
parameters will be available via environment variables. For
example, you can then read and use the current host value of the
PRTG device this EXE/script sensor is created on from within your
script. This option can mean a security risk, because also
credentials are provided in several variables. For a full list of all
available variables please see the API documentation
(Applicat ion Programming Int erface (API) Definit ion 2031 ).

Security Context Define the Windows user account that will be used to run the
executable or script file. Choose between:
§ Use securit y cont ext of probe service: Run the selected file
under the same Windows user account the probe is running on.
By default, this is the Windows system user account (if not
manually changed).
§ Use Windows credent ials of parent device: Use the Windows
user account defined in the settings of the parent device this
sensor is created on. Please go to sensor's parent device's
settings to change these Windows credentials.

Mutex Name Define any desired mutex name for the process. All EXE/Script
sensors having the same mutex name will be executed serially (not
simultaneously). This is useful if you use a lot of sensors and want
to avoid high resource usage caused by processes running
simultaneously. For links to more information, please see the More
438 section below. Please enter a string or leave the field empty.

Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the external process is killed and an error message
is triggered.

Value Type Shows the expected value type, chosen on sensor creation. Once
a sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew. Note: The sensor cannot handle string values.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
§ Ignore changes (default ): No action will be taken on change.
§ Trigger 'On Change' not ificat ion: The sensor will send an
internal message indicating that its value has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the sensor value changes.

434 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

Sensor Set t ings

EXE Result Define what will be done with the result the executable file gives
back. Choose between:
§ Discard EX E result : Do not store the requested web page.
§ Writ e EX E result t o disk: Store the last result received from the
script with the file name "Result of Sensor [ID].txt" to the "Logs
(Sensors)" directory (on the Master node, if in a cluster). This is
for debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.
§ Writ e EX E result t o disk in case of error: Store the last result
received from the script only if the sensor is in a down status.
The file name is "Result of Sensor [ID].txt" in the "Logs (Sensors)"
directory. Enable this option if you do not want failures to be
overwritten by a following success of the script.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

19.07.2013 435
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

436 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

19.07.2013 437
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Information about custom scripts and executables

438 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
21 EXE/Script Sensor

§ Applicat ion Programming Int erface (API) Definit ion 2031

§ Addit ional Sensor Ty pes (Cust om Sensors) 1706

Knowledge Base: What is the Mutex Name in PRTG's EXE/Script Sensor's settings?
§ http://kb.paessler.com/en/topic/6673

Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Knowledge Base: How can I test if parameters are correctly transmitted to my script when
using an EXE/Script sensor?
§ http://kb.paessler.com/en/topic/11283

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

19.07.2013 439
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

6.8.22 EXE/Script Advanced Sensor

The EXE/Script Advanced sensor runs an executable file (EXE, DLL) or a script (batch file,
VBScript, Powershell) on the computer running the local or remote probe. This option is
provided as part of PRTG's Application Programming Interface (API). The sensor can show values
returned by the executable file or script in multiple channels. The return value of this sensor
must be valid XML. For details about the return value format please see the Applicat ion
Programming Int erface (API) Definit ion 2031 .

Note: The executable or script file must be stored on the system of the probe the sensor is
created on: If used on a remote probe, the file must be stored on the system running the
remote probe. In a cluster setup, please copy the file to every cluster node.

Note: If you want to execute a custom Windows Management Instrumentation Query Language
(WQL) script, please use the WMI Cust om Sensor 1529 .

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

EXE/Script Select an executable file from the list. It will be executed with every
scanning interval. In this list, files in the corresponding /Cust om
Sensors/EX EX ML sub-directory of the probe system's PRTG
program directory are shown (see Dat a St orage 2074 ). In order for
the files to appear in this list, please store them into this folder.
Store files ending in BAT, CMD, DLL, EXE, PS1, and VBS. In order for
the sensor to show the expected values and sensor status, your
files must return the expected XML format to standard output.
Values and message must be embedded in the XML. For detailed
information on how to build custom sensors and for the expected
return format, please see the API documentation (Applicat ion
Programming Int erface (API) Definit ion 2031 ). There, find detailed
information the the "Custom Sensors" tab.

440 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

Sensor Set t ings

Note: Please do not use the folder \Custom Sensors\Powershell


Scripts to store your files. This remnant from previous software
versions is not used any more and may usually be deleted.
Note: When using custom sensors on the Clust er Probe, please
copy your files to every cluster node installation.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

EXE/Script Shows the executable or script file


that is executed with each sensor
scan, as defined on sensor creation.
Once a sensor is created this value
cannot be changed. It is shown for
reference purposes only. If you need
to change this, please add the sensor
anew.

12.05.2014 441
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

Parameters If your executable or script file catches


command line parameters, you can
define them here. Placeholders can be
used as well. For a full list of all
placeholders please see the API
documentation (Applicat ion
Programming Int erface (API)
Definit ion 2031 ). Note: Please make
sure you write the placeholders in
quotes to ensure that they are
working properly if their values
contain blanks. Use single quotation
marks ' ' with PowerShell scripts, and
double quotes " " with all others.
Please enter a string or leave the field
empty.

Environment Choose if PRTG's command line


parameters will also be available as
environment parameters.
§ Default Environment : Do not
provide PRTG placeholders' values in
the environment. Choose this
secure option if you're not sure.
§ Set placeholders as environment
values: From within your executable
or script, the values of PRTG's
command line parameters will be
available via environment variables.
For example, you can then read and
use the current host value of the
PRTG device this EXE/script sensor
is created on from within your
script. This option can mean a
security risk, because also
credentials are provided in several
variables. For a full list of all available
variables please see the API
documentation (Applicat ion
Programming Int erface (API)
Definit ion 2031 ).

Security Context Define the Windows user account that


will be used to run the executable or
script file. Choose between:
§ Use securit y cont ext of probe
service: Run the selected file under
the same Windows user account the
probe is running on. By default, this
is the Windows system user account
(if not manually changed).

442 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

§ Use Windows credent ials of


parent device: Use the Windows
user account defined in the settings
of the parent device this sensor is
created on. Please go to sensor's
parent device's settings to change
these Windows credentials.

Mutex Name Define any desired mutex name for


the process. All EXE/Script sensors
having the same mutex name will be
executed serially (not simultaneously).
This is useful if you use a lot of
sensors and want to avoid high
resource usage caused by processes
running simultaneously. For links to
more information, please see the
More 447 section below. Please enter a
string or leave the field empty.

Timeout (sec.) Enter a timeout in seconds for the


request. If the reply takes longer than
this value the external process is
killed and an error message is
triggered.

EXE Result Define what will be done with the


results the executable file gives back.
Choose between:
§ Discard EX E result : Do not store
the requested web page.
§ Writ e EX E result t o disk: Store the
last result received from the script
with the file name "Result of Sensor
[ID].txt" to the "Logs (Sensors)"
directory (on the Master node, if in a
cluster). This is for debugging
purposes. The file will be overridden
with each scanning interval. For
information on how to find the
folder used for storage, please see
Dat a St orage 2074 section.

12.05.2014 443
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

§ Writ e EX E result t o disk in case of


error: Store the last result received
from the script only if the sensor is
in a down status. The file name is
"Result of Sensor [ID].txt" in the
"Logs (Sensors)" directory. Enable
this option if you do not want
failures to be overwritten by a
following success of the script.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Note: The St ack Unit option for stacking graphs will only work if you explicitly define the
same <unit> for at least two channels. For detailed information about sensor settings please
see the API documentation (Applicat ion Programming Int erface (API) Definit ion 2031 ).

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

444 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

12.05.2014 445
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

446 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Information about custom scripts and executables

12.05.2014 447
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
22 EXE/Script Advanced Sensor

§ Applicat ion Programming Int erface (API) Definit ion 2031

§ Addit ional Sensor Ty pes (Cust om Sensors) 1706

Knowledge Base: What is the Mutex Name in PRTG's EXE/Script Sensor's settings?
§ http://kb.paessler.com/en/topic/6673

Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Knowledge Base: How can I test if parameters are correctly transmitted to my script when
using an EXE/Script sensor?
§ http://kb.paessler.com/en/topic/11283

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

448 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
23 File Sensor

6.8.23 File Sensor

The File sensor monitors a file located on the probe's local disk, or a file accessible via Server
Message Block (SMB). You can monitor file content and file time stamp changes. The sensor
shows the file size, and a last modified value in days and hours.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 449
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
23 File Sensor

Sensor Specific

File Name Enter the full path to the file this sensor will monitor. For example,
enter C:\Windows\file.txt. If the file is located on a network device
use the Uniform Naming Convention (UNC) path without the server
part (you would only enter share\folder\file.txt). The server part (\
\server\) is taken from this sensor's parent device's settings. Please
enter a valid path and file name. Note: In order to provide any
shares, the LanmanServer "Server" Windows service must be
running on the target computer.

Check If Specify when the sensor will send an alert. Choose between:
§ File exist s: The sensor will send an alert if the file does not exist.
§ File does not exist : The sensor will send an alert if the file
exists.

Monitor File Content Specify if the sensor will send a change notification when the
content of the file changes (based on a checksum). Choose
between:
§ Ignore changes: No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Monitor File Time Specify if the sensor will send a change notification when the
Stamp content of the file's time stamp changes. Choose between:
§ Ignore changes: No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

450 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
23 File Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 451
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
23 File Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

452 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
23 File Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 453
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
23 File Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: What can I do if PRTG doesn't succeed with monitoring a share? PE029 PE032
§ http://kb.paessler.com/en/topic/513

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

454 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
24 File Content Sensor

6.8.24 File Content Sensor

The File Content sensor checks a text file for certain strings and returns the line number of the
last match and the number of total matches. Additionally, matching lines are quoted in the
sensor message field.

Note: This sensor does not support UTF-16 encoded files! In this case, please try use a custom
sensor like the EX E/Script Sensor 431 or the EX E/Script Advanced Sensor 440 .

Note: This sensor supports Unix line feeds.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 455
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
24 File Content Sensor

Sensor Set t ings

File Name Enter the full path to the file this sensor will monitor. For example,
enter C:\Windows\file.txt. If the file is located on a network device
use the Uniform Naming Convention (UNC) path without the server
part (you would only enter share\folder\file.txt). The server part (\
\server\) is taken from this sensor's parent device's settings. Please
enter a valid path and file name. Note: In order to provide any
shares, the LanmanServer "Server" Windows service must be
running on the target computer. Note: If you define a file on your
network here, please be aware that this might produce high
network traffic, because PRTG will query the entire file with every
scanning interval.

Search String Define the string inside the log file you would like to check for. The
input is not case-sensitive. Please enter a string.

Search Method Define the method you want to provide the search string with. The
pattern must be contained in one line and only the last matching
line will be given back. Choose between:
§ Simple st ring search: Search for a simple string.
§ Regular Expression: Search using a regular expression. For
more details, see Regular Expressions 2048 section.

Warning Behaviour Define under which condition the sensor will show a Warning
status. Choose between:
§ Go int o warning st at us when st ring is not found: The sensor
will show a Warning status if there is no match. Otherwise it will
remain in Up status.
§ Go int o warning st at us when st ring is found: The sensor will
show a Warning status if there is a match. Otherwise it will remain
in Up status.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
§ Ignore changes: No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

456 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
24 File Content Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 457
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
24 File Content Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

458 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
24 File Content Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 459
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
24 File Content Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

460 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
25 Folder Sensor

6.8.25 Folder Sensor

The Folder sensor monitors a folder using Server Message Block (SMB). You can monitor file
changes and file ages. It shows the folder size and file count, as well as the oldest and newest
file value in days and hours.

Note: The Folder sensor counts all files in a folder, including hidden files.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 461
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
25 Folder Sensor

Folder Monit or

Folder Name Enter the full path to the folder this sensor will monitor. For
example, enter C:\Windows. If the file is located on a network
device, use the Uniform Naming Convention (UNC) path without the
server part (you would only enter share\folder). The server part (\
\server\) is taken from this sensor's parent device's settings. Please
enter a valid path name. Note: In order to provide any shares, the
LanmanServer "Server" Windows service must be running on the
target computer.

Sub-Folder Recursion Specify if subfolders will be included in the monitoring. Choose


between:
· Do not recurse sub-folders: Only monitor the folder specified
above; do not monitor its subfolders.
· Monit or t he folder and it s sub-folders (use wit h caut ion!):
Monitor the folder specified above and all of its subfolders. Note:
Recursing sub-folders in large directories with a high number of
branches may evoke timeout errors or performance issues.

Monitor Folder Specify if the sensor will send a change notification when the
Changes content of the folder changes. Choose between:
· Ignore changes: Changes to the folder will not trigger a change
notification.
· Trigger 'On Change' not ificat ion: The sensor will trigger a
change notification if a file changes its timestamp or filename, or if
there are new or deleted files.

Check of File Ages Specify if the sensor will monitor the folder for certain file ages.
Choose between:
· Don't check: Do not check for the age of the files in the
specified folder(s).
· Show Warning if older: Set the sensor to warning status if one
of the files in the specified folder is older than a specific time unit.
· Show Error if older: Set the sensor to error status if one of the
files in the specified folder is older than a specific time unit.
· Show Warning if y ounger: Set the sensor to warning status if
one of the files in the specified folder is younger than a specific
time unit.
· Show Error if y ounger: Set the sensor to error status if one of
the files in the specified folder is younger than a specific time
unit.

File Age Limit This field is only visible if a file age check is enabled above. Enter
the age of a file in the folder that will trigger the sensor's status
change if undershot respectively overrun. Please enter an integer
value. The value will be interpreted as days, hours, or minutes;
according to your setting below.
462 28.05.2014

File Age Limit Unit This field is only visible if a file age check is enabled above. Specify
the unit for the file age value you entered above. Choose between:
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
25 Folder Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 463
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
25 Folder Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

464 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
25 Folder Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 465
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
25 Folder Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: What can I do if PRTG doesn't succeed with monitoring a share? PE029 PE032
§ http://kb.paessler.com/en/topic/513

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

466 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
26 FTP Sensor

6.8.26 FTP Sensor

The FTP sensor monitors file servers using File Transfer Protocol (FTP) and FTP over SSL (FTPS).
It shows the response time.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Specific

Timeout (Sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered. The highest timeout supported is 900 seconds (15
minutes). Please enter an integer value.

14.01.2014 467
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
26 FTP Sensor

Sensor Specific

Port Enter the number of the port the sensor will try to connect to. For
non-secure connections usually port 21 is used, for implicit secure
connections usually port 990. Please enter an integer value. We
recommend using the default value. If you do not get a connection,
please try another port number.

FTP Mode Specify which FTP mode will be used for the connection. Choose
between:
§ Use act ive mode
§ Use passive mode
We recommend using the default value. If you do not get a
connection, please try the passive mode.

Aut hent icat ion

Username Enter a username for the FTP login. Please enter a string or leave
the field empty.

Password Enter a password for the FTP login. Please enter a string or leave
the field empty.

TLS (Transport-Level- Specify if an encryption will be used for the connection. Choose
Security) between:
§ Don't use SSL (Basic FTP, recommended): In most cases, you
will use basic FTP without encryption.
§ Use Explicit SSL/TLS if available: The sensor will try to connect
via Explicit SSL. If SSL/TLS is not supported by the server, the
sensor will try to connect without SSL/TLS and is set to Up if this
works. If the server supports SSL/TLS but the connection fails
(for example, due to a TLS handshake failure), the sensor will turn
into Down status.
§ Enforce Explicit SSL/TLS: The connection must be established
using Explicit SSL/TLS. Otherwise, the sensor will go into Down
status.
§ Use Implicit SSL/TLS: The sensor will try to connect using
Implicit SSL/TLS. Negotiating authentication and security is not
allowed in implicit mode.The client is expected to challenge the
FTP server with a TLS/SSL ClientHello message. If the server does
not receive such a message, it will drop the connection. The
sensor will go into Down status.

468 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
26 FTP Sensor

Aut hent icat ion

Note: Ensure that you choose the method your FTP server uses! If
your server uses Implicit SSL/TLS, the Explicit SSL/TLS connection
will not work.

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

14.01.2014 469
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
26 FTP Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

470 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
26 FTP Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 471
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
26 FTP Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

472 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
27 FTP Server File Count Sensor

6.8.27 FTP Server File Count Sensor

The FTP Server File Count sensor logs in to an FTP server and returns the number of files
available in the directory listing.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Channel Name Enter a name for the channel in which the returned values will be
shown. This is for display purposes only. Please enter a string.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

07.02.2013 473
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
27 FTP Server File Count Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

FTP URL Enter the URL to check (this sensor does not use the IP Address/
DNS value of the parent device).

Username Define the username for the login. Please enter a string.

Password Define the password for the login. Please enter a string.

Count Only New Files Define if only new files will be counted. Choose between:
§ No: Always show the total number of files.
§ Yes: Show the number of new files since the last scanning
interval. Note: With the next sensor scan, any new files from the
previous scan will be regarded as old.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
§ Ignore changes: No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

474 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
27 FTP Server File Count Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

07.02.2013 475
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
27 FTP Server File Count Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

476 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
27 FTP Server File Count Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

07.02.2013 477
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
27 FTP Server File Count Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

478 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
28 Google Analytics Sensor

6.8.28 Google Analy tics Sensor

The Google Analytics sensor queries data from a Google Analytics account via Hypertext
Transfer Protocol (HTTP). It shows the values for different metrics in different sensor channels.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

28.05.2014 479
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
28 Google Analytics Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Google Analy t ics Set t ings

Period (Interval) Enter how often the sensor will query data. Choose between:
§ 1 Day
§ 2 Day s
§ 3 Day s
§ 1 Week

Username Please enter the username of the Google Analytics account you
want to query. Please enter a string.

Password Please enter the password of the Google Analytics account you
want to query. Please enter a string.

Profile ID Enter the 8-digits profile ID of the Google Analytics account. For
help, please see More 484 section below.

Metrics Enter a comma separated list with all metrics you want to query. A
default set of metrics is already predefined. For help, please see
More 484 section below.

Days Define for how many days the sensor will query data. Enter 1 to
query yesterday's data only, or define any number of days. Please
enter an integer value.

Average Define if the sensor will query averaged data. Select between:
§ Use: Query averaged data. This setting only takes effect if your
entered more than "1" in the Day s setting above. Data will be
averaged over the number of days.
§ Don't use: Do not query averaged data, but receive raw data.

480 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
28 Google Analytics Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Note: For Google Analytics sensors, the scanning interval cannot be inherited. Please use the
individual settings of the sensor to define the interval in which data is received.

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 481
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
28 Google Analytics Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

482 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
28 Google Analytics Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 483
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
28 Google Analytics Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

More
Knowledge Base: Where do I find my Google Analytics profile ID?
§ http://kb.paessler.com/en/topic/35363

Knowledge Base: Where do I find available Google Analytics metrics?

484 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
28 Google Analytics Sensor

§ http://kb.paessler.com/en/topic/35373

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 485
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
29 HTTP Sensor

6.8.29 HTTP Sensor

The HTTP sensor monitors a web server using Hypertext Transfer Protocol (HTTP). It shows the
loading time. This is the easiest way to monitor if a website (or a specific website element) is
reachable.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HTTP Specific

Timeout (Sec.) Enter a timeout in seconds for the HTTP request. If the reply takes
longer than this value the request is aborted and an error message
is triggered. The maximum value is 900 seconds (15 minutes).

486 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
29 HTTP Sensor

HTTP Specific

URL Please enter the URL the sensor will connect to. It has to be URL
encoded! If you enter an absolute URL, this address will be
independent from the IP address/DNS name setting of the device
this sensor is created on. You can enter an URL leading to a
webpage (to measure the page source code's loading time), or
enter the URL of an image or of another page asset to measure
this element's availability and loading time. PRTG uses a smart URL
replacement which allows you to use the parent device's IP
address/DNS name setting as part of the URL. For more
information, please see section Smart URL Replacement below.

Request Method The request method determines how the given URL is requested.
§ GET: Request the website directly, like browsing the web. We
recommend using this setting for a simple check of a web page.
§ POST: Send post form data to the URL. If this setting is chosen,
you must enter the data that will be sent in the Post dat a field
below.
§ HEAD: Only request the HTTP header from the server; without the
actual web page. Although this saves bandwidth since less data
is transferred, it is not recommended because the measured
request time is not the one experienced by your users and you
might not be notified for slow results or timeouts.

Postdata This field is only visible when POST is selected in the Request
Met hod setting above. Please enter the data part for the POST
request here. Note: No XML is allowed here!

Content Type This setting is only visible when POST is selected in the Request
Met hod setting above. Define the content type of a POST request.
Choose between:
§ Default (applicat ion/x-www-form-urlencoded): This is the
default content type used to encode the form data set for
submission to the server.
§ Cust om: If you need another content type than default, enter
this content type below.

Custom Content Type This field is only visible when Cust om is selected above. Define the
content type which is needed, e.g., XML, JSON, HTTP.

SSL Specific

SSL Method This setting is relevant only when using https in the URL field. We
recommend using the default value. If you experience connection
problems, please select another SSL method from the list. Choose
between:

14.01.2014 487
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
29 HTTP Sensor

SSL Specific

§ SSL V2
§ SSL V2 or V3: This is the default setting.
§ SSL V3
§ TLS V1
Note: Other TLS versions are not supported.

Note: This sensor type implicitly supports Server Name Identification (SNI), an extension to the
TLS protocol.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

488 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
29 HTTP Sensor

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

14.01.2014 489
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
29 HTTP Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

490 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
29 HTTP Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

14.01.2014 491
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
29 HTTP Sensor

Smart URL Replacement

Instead of entering a complete address in the URL field of an HTTP sensor, you can merely
enter the protocol followed by colon and three slashes (that means you can enter either
http:/// or https:/// or even a simple slash / as equivalent for http:///). PRTG will then fill in the
parent device's IP address or DNS name in front of the third slash automatically. Whether this
results in a valid URL or not, depends on the IP address or DNS name of the device where this
HTTP sensor is created on. In combination with cloning devices, the smart URL replacement
makes it easy to create many like devices.

For example, if you create a device with DNS name www.example.com and you put an HTTP
sensor on it, you can provide values the following ways:

§ Providing the value https:/// in the URL field, PRTG will automatically create the URL https://
www.example.com/ from that.
§ Using the value /help in the URL field, PRTG will automatically create and monitor the URL
http://www.example.com/help
§ It is also possible to provide a port number in the URL field which will be taken over by the
device's DNS name and internally added, for example, http://:8080/

Note: Smart URL replacement does not work for sensors running on the "Probe Device".

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

492 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

6.8.30 HTTP Advanced Sensor

The HTTP Advanced sensor monitors the source code of a web page using Hypertext Transfer
Protocol (HTTP). It supports authentication, content checks, and other advanced parameters. It
shows the loading time, bytes received, download bandwidth (speed), and time to first byte.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HTTP Specific

Timeout (Sec.) Enter a timeout in seconds for the HTTP request. If the reply takes
longer than this value the request is aborted and an error message
is triggered. The maximum value is 900 seconds (15 minutes).

28.05.2014 493
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

HTTP Specific

URL Please enter the URL the sensor will connect to. It has to be URL
encoded! If you enter an absolute URL, this address will be
independent from the IP address/DNS name setting of the device
this sensor is created on. You can enter an URL leading to a
webpage (to measure the page source code's loading time), or
enter the URL of an image or of another page asset to measure
this element's availability and loading time. PRTG uses a smart URL
replacement which allows you to use the parent device's IP
address/DNS name setting as part of the URL. For more
information, please see section Smart URL Replacement below.

Request Method The request method determines how the given URL is requested.
§ GET: Request the website directly, like browsing the web. We
recommend using this setting for a simple check of a web page.
§ POST: Send post form data to the URL. If this setting is chosen,
you must enter the data that will be sent in the Post dat a field
below.
§ HEAD: Only request the HTTP header from the server; without the
actual web page. Although this saves bandwidth since less data
is transferred, it is not recommended because the measured
request time is not the one experienced by your users and you
might not be notified for slow results or timeouts.

Postdata This field is only visible when POST is selected in the Request
Met hod setting above. Please enter the data part for the POST
request here. Note: No XML is allowed here!

Content Type This setting is only visible when POST is selected in the Request
Met hod setting above. Define the content type of a POST request.
Choose between:
§ Default (applicat ion/x-www-form-urlencoded): This is the
default content type used to encode the form data set for
submission to the server.
§ Cust om: If you need another content type than default, enter
this content type below.

Custom Content Type This field is only visible when Cust om is selected above. Define the
content type which is needed, e.g., XML, JSON, HTTP.

HTTP Engine

Monitoring Engine If you encounter unexpected errors with the standard method that
is used to monitor an URL, try to use the compatibility mode which
is based on .Net (introduced in PRTG v13.x.7). Choose between:

494 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

HTTP Engine

§ Default /High Performance (recommended): This is the default


monitoring method for this sensor type.
§ Alt ernat e/Compat ibilit y Mode: Try this method as an
alternative for websites that do not work with the default
approach. Using the compatibility mode, this sensor will execute
an external exe. Thus, this method will need more resources, but
it can be helpful in particular cases. Note: If you select the
compatibility mode, the options for the SSL method will be
slightly different. You can also check for trusted certificates.
Please see below.
Note: When using the Compatibility Mode, Smart URL
Replacement will not work, i.e., this sensor does not use the IP
Address/DNS value of the parent device automatically then.

SSL Specific

SSL Method This setting is relevant only when using https in the URL field. We
recommend using the default value. If you experience connection
problems, please select another SSL method from the list. Choose
between:
§ SSL V2
§ SSL V2 or V3: This is the default setting.
§ SSL V3
§ TLS V1
Note: Other TLS versions are not supported.

SSL Specific (when using Compat ibilit y Mode)

SSL Method When using the compatibility mode, the SSL specific settings are a
bit different to the default SSL settings. SSL V2 is not available. You
can choose between:

§ SSL V3
§ TLS V1
§ SSL V3 or TLS V1: This is the default setting.

Check SSL Certificates Specify if the certificate of the monitored URL will be checked.
Choose between:
§ Do not check used cert ificat es: This the default setting.

28.05.2014 495
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

SSL Specific (when using Compat ibilit y Mode)

§ Check if t he used cert ificat es are t rust ed: If the certificate of


the server is not trusted, the sensor will go into a Down status
and display a corresponding message.

Note: This sensor type implicitly supports Server Name Identification (SNI), an extension to the
TLS protocol.

Advanced Sensor Dat a

Protocol Version Define the HTTP protocol version that will be used when
connecting to the URL. Choose between:
§ HTTP 1.0
§ HTTP 1.1: This is the default setting.

User Agent Choose which user agent string will be sent by this sensor when
connecting to the URL defined above. Choose between:
§ Use PRTG's Default St ring: Do not enter a specific user agent,
use default setting. Usually, this is: Mozilla/5.0 (compatible; PRTG
Network Monitor (www.paessler.com); Windows)
§ Use a Cust om St ring: Use a custom user agent. Define below.

Custom User Agent This field is only visible if custom user agent is enabled above. Enter
a string which will be used as user agent when connecting to the
URL specified above.

Content Changes Define what will be done in case the content of the monitored web
page (element) changes. You can choose between:

· Ignore changes: No action will be taken on change.


· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that the web page content has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the web page content
changes.

Check For Existing Key Define whether the the result at the configured URL will be
Words (Positive) checked for keywords. Choose between:
§ Disable: Do not search for keywords.
§ Enable key word check (posit ive): In the result returned at the
URL, check if a key word exists.
Note: The content check is only intended for html websites and
might not work with other target URLs.

496 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Advanced Sensor Dat a

Response Must Include This field is only visible if keyword checking is enabled above.
Define which string must be part of the source code at the given
URL. You can either enter plain text or a Regular Expression 2048 . If
the data does not include the search pattern, the sensor will be set
to an error state. Please enter a string.

For Key Word Search Define in which format you have entered the search expression in
Use the field above.

§ Plain Text : Search for the string as plain text. The characters *
and ? work here as placeholder, whereas * stands for no or any
number of characters and ? stands for exactly one character (as
known from Windows search). This behavior cannot be disabled,
so the literal search for these characters is not possible with
plain text search.

§ Regular Expression: Treat the search pattern as a Regular


Expression 2048 .

Check For Existing Key Define whether the the result at the configured URL will be
Words (Negative) checked for keywords. Choose between:
§ Disable: Do not search for keywords.
§ Enable key word check (negat ive): In the result returned at the
URL, check if a key word does not exist.
Note: The content check is only intended for html websites and
might not work with other target URLs.

Response must not This field is only visible if keyword checking is enabled above.
include Define which string must not be part of the source code at the
given URL. You can either enter plain text or a Regular Expression
2048 . If the data does include this string, the sensor will be set to an

error state. Please enter a string.

For Key Word Search Define in which format you have entered the search expression in
Use the field above.
§ Plain Text : Search for the string as plain text. The characters *
and ? work here as placeholder, whereas * stands for no or any
number of characters and ? stands for exactly one character (as
known from Windows search). This behavior cannot be disabled,
so the literal search for these characters is not possible with
plain text search.
§ Regular Expression: Treat the search pattern as a Regular
Expression 2048 .

28.05.2014 497
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Advanced Sensor Dat a

Limit Download (kb) Enter a maximum amount of data that will be transferred per every
single request. If you set content checks, please be aware that
only the content downloaded up to this limit can be checked for
search expressions.

Result Handling Define what will be done with the web page loaded at the given
URL. Choose between:

· Discard HTML result : Do not store the requested web page.


· St ore lat est HTML result : Store the last result of the requested
web page to the "Logs (Sensors)" directory (on the Master node,
if in a cluster). This is for debugging purposes, especially in
combination with content checks. The file will be overridden with
each scanning interval. For information on how to find the folder
used for storage, please see Dat a St orage 2074 section.

Note: This sensor loads the source code at the given URL. If you set up a content check, only
this source code is checked for the keywords. The code is not necessarily identical to the one
used to display the page when opening the same URL in a web browser, as there may be a
reload configured or certain information may be inserted after loading, e.g. via Javascript. PRTG
does not follow links to embedded objects nor does it execute scripts. Only the first page at
the given URL is loaded and checked against the expressions configured. For debugging,
please use the Result option to write the source code file to disk and look up what exactly
PRTG gets when calling the URL. If the URL configured does not point to a web page, but to a
binary file, for example, to an image, you usually won't check for content.

Aut hent icat ion

Authentication Define if the web page at the configured URL need authentication.
Choose between:
§ No aut hent icat ion needed
§ Web page needs aut hent icat ion

User This field is only visible if authentication is enabled above. Enter a


username. Please enter a string.

Password This field is only visible if authentication is enabled above. Enter a


password. Please enter a string.

Authentication Method This field is only visible if authentication is enabled above. Please
select the authentication method the given URL is protected with.
Choose between:

498 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Aut hent icat ion

· Basic access aut hent icat ion (HTTP): Use simple HTTP
authentication. This is the default setting and suitable for most
cases. Note: This authentication method will transmit credentials
as plain text!
· Windows NT LAN Manager (NTLM): Use the Microsoft NTLM
protocol for authentication. This is sometimes used in Intranets
for single sign-on.
We recommend using the default value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

28.05.2014 499
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

500 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

28.05.2014 501
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

502 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Smart URL Replacement

Instead of entering a complete address in the URL field of an HTTP sensor, you can merely
enter the protocol followed by colon and three slashes (that means you can enter either
http:/// or https:/// or even a simple slash / as equivalent for http:///). PRTG will then fill in the
parent device's IP address or DNS name in front of the third slash automatically. Whether this
results in a valid URL or not, depends on the IP address or DNS name of the device where this
HTTP sensor is created on. In combination with cloning devices, the smart URL replacement
makes it easy to create many like devices.

For example, if you create a device with DNS name www.example.com and you put an HTTP
sensor on it, you can provide values the following ways:

§ Providing the value https:/// in the URL field, PRTG will automatically create the URL https://
www.example.com/ from that.
§ Using the value /help in the URL field, PRTG will automatically create and monitor the URL
http://www.example.com/help
§ It is also possible to provide a port number in the URL field which will be taken over by the
device's DNS name and internally added, for example, http://:8080/

Note: Smart URL replacement does not work for sensors running on the "Probe Device".

More
Knowledge Base: Which user agent should I use in the HTTP Advanced sensor's settings?
§ http://kb.paessler.com/en/topic/30593

28.05.2014 503
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
30 HTTP Advanced Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

504 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
31 HTTP Apache ModStatus PerfStats Sensor

6.8.31 HTTP Apache M odStatus PerfStats Sensor

The HTTP Apache ModStatus PerfStats sensor monitors performance statistics of an Apache
web server using mod_status over HTTP. It can show the CPU load, the uptime (in seconds), the
requests per second, the bytes per request, and the number of current busy and idle worker
threads of the Apache at scan time.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HTTP Specific

Timeout (Sec.) Enter a timeout in seconds for the HTTP request. If the reply takes
longer than this value the request is aborted and an error message
is triggered. The maximum value is 900 seconds (15 minutes).

24.10.2013 505
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
31 HTTP Apache ModStatus PerfStats Sensor

HTTP Specific

URL Please enter the URL to the mod_status module on your Apache
server; PRTG will append a "/server_status?auto" part automatically.
If you enter an absolute URL, this address will be independent from
the IP address/DNS name setting of the device this sensor is
created on. PRTG uses a smart URL replacement which allows you
to use the parent device's IP address/DNS name setting as part of
the URL. For more information, please see section Smart URL
Replacement below.

SSL Specific

SSL Method This setting is relevant only when using https in the URL field. We
recommend using the default value. If you experience connection
problems, please select another SSL method from the list. Choose
between:
§ SSL V2
§ SSL V2 or V3: This is the default setting.
§ SSL V3
§ TLS V1
Note: Other TLS versions are not supported.

Note: This sensor type implicitly supports Server Name Identification (SNI), an extension to the
TLS protocol.

Aut hent icat ion

Authentication Define if the web page at the configured URL need authentication.
Choose between:
§ No aut hent icat ion needed
§ Web page needs aut hent icat ion

User This field is only visible if authentication is enabled above. Enter a


username. Please enter a string.

Password This field is only visible if authentication is enabled above. Enter a


password. Please enter a string.

Authentication Method This field is only visible if authentication is enabled above. Please
select the authentication method the given URL is protected with.
Choose between:

506 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
31 HTTP Apache ModStatus PerfStats Sensor

Aut hent icat ion

· Basic access aut hent icat ion (HTTP): Use simple HTTP
authentication. This is the default setting and suitable for most
cases. Note: This authentication method will transmit credentials
as plain text!
· Windows NT LAN Manager (NTLM): Use the Microsoft NTLM
protocol for authentication. This is sometimes used in Intranets
for single sign-on.
We recommend using the default value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

24.10.2013 507
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
31 HTTP Apache ModStatus PerfStats Sensor

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

508 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
31 HTTP Apache ModStatus PerfStats Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

24.10.2013 509
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
31 HTTP Apache ModStatus PerfStats Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

510 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
31 HTTP Apache ModStatus PerfStats Sensor

Smart URL Replacement

Instead of entering a complete address in the URL field of an HTTP sensor, you can merely
enter the protocol followed by colon and three slashes (that means you can enter either
http:/// or https:/// or even a simple slash / as equivalent for http:///). PRTG will then fill in the
parent device's IP address or DNS name in front of the third slash automatically. Whether this
results in a valid URL or not, depends on the IP address or DNS name of the device where this
HTTP sensor is created on. In combination with cloning devices, the smart URL replacement
makes it easy to create many like devices.

For example, if you create a device with DNS name www.example.com and you put an HTTP
sensor on it, you can provide values the following ways:

§ Providing the value https:/// in the URL field, PRTG will automatically create the URL https://
www.example.com/ from that.
§ Using the value /help in the URL field, PRTG will automatically create and monitor the URL
http://www.example.com/help
§ It is also possible to provide a port number in the URL field which will be taken over by the
device's DNS name and internally added, for example, http://:8080/

Note: Smart URL replacement does not work for sensors running on the "Probe Device".

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

24.10.2013 511
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
32 HTTP Apache ModStatus Totals Sensor

6.8.32 HTTP Apache M odStatus Totals Sensor

The HTTP Apache ModStatus Totals sensor monitors accesses and transfered data (in kBytes)
of an Apache web server using mod_status over HTTP.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HTTP Specific

Timeout (Sec.) Enter a timeout in seconds for the HTTP request. If the reply takes
longer than this value the request is aborted and an error message
is triggered. The maximum value is 900 seconds (15 minutes).

512 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
32 HTTP Apache ModStatus Totals Sensor

HTTP Specific

URL Please enter the URL to the mod_status module on your Apache
server; PRTG will append a "/server_status?auto" part automatically.
If you enter an absolute URL, this address will be independent from
the IP address/DNS name setting of the device this sensor is
created on. PRTG uses a smart URL replacement which allows you
to use the parent device's IP address/DNS name setting as part of
the URL. For more information, please see section Smart URL
Replacement below.

SSL Specific

SSL Method This setting is relevant only when using https in the URL field. We
recommend using the default value. If you experience connection
problems, please select another SSL method from the list. Choose
between:
§ SSL V2
§ SSL V2 or V3: This is the default setting.
§ SSL V3
§ TLS V1
Note: Other TLS versions are not supported.

Note: This sensor type implicitly supports Server Name Identification (SNI), an extension to the
TLS protocol.

Aut hent icat ion

Authentication Define if the web page at the configured URL need authentication.
Choose between:
§ No aut hent icat ion needed
§ Web page needs aut hent icat ion

User This field is only visible if authentication is enabled above. Enter a


username. Please enter a string.

Password This field is only visible if authentication is enabled above. Enter a


password. Please enter a string.

Authentication Method This field is only visible if authentication is enabled above. Please
select the authentication method the given URL is protected with.
Choose between:

24.10.2013 513
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
32 HTTP Apache ModStatus Totals Sensor

Aut hent icat ion

· Basic access aut hent icat ion (HTTP): Use simple HTTP
authentication. This is the default setting and suitable for most
cases. Note: This authentication method will transmit credentials
as plain text!
· Windows NT LAN Manager (NTLM): Use the Microsoft NTLM
protocol for authentication. This is sometimes used in Intranets
for single sign-on.
We recommend using the default value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

514 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
32 HTTP Apache ModStatus Totals Sensor

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

24.10.2013 515
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
32 HTTP Apache ModStatus Totals Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

516 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
32 HTTP Apache ModStatus Totals Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

24.10.2013 517
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
32 HTTP Apache ModStatus Totals Sensor

Smart URL Replacement

Instead of entering a complete address in the URL field of an HTTP sensor, you can merely
enter the protocol followed by colon and three slashes (that means you can enter either
http:/// or https:/// or even a simple slash / as equivalent for http:///). PRTG will then fill in the
parent device's IP address or DNS name in front of the third slash automatically. Whether this
results in a valid URL or not, depends on the IP address or DNS name of the device where this
HTTP sensor is created on. In combination with cloning devices, the smart URL replacement
makes it easy to create many like devices.

For example, if you create a device with DNS name www.example.com and you put an HTTP
sensor on it, you can provide values the following ways:

§ Providing the value https:/// in the URL field, PRTG will automatically create the URL https://
www.example.com/ from that.
§ Using the value /help in the URL field, PRTG will automatically create and monitor the URL
http://www.example.com/help
§ It is also possible to provide a port number in the URL field which will be taken over by the
device's DNS name and internally added, for example, http://:8080/

Note: Smart URL replacement does not work for sensors running on the "Probe Device".

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

518 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

6.8.33 HTTP Content Sensor

The HTTP Content sensor monitors a numerical value returned by a Hypertext Transfer Protocol
(HTTP) request. In the returned HTML page, each value must be placed between square
brackets [ ].

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

HTTP Specific

Value Type Define what kind of values your HTML file gives back. Choose
between:
§ Int eger: An integer is expected as return value.
§ Float : A float is expected as return value, with a dot (.) between
pre-decimal position and decimal places. In this setting, the
sensor will also display integer values unless they don't produce
a buffer overflow.
Note: The sensor cannot handle string values.

Number of Channels Define how many values your HTML file gives back. Each value will
be handled in its own sensor channel. Each value must be placed
between square brackets [ ]. Enter the number of bracket-value
pairs that will be returned at the defined URL. Note: Do not enter a
number less than the number of values returned. Otherwise you
will get an error message.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

28.05.2014 519
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HTTP Specific

Timeout (Sec.) Enter a timeout in seconds for the HTTP request. If the reply takes
longer than this value the request is aborted and an error message
is triggered. The maximum value is 900 seconds (15 minutes).

Script URL Please enter the URL the sensor will connect to. It has to be URL
encoded! If you enter an absolute URL, this address will be
independent from the IP address/DNS name setting of the device
this sensor is created on. PRTG uses a smart URL replacement
which allows you to use the parent device's IP address/DNS name
setting as part of the URL. For more information, please see
section Smart URL Replacement below.

Value Type The kind of values the HTML file gives back. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

SSL Specific

SSL Method This setting is relevant only when using https in the URL field. We
recommend using the default value. If you experience connection
problems, please select another SSL method from the list. Choose
between:
§ SSL V2
§ SSL V2 or V3: This is the default setting.
§ SSL V3

520 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

SSL Specific

§ TLS V1
Note: Other TLS versions are not supported.

Note: This sensor type implicitly supports Server Name Identification (SNI), an extension to the
TLS protocol.

Advanced Sensor Dat a

Content Changes Define what will be done in case the content of the monitored web
page changes. You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that the web page content has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the web page content
changes.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
(ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Aut hent icat ion

Authentication Define if the web page at the configured URL need authentication.
Choose between:
§ No aut hent icat ion needed
§ Web page needs aut hent icat ion

User This field is only visible if authentication is enabled above. Enter a


username. Please enter a string.

Password This field is only visible if authentication is enabled above. Enter a


password. Please enter a string.

28.05.2014 521
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

Aut hent icat ion

Authentication Method This field is only visible if authentication is enabled above. Please
select the authentication method the given URL is protected with.
Choose between:
· Basic access aut hent icat ion (HTTP): Use simple HTTP
authentication. This is the default setting and suitable for most
cases. Note: This authentication method will transmit credentials
as plain text!

· Windows NT LAN Manager (NTLM): Use the Microsoft NTLM


protocol for authentication. This is sometimes used in Intranets
for single sign-on.
We recommend using the default value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

522 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

Example

At the URL http://www.example.com/status.html a PHP script is giving back the current


system status in a simple HTML page, as follows:
<html>
<body>
Description: Script gives back current status of disk free (%) and CPU usage (%).
[85.5][12.0]
</body>
</html>

You would configure the HTTP Content sensor using the mentioned script URL, value type
Float , and number of channels 2. The sensor will call the URL with every scanning interval
and only regard the two values in square brackets [ ], handling each of them in one sensor
channel. The additional description text and HTML tags are not necessary; in this example
they are added in case a human calls the URL.

Note: If you define the number of channels as 1, only the first value will be read by the
sensor; the second value will be ignored. Using 3 as number of channels will result in a
sensor error message.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

28.05.2014 523
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

524 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

28.05.2014 525
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

526 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
33 HTTP Content Sensor

Smart URL Replacement

Instead of entering a complete address in the URL field of an HTTP sensor, you can merely
enter the protocol followed by colon and three slashes (that means you can enter either
http:/// or https:/// or even a simple slash / as equivalent for http:///). PRTG will then fill in the
parent device's IP address or DNS name in front of the third slash automatically. Whether this
results in a valid URL or not, depends on the IP address or DNS name of the device where this
HTTP sensor is created on. In combination with cloning devices, the smart URL replacement
makes it easy to create many like devices.

For example, if you create a device with DNS name www.example.com and you put an HTTP
sensor on it, you can provide values the following ways:

§ Providing the value https:/// in the URL field, PRTG will automatically create the URL https://
www.example.com/ from that.
§ Using the value /help in the URL field, PRTG will automatically create and monitor the URL
http://www.example.com/help
§ It is also possible to provide a port number in the URL field which will be taken over by the
device's DNS name and internally added, for example, http://:8080/

Note: Smart URL replacement does not work for sensors running on the "Probe Device".

More
Knowledge Base article: How can I monitor internal values of a web application with PRTG?
· http://kb.paessler.com/en/topic/4

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 527
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

6.8.34 HTTP Full Web Page Sensor

The HTTP Full Web Page sensor monitors the full download time of a web page including assets
such as images etc. In the background, it opens the web page in a browser instance to
perform the measurement. Links are not followed. The sensor shows the loading time of the
full page. Note: Be careful with this sensor, as it can generate considerable internet traffic if
used with a low scanning interval!

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

528 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

Full Page Download Set t ings

Timeout (Sec.) Enter a timeout in seconds for the HTTP request. If the reply takes
longer than this value the request is aborted and an error message
is triggered. The maximum value is 900 seconds (15 minutes).

URL Please enter the URL the sensor will load. It has to be URL
encoded! If you enter an absolute URL, this address will be
independent from the IP address/DNS name setting of the device
this sensor is created on. PRTG uses a smart URL replacement
which allows you to use the parent device's IP address/DNS name
setting as part of the URL. For more information, please see
section Smart URL Replacement below.

Browser Engine Define which browser will be used to load the web page. Choose
between:
§ Chromium (recommended): Use the "WebKit" engine that is
delivered with PRTG to perform the loading test. With each
scanning interval, PRTG will load the URL defined above in an
instance of "Chromium" and measure the time until the page is
fully loaded. This is the recommended setting.
§ Phant omJS (Headless Webkit ): Use the "PhantomJS" engine. This
engine can have a high impact on your probe system's CPU and
memory load, but there are additional options for result handling
available (see below).
§ Int ernet Explorer: With each scanning interval, the URL defined
above is loaded in the background in an instance of Internet
Explorer. PRTG uses the Internet Explorer of the system running
the PRTG probe. Note: For full functionality we strongly
recommend installing Internet Explorer 8 or higher on the system
running the PRTG probe. The probe machine is either the local
system (on every node, if on a cluster probe), or the system
running the remote probe 2050 on which the sensor is created on.
Note: For all browser engines, the same proxy settings are used
that are configured for the Windows user account the PRTG probe
is running on (this is usually the Windows local "system" user
account, if not changed). Those settings are accessible via the
Internet Explorer of this system. If you want to e.g. use a proxy for
this full web page sensor test, please adjust the Internet Explorer's
settings accordingly (on the computer running the probe; on all
nodes, if in a cluster).

Security Context Define the Windows user account that will be used to run the
browser engine. Choose between:
§ Use securit y cont ext of probe service (default ): Run the
browser engine under the same Windows user account the
probe is running on. By default, this is the local Windows "system"
user account (if not manually changed).

28.05.2014 529
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

Full Page Download Set t ings

§ Use Windows credent ials of parent device: Use the Windows


user account defined in the settings of the parent device this
sensor is created on. Please go to the sensor's parent device's
settings to change the Windows credentials. Note: When using
the Chromium browser engine above, this is the recommended
setting here.

Result Handling This setting is only visible if the PhantomJS engine is selected
above. This browser engine can render and store screenshots of
the loaded web page. Choose between:
§ Discard loaded web page (recommended): Do not store the
requested web page.
§ St ore lat est screenshot of t he web page: Render and store
the last result of the web page to the "Logs (Sensors)" directory
(on the remote system, when used on a remote probe; on the
Master node, if in a cluster). This is for debugging purposes. The
file will be overridden with each scanning interval. It will be named
after the pattern "Fullpage of Sensor (ID).jpg". For information on
how to find the folder used for storage, please see Dat a
St orage 2074 section.
§ St ore ongoing screenshot s of t he web page (use wit h
caut ion!): Render and store one new screenshot of the web
page with each sensor scan, and store the pictures in the
"Screenshots (Fullpage Sensor)" directory (on the remote system,
when used on a remote probe). For information on how to find
the folder used for storage, please see Dat a St orage 2074
section. This option can be used to create a visual history of the
web page. Note: Depending on the monitored website and the
scanning interval of the sensor, a very high amount of data can
be created! Use with care, and make sure you set appropriate
data purging limits in the Sy st em Administ rat ion—Core &
Probes 1852 settings.
Note: If necessary, you can change the window size of the
rendered screenshots. See section More 534 for details.

Authentication This setting is only visible if the PhantomJS engine is selected


above. Define if the monitored web page needs authentication for
access. Choose between:
§ No aut hent icat ion needed: Access to the web page is granted
without authentication.
§ Web page needs aut hent icat ion: PRTG will automatically try
using HTTP Basic authentication (BA) or Windows NT LAN Manager
(NTLM) to access the web page with authentication. Enter the
credentials below. Note: The option basic access authentication
will forward the credentials in plain text!

530 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

Full Page Download Set t ings

User This setting is only visible if the PhantomJS engine with


authentication is selected above. Enter the user name for the web
page.

Password This setting is only visible if the PhantomJS engine with


authentication is selected above. Enter the password for the web
page.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.

28.05.2014 531
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

Schedules, Dependencies, and Maint enance Window

§ Set up a one-t ime maint enance window: Pause monitoring


within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

532 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 533
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

Smart URL Replacement

Instead of entering a complete address in the URL field of an HTTP sensor, you can merely
enter the protocol followed by colon and three slashes (that means you can enter either
http:/// or https:/// or even a simple slash / as equivalent for http:///). PRTG will then fill in the
parent device's IP address or DNS name in front of the third slash automatically. Whether this
results in a valid URL or not, depends on the IP address or DNS name of the device where this
HTTP sensor is created on. In combination with cloning devices, the smart URL replacement
makes it easy to create many like devices.

For example, if you create a device with DNS name www.example.com and you put an HTTP
sensor on it, you can provide values the following ways:

§ Providing the value https:/// in the URL field, PRTG will automatically create the URL https://
www.example.com/ from that.
§ Using the value /help in the URL field, PRTG will automatically create and monitor the URL
http://www.example.com/help
§ It is also possible to provide a port number in the URL field which will be taken over by the
device's DNS name and internally added, for example, http://:8080/

Note: Smart URL replacement does not work for sensors running on the "Probe Device".

More
Knowledge Base: What to do when I see a CreateUniqueTempDir() error message for my HTTP
Full Webpage Sensor?
§ http://kb.paessler.com/en/topic/40783

Knowledge Base: HTTP Full Web Page sensor is "unable to navigate". What can I do?
§ http://kb.paessler.com/en/topic/59999

Knowledge Base: How can I change the size of PhantomJS full web page screenshots?
§ http://kb.paessler.com/en/topic/60247

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

534 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
34 HTTP Full Web Page Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 535
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
35 HTTP Push Count Sensor

6.8.35 HTTP Push Count Sensor

The HTTP Push Count sensor counts received messages which are pushed via an Hypertext
Transfer Protocol (HTTP) request to the PRTG server. It provides a URL that can be used to
push messages to the PRTG server using HTTP.

This function is known as webhook. Basically, a webhook works like a push notification:
Webhooks are usually triggered by some event (for example, a new comment to a blog post)
and send according information to a specified URL. The HTTP Push Count sensor then displays
the number of pushed and received messages.

Use the following URL to receive the HTTP requests of the webhook:

ht t p://<probe_ip>:<port_number>/<token>

Replace the parameters <probe_ip>, <port_number>, and <token> with the corresponding
values. You can define port number and identification token in the sensor settings; the "probe
IP" is the IP address of the system your PRTG probe with the sensor is running on.

Example: http://127.0.0.1:5050/XYZ123

Note: You can use several sensors with the same port and identification token. In this case,
the number of push messages will be shown in each of these sensors.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

536 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
35 HTTP Push Count Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HTTP Push

Request Method Select the request method of your webhook:


§ ANY: Do not use any filter for the request method.
§ GET: Choose this method if your webhook uses GET.
§ POST: Choose this method if your webhook sends post form
data.

Port Enter the port number on which this sensor listens for incoming
HTTP requests. Default is 5050.

Identification Token This is the token that is used to find the matching sensor for the
incoming message. While you create the sensor, this token is
{__guid__}. It will be replaced with an automatically generated token
after you have completed the sensor creation. If you want to use
another identification token, you can edit it while or after sensor
creation. Note: The token will not be replaced automatically if you
change it already during sensor creation.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

03.04.2014 537
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
35 HTTP Push Count Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

538 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
35 HTTP Push Count Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

03.04.2014 539
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
35 HTTP Push Count Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

540 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
35 HTTP Push Count Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.04.2014 541
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
36 HTTP Push Data Sensor

6.8.36 HTTP Push Data Sensor

The HTTP Push Data sensor displays data from received messages which are pushed via an
Hypertext Transfer Protocol (HTTP) request to the PRTG server. It provides a URL that can be
used to push messages to the PRTG server using HTTP.

This function is known as webhook. Basically, a webhook works like a push notification:
Webhooks are usually triggered by some event (for example, a new comment to a blog post)
and send according information to a specified URL. The HTTP Push Data sensor then displays
the data of pushed and received messages.

Use the following URL to receive the HTTP requests of the webhook:

ht t p://<probe_ip>:<port_number>/<token>?value=<integer_or_float>&t ext =<text message>

Replace the parameters <probe_ip>, <port_number>, <token>, and <integer_or_float> with the
corresponding values. The &t ext parameter is optional: You can omit it.

§ You can define port number and ident ificat ion t oken in the sensor settings.
§ The probe IP is the IP address of the system on which your PRTG probe with this sensor is
running on.
§ The value can be an integer or a float value, depending on the data of your application; you
have to set the value type accordingly in the sensor settings. This parameter will be the
sensor value.
Note: If this parameter is missing, the sensor status will be set into a down status.
§ You can opt ionally add a custom text message by replacing the parameter <text message>
with it. The text will be shown as sensor message. If there is no value but only a text, the
text will be shown as error message.
Note: This text message has to be URL encoded (for example, the whitespaces in the sample
URL below); most browsers achieve this automatically.

Example:
http://127.0.0.1:5050/XYZ123?value=0&text=this%20is%20a%20message

Note: You can use several sensors with the same port and identification token. In this case,
the data of push messages will be shown in each of these sensors.

Important notice: Currently, this sensor type is in bet a status. The methods of operating can
change at any time, as well as the available settings. Do not expect that all functions will work
properly, or that this sensor works as expected at all. Be aware that this type of sensor can be
removed again from PRTG at any time.

542 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
36 HTTP Push Data Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 543
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
36 HTTP Push Data Sensor

HTTP Push

Request Method Select the request method of your webhook:


§ ANY: Do not use any filter for the request method.
§ GET: Choose this method if your webhook uses GET.
§ POST: Choose this method if your webhook sends post form
data.

Port Enter the port number on which this sensor listens for incoming
HTTP requests. Default is 5050.

Identification Token This is the token that is used to find the matching sensor for the
incoming message. While you create the sensor, this token is
{__guid__}. It will be replaced with an automatically generated token
after you have completed the sensor creation. If you want to use
another identification token, you can edit it while or after sensor
creation. Note: The token will not be replaced automatically if you
change it already during sensor creation.

HTTP Push Dat a

No Incoming Data Define which status the sensor will attain if no push message has
been received for at least two sensor scans. Choose between:
§ Ignore and keep last st at us (default ): The sensor will remain in
the status as defined by the last message received.
§ Swit ch t o "Unknown" st at us: The sensor will turn into the
Unknown status if there has not been received any message for
at least two sensor scans.

Value Type Define which type the value of the received data has. If this setting
does not match, the sensor will go into an Error status. Choose
between:
§ Int eger
§ Float (with dot "." as delimiter)

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

544 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
36 HTTP Push Data Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 545
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
36 HTTP Push Data Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

546 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
36 HTTP Push Data Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

28.05.2014 547
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
36 HTTP Push Data Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

548 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
37 HTTP Push Data Advanced Sensor

6.8.37 HTTP Push Data Advanced Sensor

The HTTP Push Data Advanced sensor displays data from received messages which are pushed
via an Hypertext Transfer Protocol (HTTP) request to the PRTG server. It provides a URL that
can be used to push messages to the PRTG server using HTTP. It can show pushed values in
multiple channels.

This function is known as webhook. Basically, a webhook works like a push notification:
Webhooks are usually triggered by some event (for example, a new comment to a blog post)
and send according information to a specified URL. The HTTP Push Data Advanced sensor then
displays the data of pushed and received messages.

The data which is pushed to this sensor must be valid XML. For details about the return value
format please see the Applicat ion Programming Int erface (API) Definit ion 2031 .

Use the following URLs to receive the HTTP requests of the webhook:

§ GET requests: ht t p://<probe_ip>:<port_number>/<token>?cont ent =<valid XML>

The XML encoded value of the content parameter has to match the format as defined in the
API documentation 2031 in section Cust om Sensors—Advanced EX E/Script Sensor,
Advanced SSH Script Sensor, and Advanced HTTP Push Dat a Sensor.

§ POST requests: ht t p://<probe_ip>:<port_number>/<token>

This HTTP request method sends the XML encoded HTTP body as POST data. The body has to
match the format as defined in the API documentation 2031 in section Cust om Sensors—
Advanced EX E/Script Sensor, Advanced SSH Script Sensor, and Advanced HTTP Push
Dat a Sensor. We strongly recommend the HTTP content type application/xml.

Replace the parameters <probe_ip>, <port_number>, <token> and <valid XML> (for GET
requests) with the corresponding values:

§ You can define port number and ident ificat ion t oken in the sensor settings.
§ The probe IP is the IP address of the system on which your PRTG probe with this sensor is
running on.
§ The content of GET requests has to be valid XML in the PRTG API format.
Note: The content has to be URL encoded (for example, the whitespaces in the sample URL
below); most browsers achieve this automatically.

Minimum example for t he GET met hod which returns one static channel value:
http://127.0.0.1:5050/XYZ123?content=<prtg><result><channel>MyChannel</channel><value>10</value><

Note: You can use several sensors with the same port and identification token. In this case,
the data of push messages will be shown in each of these sensors.

12.05.2014 549
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
37 HTTP Push Data Advanced Sensor

Important notice: Currently, this sensor type is in bet a status. The methods of operating can
change at any time, as well as the available settings. Do not expect that all functions will work
properly, or that this sensor works as expected at all. Be aware that this type of sensor can be
removed again from PRTG at any time.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

550 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
37 HTTP Push Data Advanced Sensor

HTTP Push

Request Method Select the request method of your webhook:


§ ANY: Do not use any filter for the request method.
§ GET: Choose this method if your webhook uses GET.
§ POST: Choose this method if your webhook sends post form
data.

Port Enter the port number on which this sensor listens for incoming
HTTP requests. Default is 5050.

Identification Token This is the token that is used to find the matching sensor for the
incoming message. While you create the sensor, this token is
{__guid__}. It will be replaced with an automatically generated token
after you have completed the sensor creation. If you want to use
another identification token, you can edit it while or after sensor
creation. Note: The token will not be replaced automatically if you
change it already during sensor creation.

HTTP Push Dat a

No Incoming Data Define which status the sensor will attain if no push message has
been received for at least two sensor scans. Choose between:
§ Ignore and keep last st at us (default ): The sensor will remain in
the status as defined by the last message received.
§ Swit ch t o "Unknown" st at us: The sensor will turn into the
Unknown status if there has not been received any message for
at least two sensor scans.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

12.05.2014 551
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
37 HTTP Push Data Advanced Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

552 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
37 HTTP Push Data Advanced Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

12.05.2014 553
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
37 HTTP Push Data Advanced Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

554 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
37 HTTP Push Data Advanced Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 555
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
38 HTTP SSL Certificate Expiry Sensor

6.8.38 HTTP SSL Certificate Expiry Sensor

The HTTP SSL Certificate Expiry Sensor checks a specific https-URL and returns the number of
days remaining until the site's SSL certificate expires. It shows a Warning when only 60 days
are left, and an Error status when only 30 days are remaining until the certificate expires.

Note: This sensor does not work on probes running on Windows Server 2003 (including SP1
and SP2).

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

556 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
38 HTTP SSL Certificate Expiry Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

URL Enter the absolute URL to check (this sensor does not use the IP
Address/DNS value of the parent device). It has to be URL
encoded!

SSLv3 Connection Define if you want to allow SSLv3 only for connections to the URL
configured above. Choose between:
§ Use SSLv3 if available
§ Force usage of SSLv3

Certificate Name Define if you want to check if the defined URL matches the
Validation certificate. Choose between:
§ The cert ificat e must mat ch t he DNS name
§ Accept any cert ificat e

28.05.2014 557
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
38 HTTP SSL Certificate Expiry Sensor

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

558 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
38 HTTP SSL Certificate Expiry Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

28.05.2014 559
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
38 HTTP SSL Certificate Expiry Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

560 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
38 HTTP SSL Certificate Expiry Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 561
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

6.8.39 HTTP Transaction Sensor

The HTTP Transaction sensor monitors an interactive website, such as a web shop, by
performing a transaction using a set of Hypertext Transfer Protocol (HTTP) URLs. The sensor
monitors whether logins or shopping carts work properly. It returns the loading time.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HTTP Specific

Timeout (Sec.) Enter a timeout in seconds for all HTTP requests. If the complete
transaction takes longer than this value the request is aborted and
an error message is triggered. The maximum value is 900 seconds
(15 minutes).

562 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

HTTP Specific

Single URL Timeout Enter a timeout in seconds for one single HTTP request. If the reply
(Sec.) of any single request takes longer than this value the transaction is
aborted and an error message is triggered. The maximum value is
900 seconds (15 minutes).

HTTP Engine

Monitoring Engine If you encounter unexpected errors with the standard method that
is used to monitor an URL, try to use the compatibility mode which
is based on .Net (introduced in PRTG v13.x.7). Choose between:
§ Default /High Performance (recommended): This is the default
monitoring method for this sensor type.
§ Alt ernat e/Compat ibilit y Mode: Try this method as an
alternative for websites that do not work with the default
approach. Using the compatibility mode, this sensor will execute
an external exe. Thus, this method will need more resources, but
it can be helpful in particular cases. Note: If you select the
compatibility mode, the options for the SSL method will be
slightly different. You can also check for trusted certificates.
Please see below.
Note: When using the Compatibility Mode, Smart URL
Replacement will not work, i.e., this sensor does not use the IP
Address/DNS value of the parent device automatically then.

SSL Specific

SSL Method This setting is relevant only when using https in the URL field. We
recommend using the default value. If you experience connection
problems, please select another SSL method from the list. Choose
between:
§ SSL V2
§ SSL V2 or V3: This is the default setting.
§ SSL V3
§ TLS V1
Note: Other TLS versions are not supported.

28.05.2014 563
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

SSL Specific (when using Compat ibilit y Mode)

SSL Method When using the compatibility mode, the SSL specific settings are a
bit different to the default SSL settings. SSL V2 is not available. You
can choose between:

§ SSL V3
§ TLS V1
§ SSL V3 or TLS V1: This is the default setting.

Check SSL Certificates Specify if the certificate of the monitored URL will be checked.
Choose between:
§ Do not check used cert ificat es: This the default setting.
§ Check if t he used cert ificat es are t rust ed: If the certificate of
the server is not trusted, the sensor will go into a Down status
and display a corresponding message.

Note: This sensor type implicitly supports Server Name Identification (SNI), an extension to the
TLS protocol.

Advanced Sensor Dat a

Limit Download (kb) Enter a maximum amount of data that will be transferred per every
single request. If you set content checks below, please be aware
that only the content downloaded within this limit can be checked
for certain search expressions.

Cookie Management Select if cookies will be used for the transaction. Choose between:
· Use cookies (recommended): Allow cookies to be set and read
during the transaction cycle.
· Ignore cookies: Do not allow cookies. Use this option if you
want to test the transaction without the use of cookies.
We recommend using the default value.

Result Handling Define what will be done with the web page loaded at the given
URL. Choose between:
· Discard HTML result : Do not store the requested web page.
· St ore lat est HTML result : Store the last result of the requested
web page to the "Logs (Sensors)" directory (on the Master node,
if in a cluster). This is for debugging purposes, especially in
combination with content checks. The file will be overridden with
each scanning interval. For information on how to find the folder
used for storage, please see Dat a St orage 2074 section.

564 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

Aut hent icat ion

Authentication Define if the web page at the configured URL need authentication.
Choose between:
§ No aut hent icat ion needed
§ Web page needs aut hent icat ion

User This field is only visible if authentication is enabled above. Enter a


username. Please enter a string.

Password This field is only visible if authentication is enabled above. Enter a


password. Please enter a string.

Authentication Method This field is only visible if authentication is enabled above. Please
select the authentication method the given URL is protected with.
Choose between:
· Basic access aut hent icat ion (HTTP): Use simple HTTP
authentication. This is the default setting and suitable for most
cases. Note: This authentication method will transmit credentials
as plain text!
· Windows NT LAN Manager (NTLM): Use the Microsoft NTLM
protocol for authentication. This is sometimes used in Intranets
for single sign-on.
We recommend using the default value.

Transact ion URL

You can define up to 10 different transaction URLs which will all be called in a row. Only if the
complete transaction can be completed, the sensor will be in an Up status 121 . Using this
mechanism you can set up an extended monitoring with multiple URLs. Please enter settings
for at least one transaction URL. You can use as many steps as needed and disable the other
steps.

Transaction Step #x This setting is available for URL #2 through #10. Define if you want
to use this step for your transaction check. Choose between:
§ Disable st ep #x: Do not use this step. Choose this option if you
do not need all 10 steps for your transaction check.
§ Enable st ep #x: Enable this step. Further options will be viewed,
as described below.

28.05.2014 565
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

Transact ion URL

URL Please enter the URL the sensor will connect to. It has to be URL
encoded! If you enter an absolute URL, this address will be
independent from the IP address/DNS name setting of the device
this sensor is created on. PRTG uses a smart URL replacement
which allows you to use the parent device's IP address/DNS name
setting as part of the URL. For more information, please see
section Smart URL Replacement below.

Request Method The request method determines how the given URL is requested.
· GET: Request the website directly, like browsing the web. We
recommend using this setting for a simple check of a web page.
· POST: Send post form data to the URL. If this setting is chosen,
you must enter the data that will be sent in the Post dat a field
below.
· HEAD: Only request the HTTP header from the server; without the
actual web page. Although this saves bandwidth since less data
is transferred, it is not recommended because the measured
request time is not the one experienced by your users and you
might not be notified for slow results or timeouts.

Postdata This field is only active when POST is selected in the Request
Met hod setting above. Please enter the data part for the post
request here. Note: No XML is allowed here!

Check For Existing Key Define whether the result at the configured URL will be checked for
Words (Positive) keywords. Choose between:
§ Disable: Do not search for keywords.
§ Enable key word check (posit ive): In the result returned at the
URL, check if a key word exists.
Note: The content check is only intended for html websites and
might not work with other target URLs.

Response Must Include Define which string must be part of the web at the given URL. If the
data does not include this string, the sensor will be set to an error
state. Please enter a string. Note: Only simple text search is
available here. The characters * and ? work here as placeholder,
whereas * stands for no or any number of characters and ? stands
for exactly one character (as known from Windows search). This
behavior cannot be disabled, so the literal search for these
characters is not possible.

Check For Existing Key Define whether the the result at the configured URL will be
Words (Negative) checked for keywords. Choose between:
§ Disable: Do not search for keywords.

566 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

Transact ion URL

§ Enable key word check (negat ive): In the result returned at the
URL, check if a key word does not exist.
Note: The content check is only intended for html websites and
might not work with other target URLs.

Response Must Not Define which string must not be part of the web at the given URL. If
Include the data does include this string, the sensor will be set to an error
state. Please enter a string. Note: Only simple text search is
available here. The characters * and ? work here as placeholder,
whereas * stands for no or any number of characters and ? stands
for exactly one character (as known from Windows search). This
behavior cannot be disabled, so the literal search for these
characters is not possible.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Proxy Set t ings for HTTP Sensors

HTTP Proxy Settings The proxy settings determine how a sensor connects to a given
URL. You can enter data for a proxy server that will be used when
connecting via HTTP or HTTPS. Note: This setting is valid for the
monitoring only and determines the behavior of sensors. In order
to change proxy settings for the core server, please see Sy st em
Administ rat ion—Core & Probes 1849 .

Name Enter the IP address or DNS name of the proxy server to use. If you
leave this field empty, no proxy will be used.

Port Enter the port number of the proxy. Often, port 8080 is used.
Please enter an integer value.

User If the proxy requires authentication, enter the username for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

Password If the proxy requires authentication, enter the password for the
proxy login. Note: Only basic authentication is available! Please
enter a string or leave the field empty.

28.05.2014 567
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

568 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 569
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Smart URL Replacement

Instead of entering a complete address in the URL field of an HTTP sensor, you can merely
enter the protocol followed by colon and three slashes (that means you can enter either
http:/// or https:/// or even a simple slash / as equivalent for http:///). PRTG will then fill in the
parent device's IP address or DNS name in front of the third slash automatically. Whether this
results in a valid URL or not, depends on the IP address or DNS name of the device where this
HTTP sensor is created on. In combination with cloning devices, the smart URL replacement
makes it easy to create many like devices.

For example, if you create a device with DNS name www.example.com and you put an HTTP
sensor on it, you can provide values the following ways:

§ Providing the value https:/// in the URL field, PRTG will automatically create the URL https://
www.example.com/ from that.
§ Using the value /help in the URL field, PRTG will automatically create and monitor the URL
http://www.example.com/help
§ It is also possible to provide a port number in the URL field which will be taken over by the
device's DNS name and internally added, for example, http://:8080/

570 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
39 HTTP Transaction Sensor

Note: Smart URL replacement does not work for sensors running on the "Probe Device".

More
Knowledge Base: Configuration Tips for HTTP Transaction Sensors needed
§ http://kb.paessler.com/en/topic/443

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 571
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

6.8.40 HTTP XM L/REST Value Sensor

The HTTP XML/REST Value sensor retrieves an XML file from a given URL and parses it. It can
return the values of specific nodes.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Channel Name Enter a name for the channel which will display the value at the
given URL. The name can be changed later in the Sensor Channels
Set t ings 1709 .

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

572 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

URL Enter the absolute URL that returns the XML file (this sensor does
not use the IP Address/DNS value of the parent device). It has to
be URL encoded!

XML Node (and Enter the name of the node this sensor will check, or enter a node
optional property) name and a property name to check a property value. To obtain a
value from nested tags, please enter the tag names separated by a
slash symbol, for example, use myTag/myTagInside as XML node
value. Note: You can also check values in JavaScript Object
Notation (JSON) notation. Please see Checking JSON 579 section
below.
Note: You can try using XPath syntax here but it will not work in all
cases and we do not provide any technical support for XPath
issues.For further documentation about XPath please see More 572
section below.

HTTP Username If the URL requires authentication, enter the username. Please
enter a string or leave the field empty.

HTTP Password If the URL requires authentication, enter the password. Please
enter a string or leave the field empty.

Sensor Value Choose between:

28.05.2014 573
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Sensor Set t ings

§ Use t he value of t he select ed X ML node: Return the value


found at the specified XML node. If this is non-numeric, this will
return 0.
§ Use t he number of occurrences of t he select ed X ML node or
it s children/siblings: Return the number of occurrences found.
Define further below.

Count XML Nodes This setting is only visible if the return number option is enabled
above. Define which count will be returned. Choose between:
§ Occurrences of t he select ed X ML node: Return how often the
defined XML node occurs at the defined URL.
§ Child nodes of t he select ed X ML node: Return the number of
child nodes that exist below the node at the defined URL.
§ Sibling nodes of t he select ed X ML node: Return the number of
sibling nodes that exist next to the node at the defined URL.

Namespaces Define whether namespaces in the XML document will be used or


not. Choose between:
§ Use Namespaces: Process the value entered in the "XML Node
(and optional property)" field including possibly existing
namespace information.
§ Remove Namespaces: Ignore namespace information in the XML
document and process the value entered in the "XML Node (and
optional property)" field as node names only.
For more information see About Namespaces 580 section below.

Content Type in Choose if PRTG will Include content-type="text/xml" in the header


Header of the request sent to the URL defined above. Choose between:
§ Enable (recommended): This works for most web servers and is
the recommended setting.
§ Disable: Only very few web servers cannot handle this content-
type and need this setting. Try this if you get an error message
with the enabled option.
§ Cust om: You can use a custom content type.

Custom Content Type Only visible when "Custom" is enabled above. Enter a custom
content type like text/xml or text/html.

574 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Sensor Set t ings

Characters to Remove Only visible when using value of XML node is enabled above.
Optionally enter a string which will be removed from the returned
XML value. Use this to remove any unwanted characters from the
result, for example, a thousands separator from numeric values.
Please enter a string or leave the field empty.

Decimal Delimiter This setting is only visible if "use value" is enabled above. If the
sensor value of the selected XML node is of the type float, you can
define any character here which is the decimal delimiter. Enter one
character or leave the field empty.

Custom Message Optionally enter a custom sensor message. Use %1 as a


placeholder to automatically fill in the returned XML value. Please
enter a string or leave the field empty.

Force SSL V3 Define if you only want to allow SSL V3 connections to the URL
defined above. Choose between:
§ No
§ Yes

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Results Define what will be done with the results given back. Choose
between:
· Discard result : Do not store the requested web page.
· Writ e result t o disk (Filename: "Result of Sensor [ID].t xt "):
Store the last result received from to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see More 438 section below.

Unit String Enter a string that will be added to the values as a unit description.
This is for display purposes only.

28.05.2014 575
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

576 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

28.05.2014 577
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

578 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Checking JSON

With the X ML Node (and opt ional propert y ) field you can also check values that are returned
in JavaScript Object Notation (JSON) notation under the defined URL.

28.05.2014 579
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Example

A JSON notated section may look like the following:


{
"test": "Hello World",
"object": {
"value": "content",
"AnotherValue": "AnotherContent"
},
"arraytest": [
"one",
"two"
]
}

Depending on your entries in the X ML Node field, the sensor will process the respective
values:

Ent ry in Sensor's "X ML Node" Field (from Processed Value (from Example Above)
Example Above)

test Hello World

object/value content

object/AnotherValue AnotherContent

object contentAnotherContent

arraytest[1] one

arraytest[2] two

About Namespaces

In an XML document, tags may use namespaces.

580 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Example

A namespace notated section may look like the following:


<myNamespace:myNode>
some information
</myNamespace:myNode>

If you set this sensor to Use Namespaces (this is the default setting), it will expect the full
node name, including the namespace information, in the X ML Node (and opt ional propert y )
field. In the example above, this would be myNamespace:myNode.

If your node names are unique even without the namespace information, you can simplify the
settings by setting this sensor to Remove Namespaces. The sensor will then expect the
node name only in the X ML Node (and opt ional propert y ) field. In the example above, this
would be myNode.

More
Knowledge Base: Is there a tool available that can help me building queries for the XML/Rest
Sensor?
§ http://kb.paessler.com/en/topic/48783

Knowledge Base: How do I extract values from XML nodes (with nested tags) using PRTG's
XML/Rest Value Sensor?
§ http://kb.paessler.com/en/topic/43223

Knowledge Base: How can I use XPath with PRTG's XML/Rest Value Sensor?
§ http://kb.paessler.com/en/topic/26393

Knowledge Base: HTTP XML/REST Value Sensor shows protocol violation. What can I do?
§ http://kb.paessler.com/en/topic/26793

Knowledge Base: Why does my HTTP XML/REST Value Sensor return a 404 error?
§ http://kb.paessler.com/en/topic/46503

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

28.05.2014 581
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
40 HTTP XML/REST Value Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

582 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
41 Hyper-V Cluster Shared Volume Disk Free Sensor

6.8.41 Hy per-V Cluster Shared Volume Disk Free Sensor

The Hyper-V Cluster Shared Volume Disk Free sensor monitors a Microsoft Hyper-V cluster
shared volume via PowerShell and shows the available disk space. Note: The parent device for
this sensor must be a Windows Server running Hyper-V.

Note: We recommend using System Center Virtual Machine Manager (SCVMM) as parent device,
because this way PRTG will continue to monitor your virtual machines also when they change
the physical host using Live Migration.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: Remote PowerShell

The Hyper-V Cluster Shared Volume Disk Free sensor uses PowerShell commands. In order to
monitor devices with this sensor Remot e PowerShell has to be enabled. For detailed
information, please see More 589 section below.

Requirement: WSFC PowerShell Interface

This sensor type needs the WSFC (Windows Server Failover Clustering) PowerShell Interface to
be installed on the target machine. You can list all modules in the PowerShell console with the
command Get -Module -List Available. Here FailoverClust ers has to appear. Under Windows
2008 and 2012 the interface is part of the VMM Administrator Console, or the VMM 2012
Management Console, respectively.

The interface is everywhere available where the WSFC feature is installed: Windows Server
2008 R2 (SP1) Full and Core (not installed by default); Microsoft Hyper-V Server 2008 R2 (SP1);
Remote Server Administration Tools (RSAT) for Windows 7 (SP1).

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

04.06.2014 583
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
41 Hyper-V Cluster Shared Volume Disk Free Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor cluster disks, PRTG will create one sensor for each disk. The settings you
make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Disk Free Set t ings

Disk Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head. Note: Please make
sure the resource name of your disks do not contain unsupported
characters, especially avoid the hash ('#') sign. We recommend to
not rename resource disk name once you've set up monitoring. For
detailed information, please see More 602 section below.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

584 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
41 Hyper-V Cluster Shared Volume Disk Free Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Disk Free Set t ings

Disk Shows further information about the disk. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

If Value Changes Define what will be done in case the value of a sensor channel
changes. Choose between:
§ Ignore changes: No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

04.06.2014 585
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
41 Hyper-V Cluster Shared Volume Disk Free Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

586 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
41 Hyper-V Cluster Shared Volume Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

04.06.2014 587
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
41 Hyper-V Cluster Shared Volume Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

588 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
41 Hyper-V Cluster Shared Volume Disk Free Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Why don't my Hyper-V sensors work after changing names?
§ http://kb.paessler.com/en/topic/15533
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

04.06.2014 589
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
42 Hyper-V Host Server Sensor

6.8.42 Hy per-V Host Server Sensor

The Hyper-V Host Server sensor monitors a Microsoft Hyper-V host server via Windows
Performance Counters or Windows Management Instrumentation (WMI), as configured in the
"Windows Compatibility Options" of the parent device. It shows CPU usage in percent of
guests, hypervisor, and total, as well as host health critical values, the number of deposited
pages, and network traffic. Network traffic sums up the total bytes per second (received and
sent) on all ports of your virtual switch.

Note: The parent device for this sensor must be a Windows Server running Hyper-V.

Note: We recommend using System Center Virtual Machine Manager (SCVMM) as parent device,
because this way PRTG will continue to monitor your virtual machines also when they change
the physical host using Live Migration.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

590 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
42 Hyper-V Host Server Sensor

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Result Define what will be done with the result of the sensor. Choose
between:

12.05.2014 591
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
42 Hyper-V Host Server Sensor

§ Discard sensor result : Do not store the sensor result.


§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

592 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
42 Hyper-V Host Server Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

12.05.2014 593
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
42 Hyper-V Host Server Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

594 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
42 Hyper-V Host Server Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 595
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

6.8.43 Hy per-V Virtual M achine Sensor

The Hyper-V Virtual Machine sensor monitors a virtual machine running on a Microsoft Hyper-V
host server, via Windows Performance Counters or Windows Management Instrumentation
(WMI), as configured in the "Windows Compatibility Options" of the parent device. It shows CPU
usage in percent of guests, hypervisor, and total, as well as disk read and write values, per
second. Note: The parent device for this sensor must be a Hyper-V server.

Note: In order to monitor a virtual machine with this sensor, disable User Account Control
(UAC) in the control panel of the Windows operating system which is running on this virtual
machine. Otherwise, the sensor might switch into a down status with the error message "The
virtual is not running or is powered off".

Note: We recommend using System Center Virtual Machine Manager (SCVMM) as parent device,
because this way PRTG will continue to monitor your virtual machines also when they change
the physical host using Live Migration.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

596 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor virtual machines, PRTG will create one sensor for each machine. The
settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Virt ual Machine Set t ings

Virtual Machine Select the virtual machines (VMs) you want to add a sensor for,
including the ones that are not running. A list of all available items
is shown with their name. Select the desired items by adding check
marks in front of the respective lines. One sensor will be created
for each selection. You can also select and deselect all items by
using the check box in the table head. Note: Please make sure the
name of your VMs do not contain unsupported characters,
especially avoid the hash ('#') sign. We recommend to not rename
virtual machines once you've set up monitoring. For detailed
information, please see More 602 section below.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

28.05.2014 597
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Virt ual Machine Set t ings

GUID Shows the Globally Unique Identifier (GUID) of the virtual machine
monitored by this sensor. Once a sensor is created this value
cannot be changed. It is shown for reference purposes only. If you
need to change this, please add the sensor anew.

Name Shows the name of the virtual machine monitored by this sensor.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Name Shows the name of the host server. Once a sensor is created this
value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

Powered Off VMs Choose how the sensor will react to a virtual machine that is
powered off. Please choose between:
· Alarm when powered off (default ): The sensor will change to a
Down 121 status if the virtual machine is powered off. Note: While
in Down status, a sensor does not record any data in all of its
channels.
· Ignore powered off st at e: The sensor will not change to a
Down status if the virtual machine is powered off; it will report
zero values instead.

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.

598 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

Virt ual Machine Set t ings

§ Writ e sensor result t o disk (Filename: "Result of Sensor


[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

28.05.2014 599
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

600 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 601
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Why don't my Hyper-V Virtual Machine / Network Adapter Sensor work after
changing names?
§ http://kb.paessler.com/en/topic/15533

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

602 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
43 Hyper-V Virtual Machine Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 603
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
44 Hyper-V Virtual Network Adapter Sensor

6.8.44 Hy per-V Virtual Network Adapter Sensor

The Hyper-V Network Adapter sensor monitors virtual network adapters running on a
Microsoft Hyper-V host server, via Windows Performance Counters or Windows Management
Instrumentation (WMI), as configured in the "Windows Compatibility Options" of the parent
device. It shows sent and received bytes, packets, broadcast packets, directed packets, and
multicast packets, per second. Note: The parent device for this sensor must be a Hyper-V
server.

Note: We recommend using System Center Virtual Machine Manager (SCVMM) as parent device,
because this way PRTG will continue to monitor your virtual machines also when they change
the physical host using Live Migration.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

604 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
44 Hyper-V Virtual Network Adapter Sensor

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor network adapters, PRTG will create one sensor for each adapter. The
settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Virt ual Machine Set t ings

Hyper-V Virtual Select the virtual network adapters you want to add a sensor for. A
Network Adapter list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head. Note: We recommend to not rename virtual machines once
you have set up monitoring. Renaming them will also change the
internal virtual network adapter names, causing the monitoring to
be interrupted. For detailed information about virtual machine
naming, please see More 602 section below.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

28.05.2014 605
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
44 Hyper-V Virtual Network Adapter Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Hy per-V Virt ual Net work Adapt er Set t ings

Virtual Network Shows the name of the virtual network adapter monitored by this
Adapter sensor. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

606 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
44 Hyper-V Virtual Network Adapter Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 607
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
44 Hyper-V Virtual Network Adapter Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

608 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
44 Hyper-V Virtual Network Adapter Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Why don't my Hyper-V Virtual Machine / Network Adapter Sensor work after
changing names?
§ http://kb.paessler.com/en/topic/15533

28.05.2014 609
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
44 Hyper-V Virtual Network Adapter Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

610 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
45 Hyper-V Virtual Storage Device Sensor

6.8.45 Hy per-V Virtual Storage Device Sensor

The Hyper-V Virtual Storage sensor monitors a virtual storage device running on a Microsoft
Hyper-V host server, via Windows Performance Counters or Windows Management
Instrumentation (WMI), as configured in the "Windows Compatibility Options" of the parent
device. It shows read and write values in second, and the number of errors. Note: The parent
device for this sensor must be a Hyper-V server.

Note: We recommend using System Center Virtual Machine Manager (SCVMM) as parent device,
because this way PRTG will continue to monitor your virtual machines also when they change
the physical host using Live Migration.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

03.04.2014 611
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
45 Hyper-V Virtual Storage Device Sensor

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor storage devices, PRTG will create one sensor for each device. The settings
you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Hy per-V Virt ual St orage Device Set t ings

Hyper-V Virtual Storage Select the virtual storage devices you want to add a sensor for. A
Device list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

612 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
45 Hyper-V Virtual Storage Device Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Hy per-V Virt ual St orage Device Set t ings

Virtual Storage Device Shows the unique name of the device monitored by this sensor.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

03.04.2014 613
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
45 Hyper-V Virtual Storage Device Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

614 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
45 Hyper-V Virtual Storage Device Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

03.04.2014 615
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
45 Hyper-V Virtual Storage Device Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

616 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
45 Hyper-V Virtual Storage Device Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.04.2014 617
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

6.8.46 IM AP Sensor

The IMAP sensor monitors a mail server using Internet Message Access Protocol (IMAP) and
shows the server's response time as well as the number of emails in the defined mailbox. It can
also check the content of emails for certain key words. This way, you can use this sensor to
monitor backup solutions via emails that are sent out by these solutions. For more
information, see section More 627 .

Note: If you use content checks, we recommend using a dedicated IMAP account that is only
checked by PRTG. Editing existing mails in the mailbox of the monitored IMAP account can lead
to false alarms or malfunctions of this sensor type.

Note: This sensor type might not work properly when monitoring sub-folders of mailboxes. If it
has to check subsequent emails with identical subjects, later on incoming emails might not be
recognized.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

618 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

IMAP Specific

Timeout (sec.) Enter a timeout in seconds for the SMTP connect. If the reply takes
longer than this value the request is aborted and an error message
is triggered.

Port Enter the number of the port that will be used to connect via IMAP.
For non-secure connections usually port 143 is used; usually port
993 for SSL connections. The actual setting depends on the server
you are connecting to. Please enter an integer value. We
recommend using the default value. If you do not get a connection,
please try another port number.

Aut hent icat ion

Authentication Type Select the kind of authentication for the IMAP connection. Choose
between:
· Username/Password: Authenticate at the IMAP server via
username and password.
· Simple Aut hent icat ion and Securit y Lay er (SASL): Use a
secure connection for the authentication at the IMAP server.

Username Enter a username for IMAP authentication. Please enter a string or


leave the field empty. Note: If you leave this field empty, PRTG will
not attempt to log in to the mail server. The sensor will show a
green Up status if the IMAP server is available.

Password Enter a password for IMAP authentication. Please enter a string or


leave the field empty. Note: If you leave this field empty, PRTG will
not attempt to log in to the mail server. The sensor will show a
green Up status if the IMAP server is available.

TLS (Transport-Level This setting is only relevant if authentication is used. Choose if a


Security) secure connection via TLS/SSL will be used. Choose between:
· Don't use
· Use

28.05.2014 619
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

SSL-Method This field is only visible if security is enabled above. Select the SSL
method that will be used when connecting to the server. We
recommend using the default value. Only if you experience
connection problems, try another setting. Choose between:
§ SSL V2
§ SSL V2 or V3
§ SSL V3
§ TLS V1

Ident ify Email

Process Email Content This sensor can additionally check the content of all incoming
emails. Choose between:
§ Do not check email cont ent : Only check availability of the IMAP
server and check if a login is successful (if defined). Do not
process any mails in the IMAP mail account.
§ Process emails in t his mailbox: Login in to the IMAP mail
account and check the mails contained there. Define further
options below.

Mailbox Name This field is only visible if email content processing is enabled
above. Enter the name of the mailbox (e.g. the name of the IMAP
folder) that will be checked. Default value is Inbox. Unless you set
a last message date check below, the sensor will always look at all
emails contained in the mailbox. Note: Please make sure that you
do not manually edit mails in this mailbox with another mail client,
as this can lead to malfunctions of this sensor's email identification.

Identify by "From" Field This option is only visible if email content processing is enabled
above. Define if you want to check the "From" field of the emails.
Choose between:
§ Don't check: Do not check this field in emails.
§ Check using st ring search: Check this field in emails using
simple string search.
§ Check using regular expression: Check this field in emails using
a regular expression. For more information about syntax, please
see Regular Expressions 2048 section.
When using a search, the sensor will scan all emails from the
newest to the oldest. Note: The scan will be finished with the first
match! That means: After a match is found in one email, there will be
no further checks performed in older emails.

Search For This field is only visible if a check is enabled above. Enter a search
string using the method defined above.

620 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Ident ify Email

Identify by "Subject" This option is only visible if email content processing is enabled
Field above. Define if you want to check the "Subject" field of the emails.
Choose between:
§ Don't check: Do not check this field in emails.
§ Check using st ring search: Check this field in emails using
simple string search.
§ Check using regular expression: Check this field in emails using
a regular expression. For more information about syntax, please
see Regular Expressions 2048 section.
When using a search, the sensor will scan all emails from the
newest to the oldest. Note: The scan will be finished with the first
match! That means: After a match is found in one email, there will be
no further checks performed in older emails.

Search For This field is only visible if a check is enabled above. Enter a search
string using the method defined above.

Identify by Mail Body This option is only visible if email content processing is enabled
above. Define if you want to check the mail body of the emails.
Choose between:
§ Don't check: Do not check the mail body.
§ Check using st ring search: Check the mail body using simple
string search.
§ Check using regular expression: Check the mail body using a
regular expression. For more information about syntax, please
see Regular Expressions 2048 section.
When using a search, the sensor will scan all emails from the
newest to the oldest. Note: The scan will be finished with the first
match! That means: After a match is found in one email, there will be
no further checks performed in older emails.

Search For This field is only visible if a check is enabled above. Enter a search
string using the method defined above.

Check Last Message This option is only visible if email content processing is enabled
Date above. Define if you want to check all emails in the mailbox, or only
mails that were received within the last x hours. Choose between:
§ Don't check message age: Always check all emails contained in
the mailbox.
§ Check for new messages received wit hin t he last x hours:
Only regard emails that were received in the last hours. Define
below.

28.05.2014 621
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Ident ify Email

Error Threshold (Hours) Enter the maximum age in hours. Only emails that are younger will
be processed. If there is no matching email in the defined time
span, the sensor will show a Down status.

Warning Threshold Enter the maximum age in hours. Only emails that are younger will
(Hours) be processed. If there is no matching email in the defined time
span, the sensor will show a Warning status.

Sensor Behavior

Set to Alarm This setting is only visible if email content check is enabled above.
Define in which cases the sensor will show a Down status. Choose
between:
§ If subject cont ains
§ If subject does not cont ain
§ If mail body cont ains
§ If mail body does not cont ain
§ Alway s: Always set this sensor to a Down status in case any
emails could be identified.
§ Never: Never set this sensor to a Down status based on email
content.

Check Method This setting is only visible if an if-condition is selected above.


Define how you want to check for the above condition. Choose
between:
§ St ring search: Check the mail body using simple string search.
§ Regular expression: Check the mail body using a regular
expression. For more information about syntax, please see
Regular Expressions 2048 section.
When using a search, the sensor will scan all emails from the
newest to the oldest. Note: The scan will be finished with the first
match! That means: After a match is found in one email, there will be
no further checks performed in older emails.

Search Text This setting is only visible if an if-condition is selected above. Enter
a search string using the method defined above.

Error Message This setting is only visible if an alarm condition is selected above.
Define the message that will be shown in case the sensor shows a
Down status.

622 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Sensor Behavior

Set to Warning This setting is only visible if email content check is enabled above.
Define in which cases the sensor will show a Warning status.
Choose between:
§ If subject cont ains
§ If subject does not cont ain
§ If mail body cont ains
§ If mail body does not cont ain
§ Alway s: Always set this sensor to a Warning status in case any
emails could be identified.
§ Never: Never set this sensor to a Warning status based on email
content.

Check Method This setting is only visible if an if-condition is selected above.


Define how you want to check for the above condition. Choose
between:
§ St ring search: Check the mail body using simple string search.
§ Regular expression: Check the mail body using a regular
expression. For more information about syntax, please see
Regular Expressions 2048 section.
When using a search, the sensor will scan all emails from the
newest to the oldest. Note: The scan will be finished with the first
match! That means: After a match is found in one email, there will be
no further checks performed in older emails.

Search Text This setting is only visible if an if-condition is selected above. Enter
a search string using the method defined above.

Warning Message This setting is only visible if a warning condition is selected above.
Define the message that will be shown in case the sensor shows a
Warning status.

No Matching Mail This setting is only visible if email content check is enabled above.
Behavior Define how the sensor will react if no matching emails are found in
the mailbox that is being scanned. Choose between:
§ Set sensor t o "Down" st at us
§ Set sensor t o "Warning" st at us
§ None: Don't do anything in this case.

28.05.2014 623
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Sensor Behavior

Message This field is only effective if a sensor change in case of no matching


mail is defined above. Define the message that will be shown in
case the sensor could not find any matching emails. It will be
shown together with a Warning or Down status, just as defined
above.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

624 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

28.05.2014 625
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

626 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How can I monitor my backup software to be sure backup succeeded last
night?
§ http://kb.paessler.com/en/topic/47023

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

28.05.2014 627
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
46 IMAP Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

628 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
47 INI File Content Check Sensor

6.8.47 INI File Content Check Sensor

The INI File Content Check sensor reads an *.ini file. It indicates if the file exists and if a
specified section and field are found. The sensor returns the field's integer value (or -1 if the
field does not contain an integer). It will show a Warning status if a section or field is not
found, and a Down status if the file could not be opened.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

04.06.2014 629
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
47 INI File Content Check Sensor

Sensor Set t ings

INI File Name Enter the full path to the file this sensor will monitor. For example,
enter C:\Windows\win.ini. If the file is located on a network device
use the Uniform Naming Convention (UNC) path without the server
part (you would only enter share\folder\file.ini). The server part (\
\server\) is taken from this sensor's parent device's settings. Please
enter a valid path and file name. Note: In order to provide any
shares, the LanmanServer "Server" Windows service must be
running on the target computer.

INI Section Define the section inside the INI file you would like to check. A
section within the INI file is denoted in square brackets [ ]. Enter
the section name without the brackets here, for example, enter
Mail. This value is not case sensitive. If the section is not found, the
sensor will show a Warning status.

INI Field Define the field inside the section you would like to check. In the
INI file, a field name is written before an equal sign =, followed by its
value. Enter the field name here, for example, enter MAPI. This value
is not case sensitive. The sensor will return the value of this field,
i.e. the value on the right side of the equal sign. If the field is not
found, the sensor will show a Warning status.

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

630 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
47 INI File Content Check Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

04.06.2014 631
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
47 INI File Content Check Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

632 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
47 INI File Content Check Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

04.06.2014 633
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
47 INI File Content Check Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

634 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
48 IP on DNS Blacklist Sensor

6.8.48 IP on DNS Blacklist Sensor

The IP on DNS Blacklist sensor checks if the IP address of its parent device is listed on specific
blacklist servers and returns the number of hits found. If a DNS name is used as the parent
device's hostname, PRTG will resolve it to an IP address first.

During normal operation, there should be 0 hits and the sensor should show a green Up
status. If the IP address is found on at least one of the blacklist servers, the sensor changes to
a yellow Warning status by default. Note: You can set additional thresholds in the sensor's
Sensor Channels Set t ings 1709 , if you like.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

28.05.2014 635
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
48 IP on DNS Blacklist Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Blacklist Servers Define the blacklist servers that will be used for the check. You can
enter a comma separated list. Default is bl.spamcop.net. For a list
of servers, please see More 639 section below. Note: With each
scanning interval, PRTG will query all servers in the list! We
recommend you do not enter more than 10 servers to make sure
the check can be completed within the scanning interval of this
sensor. If you use too many blacklist servers, the sensor will show
a "Timeout (code: PE018)" error message.

Timeout (sec.) Define a timeout in seconds for the check. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

636 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
48 IP on DNS Blacklist Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 637
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
48 IP on DNS Blacklist Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

638 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
48 IP on DNS Blacklist Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Is there a list of anti spam black list servers?
§ http://kb.paessler.com/en/topic/37633

28.05.2014 639
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
48 IP on DNS Blacklist Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

640 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

6.8.49 IPFIX Sensor

The IPFIX sensor receives traffic data from an IPFIX (Internet Protocol Flow Information Export)
compatible device and shows traffic by type. There are several filter options available to divide
traffic into different channels. Please make sure your device supports IPFIX when using this
sensor.

Note: In order for this sensor to work, you have to enable IPFIX export on the device. The
device must send the flow data stream to the IP address of the PRTG probe system on which
the sensor is set up (either a local or remote probe). This sensor type cannot be used in
cluster mode. You can set it up on a local probe or remote probe only, not on a cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 641
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

IPFIX Specific Set t ings

Receive IPFIX Packets Enter the UDP port number on which the flow packets are received.
on UDP Port It must match the one you have configured in the IPFIX export
options of your hardware router device. Please enter an integer
value.

Sender IP Enter the IP address of the sending device you want to receive the
IPFIX data from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive IPFIX Packets Select the IP address(es) on which PRTG listens to IPFIX packets.
on IP The list of IP addresses shown here is specific to your setup. To
select an IP address, add a check mark in front of the respective
line or in the top level box to select all. The IP address selected
here must match the one configured in the IPFIX export options of
your hardware router device.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your exporter
device. If the number is different, monitoring results will be
incorrect. Please enter an integer value.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.

642 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

IPFIX Specific Set t ings

Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Channel Configurat ion

Channel Selection Define the categories the traffic will be accounted to. There are
different groups of traffic available. Choose between:
§ Web: Internet web traffic.
§ File Transfer: Traffic caused by FTP.
§ Mail: Internet mail traffic.
§ Chat : Traffic caused by chat and instant messaging.
§ Remot e Cont rol: Traffic caused by remote control applications,
such as RDP, SSH, Telnet, VNC.
§ Infrast ruct ure: Traffic caused by network services, such as
DHCP, DNS, Ident, ICMP, SNMP.
§ Net BIOS: Traffic caused by NetBIOS communication.
§ Ot her Prot ocols: Traffic caused by various other protocols via
UDP and TCP.
For each traffic group, you can select how many channels will be
used for each group, i.e. how detailed traffic will be divided. For
each group, choose between:
§ No: Do not account traffic of this group in an own channel. All
traffic of this group will be accounted to the default channel
named Ot her.
§ Yes: Count all traffic of this group and summarize it into one
channel.
§ Det ail: Count all traffic of this group and further divide it into
different channels. The traffic will appear in several channels as
shown in the Cont ent column. Note: Extensive use of this
option can cause load problems on your probe system. We
recommend setting specific, well-chosen filters for the data you
really want to analyze.
Note: You can change the default configuration for groups and
channels. For details, please see section More.

28.05.2014 643
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols

644 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

Primary Toplist

§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

28.05.2014 645
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

646 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

28.05.2014 647
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
49 IPFIX Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

More

Paessler Website: Paessler NetFlow Testers


§ http://www.paessler.com/tools/netflowtester

Knowledge Base: How can I change the default groups and channels for xFlow and Packet
Sniffer sensors?
§ http://kb.paessler.com/en/topic/60203

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

648 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

6.8.50 IPFIX (Custom) Sensor

The IPFIX (Custom) sensor receives traffic data from an IPFIX (Internet Protocol Flow Information
Export) compatible device and shows the traffic by type. In this custom sensor, you can define
your own channel definitions to divide traffic into different channels. Please make sure your
device supports IPFIX when using this sensor.

Note: In order for this sensor to work, you have to enable IPFIX export on the device. The
device must send the flow data stream to the IP address of the PRTG probe system on which
the sensor is set up (either a local or remote probe). This sensor type cannot be used in
cluster mode. You can set it up on a local probe or remote probe only, not on a cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

24.10.2013 649
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

IPFIX Specific Set t ings

Receive IPFIX Packets Enter the UDP port number on which the flow packets are received.
on UDP Port It must match the one configured in the IPFIX export options of
your hardware router device. Please enter an integer value.

Sender IP Enter the IP address of the sending device you want to receive the
IPFIX data from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive IPFIX Packets Select the IP address(es) on which PRTG listens to IPFIX packets.
on IP The list of IP addresses shown here is specific to your setup. To
select an IP address, add a check mark in front of the respective
line. The IP address selected here must match the one configured
in the IPFIX export options of your hardware router device.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your device. If the
number is different, monitoring results will be incorrect. Please
enter an integer value.

650 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

IPFIX Specific Set t ings

Channel Definition Please enter a channel definition to divide the traffic into different
channels. Write each definition in one line. For detailed information,
please see Channel Definit ions for xFlow and Packet Sniffer
Sensors 2036 section. All traffic for which no channel is defined will
be accounted to the default channel named Ot her. Note: Extensive
use of many filters can cause load problems on your probe system.
We recommend defining specific, well-chosen filters for the data
you really want to analyze.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

24.10.2013 651
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

652 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

24.10.2013 653
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

654 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

24.10.2013 655
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
50 IPFIX (Custom) Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

656 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
51 IPMI System Health Sensor

6.8.51 IPM I Sy stem Health Sensor

The IPMI System Health sensor monitors the status of a system via the Intelligent Platform
Management Interface (IPMI). It can show temperature, rotation per minute of fans, voltage, and
the status of a power supply.

Note: You have to explicitly specify the credentials of the IPMI in the sensor settings.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

This sensor type has predefined limits for several metrics. These limits can be changed
individually in the channel settings. For detailed information about channel limits please refer to
the section Sensor Channels Set t ings 1709 .

Important notice: Currently, this sensor type is in bet a status. The methods of operating can
change at any time, as well as the available settings. Do not expect that all functions will work
properly, or that this sensor works as expected at all. Be aware that this type of sensor can be
removed again from PRTG at any time.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Before you can actually add this sensor, PRTG will ask you to provide your credentials for the
Intelligent Platform Management Interface (IPMI) in the add sensor dialog 220 . Enter the
Username and the Password in the respective fields.

In order to monitor the system health via IPMI, PRTG will create one sensor for each metric you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

28.05.2014 657
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
51 IPMI System Health Sensor

IPMI Specific

Group Select the measurements you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

IPMI Credent ials

Username Enter the username for the Intelligent Platform Management


Interface (IPMI). If not changed yet, this field shows the username
that you defined during sensor creation.

Password Enter the password for the Intelligent Platform Management


Interface (IPMI). If not changed yet, this field shows the encrypted
password that you defined the sensor creation.

658 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
51 IPMI System Health Sensor

IPMI Specific

Group Shows the measurement that this sensor monitors. Once a sensor
is created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Logfile Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

28.05.2014 659
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
51 IPMI System Health Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

660 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
51 IPMI System Health Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 661
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
51 IPMI System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

662 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
51 IPMI System Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 663
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

6.8.52 jFlow V5 Sensor

The jFlow V5 sensor receives traffic data from a jFlow V5 compatible device and shows the
traffic by type. On your hardware device, please make sure it matches jFlow V5 and disable any
sampling option! There are several filter options available to divide traffic into different
channels.

Note: In order for the sensor to work, jFlow export of the respective version must be enabled
on the device. The device must send the flow data stream to the IP address of the PRTG probe
system on which the sensor is set up (either a local or remote probe). The sensor does not
support sampling, so please disable sampling in your jFlow device! This sensor type cannot be
used in cluster mode. You can set it up on a local probe or remote probe only, not on a cluster
probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

664 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

jFlow V5 Specific Set t ings

Receive jFlow Packets Enter the UDP port number on which the flow packets are received.
on UDP Port It must match the one you have configured in the jFlow export
options of your hardware router device. Please enter an integer
value. Note: When configuring export, please make sure you select
the appropriate jFlow version for this sensor.

Sender IP Enter the IP address of the sending device you want to receive the
jFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive jFlow Packets Select the IP address(es) on which PRTG listens to jFlow packets.
on IP The list of IP addresses shown here is specific to your setup. To
select an IP address, add a check mark in front of the respective
line. The IP address selected here must match the one configured
in the jFlow export options of your hardware router device. Note:
When configuring export, please make sure you select the
appropriate jFlow version for this sensor.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your exporter
device. If the number is different, monitoring results will be
incorrect. Please enter an integer value.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.

24.10.2013 665
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

jFlow V5 Specific Set t ings

Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Channel Configurat ion

Channel Selection Define the categories the traffic will be accounted to. There are
different groups of traffic available. Choose between:
§ Web: Internet web traffic.
§ File Transfer: Traffic caused by FTP.
§ Mail: Internet mail traffic.
§ Chat : Traffic caused by chat and instant messaging.
§ Remot e Cont rol: Traffic caused by remote control applications,
such as RDP, SSH, Telnet, VNC.
§ Infrast ruct ure: Traffic caused by network services, such as
DHCP, DNS, Ident, ICMP, SNMP.
§ Net BIOS: Traffic caused by NetBIOS communication.
§ Ot her Prot ocols: Traffic caused by various other protocols via
UDP and TCP.
For each traffic group, you can select how many channels will be
used for each group, i.e. how detailed traffic will be divided. For
each group, choose between:
§ No: Do not account traffic of this group in an own channel. All
traffic of this group will be accounted to the default channel
named Ot her.
§ Yes: Count all traffic of this group and summarize it into one
channel.
§ Det ail: Count all traffic of this group and further divide it into
different channels. The traffic will appear in several channels as
shown in the Cont ent column. Note: Extensive use of this
option can cause load problems on your probe system. We
recommend setting specific, well-chosen filters for the data you
really want to analyze.
Note: You can change the default configuration for groups and
channels. For details, please see section More.

666 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols

24.10.2013 667
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

Primary Toplist

§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

668 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

24.10.2013 669
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

670 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
52 jFlow V5 Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

24.10.2013 671
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

6.8.53 jFlow V5 (Custom) Sensor

The jFlow V5 (Custom) sensor receives traffic data from a jFlow V5 compatible device and
shows the traffic by type. On your hardware device, please make sure it matches jFlow V5 and
disable any sampling option! In this custom sensor, you can define your own channel
definitions to divide traffic into different channels.

Note: In order for the sensor to work, jFlow export of the respective version must be enabled
on the device. The device must send the flow data stream to the IP address of the PRTG probe
system on which the sensor is set up (either a local or remote probe). The sensor does not
support sampling, so please disable sampling in your jFlow device! This sensor type cannot be
used in cluster mode. You can set it up on a local probe or remote probe only, not on a cluster
probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

672 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

jFlow Specific Set t ings

Receive jFlow Packets Enter the UDP port number on which the flow packets are received.
on UDP Port It must match the one configured in the jFlow export options of
your hardware router device. Please enter an integer value. Note:
When configuring export, please make sure you select the
appropriate jFlow version for this sensor.

Sender IP Enter the IP address of the sending device you want to receive the
jFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive jFlow Packets Select the IP address(es) on which PRTG listens to jFlow packets.
on IP The list of IP addresses shown here is specific to your setup. To
select an IP address, add a check mark in front of the respective
line. The IP address selected here must match the one configured
in the jFlow export options of your hardware router device. Note:
When configuring export, please make sure you select the
appropriate jFlow version for this sensor.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

24.10.2013 673
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

jFlow Specific Set t ings

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your exporter
device. If the number is different, monitoring results will be
incorrect. Please enter an integer value.

Channel Definition Please enter a channel definition to divide the traffic into different
channels. Write each definition in one line. For detailed information,
please see Channel Defint ions for xFlow and Packet Sniffer
Sensors 2036 section. All traffic for which no channel is defined will
be accounted to the default channel named Ot her. Note: Extensive
use of many filters can cause load problems on your probe system.
We recommend defining specific, well-chosen filters for the data
you really want to analyse.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

674 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

24.10.2013 675
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

676 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

24.10.2013 677
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

678 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
53 jFlow V5 (Custom) Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

24.10.2013 679
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
54 LDAP Sensor

6.8.54 LDAP Sensor

The LDAP sensor monitors directory services using Lightweight Directory Access Protocol
(LDAP), connecting to the server trying a "bind". It shows the response time. If the server does
not respond or authentication fails, an error message will be triggered.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

LDAP Specific

Port Enter the LDAP port number, usually port 389 for unencrypted
connections. Please enter an integer value.

Distinguished Name Enter the Distinguished Name (DN) you want to authenticate to the
LDAP server. Usually, this is the information for the user you want
to authenticate with. For example, use the format
cn=Manager,dc=my -domain,dc=com for a DN on an OpenLDAP
server.

680 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
54 LDAP Sensor

LDAP Specific

Passwort Enter the password for the entered Distinguished Name.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

13.06.2013 681
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
54 LDAP Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

682 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
54 LDAP Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

13.06.2013 683
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
54 LDAP Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

684 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

6.8.55 M icrosoft SQL Sensor

The Microsoft SQL sensor monitors a Microsoft Structured Query Language (SQL) server. It
shows the response time, the number of records, and the value. The sensor can monitor if the
database server accepts connections, processes requests, and returns an expected result
when executing a custom SQL command.

The following SQL servers are supported: SQL Server 2008, SQL Server 2005 (including SQL
Server Express / Server Compact Editions), SQL Server 2000, SQL Server 7 and MSDE (requires
OLE DB installed on the machine running the PRTG probe that accesses the server)

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SQL-Server Specific Dat a

Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

24.10.2013 685
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

SQL-Server Specific Dat a

Instance Enter the SQL server instance's name if you want to connect to a
"named instance". For example, such an instance's name could be
SQLEXPRESS. Note: Sometimes you will see connection strings like
SQLSERVER\SQLINSTANCE in database clients. The first part is the
server name configured under the general server settings. The
second part refers to the instance name mentioned above. Never
enter this complete string in this PRTG form, merely provide the
second part (without the backslash). Please enter a string or leave
the field empty.

Port Define the port for the SQL connection. Choose between:
§ Aut omat ic: Automatically choose the right port.
§ Manual: Use a specific port. Define below. Standard value is
1433.

Port This field is only visible if manual port selection is enabled above.
Define the port number for the SQL connection. Please enter an
integer value.

Dat abase

Database Enter the name of the SQL database the sensor will connect to. For
example, such a database's name could be Northwind

Authentication Define the kind of authentication used for the connection to the
database. Choose between:
§ SQL Server: Use credentials specific to the SQL server. Please
enter them below.
§ Windows Aut hent icat ion: Use the Windows credentials defined
for the parent device this sensor is created on. Note: For
successful authentication, the defined Windows credentials must
be known to the SQL server, and SQL server and the computer
the PRTG probe is running on must be in the same domain.

User This field is only visible if SQL server authentication is enabled


above. Enter the user name that will be used for the database
connection.

Password This field is only visible if SQL server authentication is enabled


above. Enter the password that will be used for the database
connection.

686 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

Dat a

SQL Expression Enter a valid SQL statement to execute on the server. In your
SELECT statement, please specify the field name explicitly. Do not
use SELECT *! For example, a correct expression could be: SELECT
ProductName FROM Northwind.dbo.Products. When a cursor is
returned (i.e. with a SELECT statement), only the first row of data
will be processed.
Note: Executing stored procedures is currently not supported.

Record Count If you want to know how many records in your database were
affected by your SQL expression as defined above, you can count
the number of concerned records. Choose between:
§ Do not count number of records: Affected records will not be
counted.
§ Count number of records: The number of affected records will
be counted. Note: Enabling this option might increase the
execution time of this sensor.

Post-Processing If the SQL expression returns a result set, please define if you want
to further process it. Choose between:
§ Ignore result set : Do not do anything with the data returned.
§ Process numerical result : Regard the result set returned as
integer or float. You can set the sensor to Warning or Down
status for specific thresholds. Define below.
§ Process st ring result : Regard the result set returned as a string.
You can set the sensor to error for certain sub-strings contained
or missing. Define below.
§ Monit or for changes: Monitor if the result set has changed
since last check. The sensor will send an internal message
indicating that its value has changed. In combination with a
Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever a sensor value changes.

Condition "Warning" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Warning status. Choose between:
§ none: Do not set the sensor to Warning status for any
condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.

24.10.2013 687
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

§ does not equal: Result set must be unequal to the value


provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor into a Warning status. Please enter an integer or float
value.

Condition "Down" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Down status. Choose between:
§ none: Do not set the sensor to Down status for any condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.
§ does not equal: Result set must be unequal to the value
provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor to a Down status. Please enter an integer value.

Response Must Include This field is only visible if string results is enabled above. Enter a
string that must be part of the returned SQL string. If it is not, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Response Must Not This field is only visible if string results is enabled above. Enter a
include string that must not be part of the returned SQL string. If it is, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

688 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

24.10.2013 689
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

690 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

24.10.2013 691
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
55 Microsoft SQL Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

692 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
56 MySQL Sensor

6.8.56 M y SQL Sensor

The MySQL sensor monitors a MySQL server. It connects to the server and shows the
response time. Additionally, it can read the number of records and a value.

The following SQL servers are supported: MySQL server 5.1, 5.0, 4.1, 4.0, and 3.23

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

My SQL Server Specific Dat a

Port Define the port for the SQL connection. Choose between:
§ Aut omat ic: Automatically choose the right port.
§ Manual: Use a specific port. Define below. Standard value is
3306.

27.11.2012 693
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
56 MySQL Sensor

My SQL Server Specific Dat a

Timeout (sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

DB/SQL Dat a

Database Enter the name of the SQL database the sensor will connect to. For
example, such a database's name could be MyDatabase. This is a
logical entity on the database server where database objects like
tables or stored procedures exist. In case of the mySQL server it
also reflects a physical directory structure where your database
objects are stored. Enter the appropriate string which is the same
as you would supply when invoking the mysql.exe admin tool (with
the command line switch -p) or after the login with mysql.exe with
the command use.

User Enter the user name that will be used for the database connection.

Password Enter the password that will be used for the database connection.

Dat a

SQL Expression Enter a valid SQL statement to execute on the server. In your
SELECT statement, please specify the field name explicitly. Do not
use SELECT *! For example, a correct expression could be: SELECT
AVG(UnitPrice) FROM Products. When a cursor is returned (i.e. with
a SELECT statement), only the first row of data will be processed.

Record Count If you want to know how many records in your database were
affected by your SQL expression as defined above, you can count
the number of concerned records. Choose between:
§ Do not count number of records: Affected records will not be
counted.
§ Count number of records: The number of affected records will
be counted. Note: Enabling this option might increase the
execution time of this sensor.

Post-Processing If the SQL expression returns a result set, please define if you want
to further process it. Choose between:
§ Ignore result set : Do not do anything with the data returned.

694 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
56 MySQL Sensor

§ Process numerical result : Regard the result set returned as


integer or float. You can set the sensor to Warning or Down
status for specific thresholds. Define below.
§ Process st ring result : Regard the result set returned as a string.
You can set the sensor to error for certain sub-strings contained
or missing. Define below.
§ Monit or for changes: Monitor if the result set has changed
since last check. The sensor will send an internal message
indicating that its value has changed. In combination with a
Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever a sensor value changes.

Condition "Warning" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Warning status. Choose between:
§ none: Do not set the sensor to Warning status for any
condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.
§ does not equal: Result set must be unequal to the value
provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor into a Warning status. Please enter an integer or float
value.

Condition "Down" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Down status. Choose between:
§ none: Do not set the sensor to Down status for any condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.
§ does not equal: Result set must be unequal to the value
provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

27.11.2012 695
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
56 MySQL Sensor

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor to a Down status. Please enter an integer value.

Response Must Include This field is only visible if string results is enabled above. Enter a
string that must be part of the returned SQL string. If it is not, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Response Must Not This field is only visible if string results is enabled above. Enter a
include string that must not be part of the returned SQL string. If it is, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Note: For this sensor type, no port number can be set.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

696 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
56 MySQL Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

27.11.2012 697
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
56 MySQL Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

698 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
56 MySQL Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 699
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

6.8.57 NetFlow V5 Sensor

The NetFlow V5 sensor receives traffic data from a NetFlow V5 compatible device and shows
the traffic by type. Please make sure the sensor matches the NetFlow version your device is
exporting! There are several filter options available to divide traffic into different channels.

Note: In order for the sensor to work, NetFlow export of the respective version must be
enabled on the device. The device must send the flow data stream to the IP address of the
PRTG probe system on which the sensor is set up (either a local or remote probe). This sensor
type cannot be used in cluster mode. You can set it up on a local probe or remote probe only,
not on a cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

700 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

Net Flow Specific Set t ings

Receive NetFlow Enter the UDP port number on which the flow packets are received.
Packets on UDP Port It must match the one you have configured in the NetFlow export
options of your hardware router device. Please enter an integer
value. Note: When configuring export, please make sure you select
the appropriate NetFlow version for this sensor.

Sender IP Enter the IP address of the sending device you want to receive the
NetFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive NetFlow Select the IP address(es) on which PRTG listens to NetFlow


Packets on IP packets. The list of IP addresses shown here is specific to your
setup. To select an IP address, add a check mark in front of the
respective line. The IP address selected here must match the one
configured in the NetFlow export options of your hardware router
device. Note: When configuring export, please make sure you
select the appropriate NetFlow version for this sensor.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your exporter
device. If the number is different, monitoring results will be
incorrect. Please enter an integer value.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.

27.11.2012 701
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

Net Flow Specific Set t ings

Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Channel Configurat ion

Channel Selection Define the categories the traffic will be accounted to. There are
different groups of traffic available. Choose between:
§ Web: Internet web traffic.
§ File Transfer: Traffic caused by FTP.
§ Mail: Internet mail traffic.
§ Chat : Traffic caused by chat and instant messaging.
§ Remot e Cont rol: Traffic caused by remote control applications,
such as RDP, SSH, Telnet, VNC.
§ Infrast ruct ure: Traffic caused by network services, such as
DHCP, DNS, Ident, ICMP, SNMP.
§ Net BIOS: Traffic caused by NetBIOS communication.
§ Ot her Prot ocols: Traffic caused by various other protocols via
UDP and TCP.
For each traffic group, you can select how many channels will be
used for each group, i.e. how detailed traffic will be divided. For
each group, choose between:
§ No: Do not account traffic of this group in an own channel. All
traffic of this group will be accounted to the default channel
named Ot her.
§ Yes: Count all traffic of this group and summarize it into one
channel.
§ Det ail: Count all traffic of this group and further divide it into
different channels. The traffic will appear in several channels as
shown in the Cont ent column. Note: Extensive use of this
option can cause load problems on your probe system. We
recommend setting specific, well-chosen filters for the data you
really want to analyze.
Note: You can change the default configuration for groups and
channels. For details, please see section More.

702 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols

27.11.2012 703
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

Primary Toplist

§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

704 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

27.11.2012 705
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

706 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
57 NetFlow V5 Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

More

Paessler Website: Paessler NetFlow Testers


§ http://www.paessler.com/tools/netflowtester

Knowledge Base: How can I change the default groups and channels for xFlow and Packet
Sniffer sensors?
§ http://kb.paessler.com/en/topic/60203

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

27.11.2012 707
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

6.8.58 NetFlow V5 (Custom) Sensor

The NetFlow V5 (Custom) sensor receives traffic data from a NetFlow V5 compatible device and
shows the traffic by type. Please make sure the sensor matches the NetFlow version your
device is exporting! In this custom sensor, you can define your own channel definitions to
divide traffic into different channels.

Note: In order for the sensor to work, NetFlow export of the respective version must be
enabled on the device. The device must send the flow data stream to the IP address of the
PRTG probe system on which the sensor is set up (either a local or remote probe). This sensor
type cannot be used in cluster mode. You can set it up on a local probe or remote probe only,
not on a cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

708 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Net Flow Specific Set t ings

Receive NetFlow Enter the UDP port number on which the flow packets are received.
Packets on UDP Port It must match the one configured in the NetFlow export options of
your hardware router device. Please enter an integer value. Note:
When configuring export, please make sure you select the
appropriate NetFlow version for this sensor.

Sender IP Enter the IP address of the sending device you want to receive the
NetFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive NetFlow Select the IP address(es) on which PRTG listens to NetFlow


Packets on IP packets. The list of IP addresses shown here is specific to your
setup. To select an IP address, add a check mark in front of the
respective line. The IP address selected here must match the one
configured in the NetFlow export options of your hardware router
device. Note: When configuring export, please make sure you
select the appropriate NetFlow version for this sensor.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your device. If the
number is different, monitoring results will be incorrect. Please
enter an integer value.

07.02.2013 709
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

Net Flow Specific Set t ings

Channel Definition Please enter a channel definition to divide the traffic into different
channels. Write each definition in one line. For detailed information,
please see Channel Definit ions for xFlow, IPFIX , and Packet
Sniffer Sensors 2036 section. All traffic for which no channel is
defined will be accounted to the default channel named Ot her.
Note: Extensive use of many filters can cause load problems on
your probe system. We recommend defining specific, well-chosen
filters for the data you really want to analyze.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

710 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

07.02.2013 711
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

712 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

07.02.2013 713
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

714 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
58 NetFlow V5 (Custom) Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

07.02.2013 715
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

6.8.59 NetFlow V9 Sensor

The NetFlow V9 sensor receives traffic data from a NetFlow V9 compatible device and shows
the traffic by type. Please make sure the sensor matches the NetFlow version your device is
exporting! There are several filter options available to divide traffic into different channels.

Note: In order for the sensor to work, NetFlow export of the respective version must be
enabled on the device. The device must send the flow data stream to the IP address of the
PRTG probe system on which the sensor is set up (either a local or remote probe). This sensor
type cannot be used in cluster mode. You can set it up on a local probe or remote probe only,
not on a cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

716 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

Net Flow Specific Set t ings

Receive NetFlow Enter the UDP port number on which the flow packets are received.
Packets on UDP Port It must match the one you have configured in the NetFlow export
options of your hardware router device. Please enter an integer
value. Note: When configuring export, please make sure you select
the appropriate NetFlow version for this sensor.

Sender IP Enter the IP address of the sending device you want to receive the
NetFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive NetFlow Select the IP address(es) on which PRTG listens to NetFlow


Packets on IP packets. The list of IP addresses shown here is specific to your
setup. To select an IP address, add a check mark in front of the
respective line. The IP address selected here must match the one
configured in the NetFlow export options of your hardware router
device. Note: When configuring export, please make sure you
select the appropriate NetFlow version for this sensor.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your exporter
device. If the number is different, monitoring results will be
incorrect. Please enter an integer value.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.

27.11.2012 717
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

Net Flow Specific Set t ings

Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Channel Configurat ion

Channel Selection Define the categories the traffic will be accounted to. There are
different groups of traffic available. Choose between:
§ Web: Internet web traffic.
§ File Transfer: Traffic caused by FTP.
§ Mail: Internet mail traffic.
§ Chat : Traffic caused by chat and instant messaging.
§ Remot e Cont rol: Traffic caused by remote control applications,
such as RDP, SSH, Telnet, VNC.
§ Infrast ruct ure: Traffic caused by network services, such as
DHCP, DNS, Ident, ICMP, SNMP.
§ Net BIOS: Traffic caused by NetBIOS communication.
§ Ot her Prot ocols: Traffic caused by various other protocols via
UDP and TCP.
For each traffic group, you can select how many channels will be
used for each group, i.e. how detailed traffic will be divided. For
each group, choose between:
§ No: Do not account traffic of this group in an own channel. All
traffic of this group will be accounted to the default channel
named Ot her.
§ Yes: Count all traffic of this group and summarize it into one
channel.
§ Det ail: Count all traffic of this group and further divide it into
different channels. The traffic will appear in several channels as
shown in the Cont ent column. Note: Extensive use of this
option can cause load problems on your probe system. We
recommend setting specific, well-chosen filters for the data you
really want to analyze.
Note: You can change the default configuration for groups and
channels. For details, please see section More.

718 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols

27.11.2012 719
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

Primary Toplist

§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

720 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

27.11.2012 721
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

722 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
59 NetFlow V9 Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

More

Paessler Website: Paessler NetFlow Testers


§ http://www.paessler.com/tools/netflowtester

Knowledge Base: How can I change the default groups and channels for xFlow and Packet
Sniffer sensors?
§ http://kb.paessler.com/en/topic/60203

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

27.11.2012 723
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

6.8.60 NetFlow V9 (Custom) Sensor

The NetFlow V9 (Custom) sensor receives traffic data from a NetFlow V9 compatible device and
shows the traffic by type. Please make sure the sensor matches the NetFlow version your
device is exporting! In this custom sensor, you can define your own channel definitions to
divide traffic into different channels.

Note: In order for the sensor to work, NetFlow export of the respective version must be
enabled on the device. The device must send the flow data stream to the IP address of the
PRTG probe system on which the sensor is set up (either a local or remote probe). This sensor
type cannot be used in cluster mode. You can set it up on a local probe or remote probe only,
not on a cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

724 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Net Flow Specific Set t ings

Receive NetFlow Enter the UDP port number on which the flow packets are received.
Packets on UDP Port It must match the one configured in the NetFlow export options of
your hardware router device. Please enter an integer value. Note:
When configuring export, please make sure you select the
appropriate NetFlow version for this sensor.

Sender IP Enter the IP address of the sending device you want to receive the
NetFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive NetFlow Select the IP address(es) on which PRTG listens to NetFlow


Packets on IP packets. The list of IP addresses shown here is specific to your
setup. To select an IP address, add a check mark in front of the
respective line. The IP address selected here must match the one
configured in the NetFlow export options of your hardware router
device. Note: When configuring export, please make sure you
select the appropriate NetFlow version for this sensor.

Active Flow Timeout Enter a time span in minutes after which new flow data must be
(Minutes) received. If the timeout is reached and no new data is received, the
sensor may switch to an Unknown status. Please enter an integer
value. We recommend setting this one minute longer than the
respective timeout configured in your hardware router device.
Note: If you set this value too low, flow information might get lost!

Sampling Mode Define if you want to use the sampling mode. This setting must
accord to the setting in the flow exporter. Choose between:
§ Off: The standard flow will be used.
§ On: Switch into sampling mode and specify the sampling rate
below.

Sampling Rate This field is only visible when sampling mode is enabled above.
Enter a number that matches the sampling rate in your device. If the
number is different, monitoring results will be incorrect. Please
enter an integer value.

07.02.2013 725
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

Net Flow Specific Set t ings

Channel Definition Please enter a channel definition to divide the traffic into different
channels. Write each definition in one line. For detailed information,
please see Channel Definit ions for xFlow, IPFIX , and Packet
Sniffer Sensors 2036 section. All traffic for which no channel is
defined will be accounted to the default channel named Ot her.
Note: Extensive use of many filters can cause load problems on
your probe system. We recommend defining specific, well-chosen
filters for the data you really want to analyze.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

726 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

07.02.2013 727
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

728 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

07.02.2013 729
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

730 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
60 NetFlow V9 (Custom) Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

07.02.2013 731
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

6.8.61 Oracle SQL Sensor

The Oracle SQL sensor monitors an Oracle SQL server. It connects to the server and shows
the response time (measured from the time when the connection is opened to the time when
the return values of the SQL query—if configured—have been received). Additionally, it can
read the number of records and a value.

The following SQL servers are supported: Supports Oracle servers 11g, 10g, 9i, 8i, 8.0, and 7.3,
including Oracle 10g Express, and Oracle 8i Personal and Lite editions (requires default TCP port
setting 1521).

Note: On the client computer running the PRTG probe where this sensor is created on, Oracle
Net is used for direct TCP/IP communication; OCI is not supported any more. You do not need
to install an Oracle client or define a TNSNAMES.ORA on the client computer.

Note: With Oracle version 11.2.0.4, Oracle's TCP/IP authentication method has changed. You
will encounter connection problems with credential errors when using the direct connection
mode as of this Oracle version. In this case, please install the 32-bit Oracle client on the
machine which is running the PRTG probe and choose Use Oracle client as connection mode
in the sensor settings.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

732 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Oracle Specific Dat a

Timeout (Sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Port Enter the port number that will be used for the connection. Default
value is 1521. Please enter an integer value.

Connection Mode Select which mode you want to use to connect to the Oracle
server. Choose between:
§ Use direct mode (TCP/IP): Use Oracle Net for direct TCP/IP
communication.
Note: As of Oracle version 11.2.0.4, please use the Oracle client
(see sensor description above).
§ Use Oracle client : Use the Oracle client for communication. It
needs to be installed the machine which is running the PRTG
probe.

DB/SQL Dat a

Service Name / Alias Enter the name of the SQL database the sensor will connect to. For
example, such a database's name could be orcl

User Enter the user name that will be used for the database connection.

Password Enter the password that will be used for the database connection.

Dat a

SQL Expression Enter a valid SQL statement to execute on the server. In your
SELECT statement, please specify the field name explicitly. Do not
use SELECT *! For example, a correct expression could be: SELECT
sum(salary) FROM hr.employees. When a cursor is returned (i.e.
with a SELECT statement), only the first row of data will be
processed.

28.05.2014 733
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

Record Count If you want to know how many records in your database were
affected by your SQL expression as defined above, you can count
the number of concerned records. Choose between:
§ Do not count number of records: Affected records will not be
counted.
§ Count number of records: The number of affected records will
be counted. Note: Enabling this option might increase the
execution time of this sensor.

Post-Processing If the SQL expression returns a result set, please define if you want
to further process it. Choose between:
§ Ignore result set : Do not do anything with the data returned.
§ Process numerical result : Regard the result set returned as
integer or float. You can set the sensor to Warning or Down
status for specific thresholds. Define below.
§ Process st ring result : Regard the result set returned as a string.
You can set the sensor to error for certain sub-strings contained
or missing. Define below.
§ Monit or for changes: Monitor if the result set has changed
since last check. The sensor will send an internal message
indicating that its value has changed. In combination with a
Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever a sensor value changes.

Condition "Warning" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Warning status. Choose between:
§ none: Do not set the sensor to Warning status for any
condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.
§ does not equal: Result set must be unequal to the value
provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor into a Warning status. Please enter an integer or float
value.

734 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

Condition "Down" This field is only visible if numeric results is enabled above. Define a
condition of the returned numeric SQL result set that will set the
sensor to a Down status. Choose between:
§ none: Do not set the sensor to Down status for any condition.
§ equals: Result set must be the same as the value provided
below.
§ is above: Result set must be above the value provided below.
§ lower t han: Result set must be below the value provided below.
§ does not equal: Result set must be unequal to the value
provided below.
Note: This threshold check the SQL result set only. You can set
additional thresholds in the sensor's channel settings 1709 .

Value This field is only visible if numeric results is enabled above. Enter a
value of the returned numeric SQL result set that will set the
sensor to a Down status. Please enter an integer value.

Response Must Include This field is only visible if string results is enabled above. Enter a
string that must be part of the returned SQL string. If it is not, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Response Must Not This field is only visible if string results is enabled above. Enter a
include string that must not be part of the returned SQL string. If it is, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

28.05.2014 735
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

736 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 737
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More

Knowledge Base: How do PRTG sensors connect to Oracle databases?

§ http://kb.paessler.com/en/topic/52803

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

738 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
61 Oracle SQL Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 739
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

6.8.62 Packet Sniffer Sensor

Monitors the headers of data packets passing a local network card using built-in packet sniffer.
You can choose from predefined channels. Only header traffic will be analyzed.

Note: This sensor can be set up on a Probe Device only! By default, you can only monitor traffic
passing the PRTG probe system on which's Probe Device the sensor is set up (either a local or
remote probe). To monitor other traffic in your network, you can configure a monitoring port
(if available) to which the switch sends a copy of all traffic. You can then physically connect this
port to a network card of the computer the PRTG probe (either local or remote probe) is
running on. This way, PRTG will be able to analyze the complete traffic that passes through the
switch. This feature of your hardware may be called Switched Port Analyzer (SPAN), port
mirroring, or port monitoring.

For a general introduction to the technology behind packet sniffing, please see Monit oring
Bandwidt h via Packet Sniffing 1964 section.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

740 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sniffer Specific

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Network Adapters Define the network adapters that will be monitored by the sensor.
You see a list of names with all adapters available on the probe
system. To select an adapter, set a check mark symbol in front of
the respective name.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.
§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Channel Configurat ion

Channel Selection Define the categories the traffic will be accounted to. There are
different groups of traffic available. Choose between:
§ Web: Internet web traffic.
§ File Transfer: Traffic caused by FTP.

28.05.2014 741
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

Channel Configurat ion

§ Mail: Internet mail traffic.


§ Chat : Traffic caused by chat and instant messaging.
§ Remot e Cont rol: Traffic caused by remote control applications,
such as RDP, SSH, Telnet, VNC.
§ Infrast ruct ure: Traffic caused by network services, such as
DHCP, DNS, Ident, ICMP, SNMP.
§ Net BIOS: Traffic caused by NetBIOS communication.
§ Ot her Prot ocols: Traffic caused by various other protocols via
UDP and TCP.
For each traffic group, you can select how many channels will be
used for each group, i.e. how detailed traffic will be divided. For
each group, choose between:
§ No: Do not account traffic of this group in an own channel. All
traffic of this group will be accounted to the default channel
named Ot her.
§ Yes: Count all traffic of this group and summarize it into one
channel.
§ Det ail: Count all traffic of this group and further divide it into
different channels. The traffic will appear in several channels as
shown in the Cont ent column. Note: Extensive use of this
option can cause load problems on your probe system. We
recommend setting specific, well-chosen filters for the data you
really want to analyze.
Note: You can change the default configuration for groups and
channels. For details, please see section More.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

742 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

28.05.2014 743
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

744 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 745
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

746 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
62 Packet Sniffer Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

More

Knowledge Base: How can I change the default groups and channels for xFlow and Packet
Sniffer sensors?
§ http://kb.paessler.com/en/topic/60203

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics

§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

28.05.2014 747
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
63 Packet Sniffer (Custom) Sensor

6.8.63 Packet Sniffer (Custom) Sensor

Monitors the headers of data packets passing a local network card using built-in packet sniffer.
You can define your own channels. There are no predefined channels for this sensor type.
Only header traffic will be analyzed.

Note: This sensor can be set up on a Probe Device only! By default, you can only monitor traffic
passing the PRTG probe system on which's Probe Device the sensor is set up (either a local or
remote probe).To monitor other traffic in your network, you can configure a monitoring port (if
available) to which the switch sends a copy of all traffic. You can then physically connect this
port to a network card of the computer the PRTG probe (either local or remote probe) is
running on. This way, PRTG will be able to analyze the complete traffic that passes through the
switch. This feature of your hardware may be called Switched Port Analyzer (SPAN), port
mirroring, or port monitoring.

For a general introduction to the technology behind packet sniffing, please see Monit oring
Bandwidt h via Packet Sniffing 1964 section.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

748 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
63 Packet Sniffer (Custom) Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sniffer specific

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow and Packet Sniffer Sensors 2032 section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow
and Packet Sniffer Sensors 2032 section.

Channel Definition Please enter a channel definition to divide the traffic into different
channels. Write each definition in one line. For detailed information,
please see Channel Defint ions for xFlow and Packet Sniffer
Sensors 2036 section. All traffic for which no channel is defined will
be accounted to the default channel named Ot her. Note: Extensive
use of many filters can cause load problems on your probe system.
We recommend defining specific, well-chosen filters for the data
you really want to analyse. We recommend to not use more than
20 channels in graphs and tables, and not more than 100 channels
in total. For performance reasons, it is better to add several
sensors with less channels each.

Network Adapters Define the network adapters that will be monitored by the sensor.
You see a list of names with all adapters available on the probe
system. To select an adapter, set a check mark symbol in front of
the respective name.

Log Stream Data to Define if the probe will write a log file of the stream and packet
Disk (for Debugging) data to the data folder (see Dat a St orage 2074 ). Choose between:
§ None (recommended): Do not write additional log files.
Recommended for normal use cases.

24.10.2013 749
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
63 Packet Sniffer (Custom) Sensor

Sniffer specific

§ Only for t he 'Ot her' channel: Only write log files of data that is
not filtered otherwise and therefore accounted to the default
Ot her channel.
§ All st ream dat a: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

750 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
63 Packet Sniffer (Custom) Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

24.10.2013 751
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
63 Packet Sniffer (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

752 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
63 Packet Sniffer (Custom) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

24.10.2013 753
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
63 Packet Sniffer (Custom) Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

754 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
64 Passive Application Performance Sensor

6.8.64 Passive Application Performance Sensor

The Passive Application Performance sensor monitors Transport Control Protocol (TCP)
connection timings using packet sniffer. It can measure the performance of many different web
applications without actually having direct access to neither the client nor the server. In order
to obtain valuable data, these applications must work TCP-based and initiate a new session
with each request.

The sensor shows the total number of packets per second on the selected network card, the
number of dropped packets per second by PRTG because of system overload (more processor
power is required if this value is above zero to cope with the traffic), as well as the number of
currently active connections on all monitored applications.

For defined applications, the sensor can show (together with the corresponding application
name):

§ Request time in msec: average time between the initial (SYN) packet from the client and the
first request package from the client
§ Response time in msec: average time between the initial (SYN) packet from the client and
first packet of the result from the server
§ ACK (acknowledge) time in msec: average time between the initial (SYN) packet of a
connection from the client until the server sends an ACK (acknowledge) packet. This means
that a TCP connection was successfully established (in LANs this value is zero in most cases
and only increases for extreme loads).
§ Count: total number of observed connections to the service in the last monitoring interval.
This is the number of measurements the average is based on. The higher the value the more
reliable/averaged the data is. If this value is zero, PRTG did not see any packets for this
service.

Important notice: This sensor is an experimental sensor. Currently, it is in bet a status. The
methods of operating can change at any time, as well as the available settings. Do not expect
that all functions will work properly, or that this sensor works as expected at all. Be aware that
this type of sensor can be removed again from PRTG at any time.

For a general introduction to the technology behind packet sniffing, please see Monit oring
Bandwidt h via Packet Sniffing 1964 section.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

24.10.2013 755
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
64 Passive Application Performance Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Applicat ions

Network Adapter Select the network adapter you want to monitor.

Applications Define the applications you want to monitor. For each application,
use one dedicated line. Use the following syntax to define an
application to be monitored: ip:port=application. Provide the IP
address and port number of the application. Behind the equals sign,
enter a name for the application which will be displayed in the
channels. Please enter a string. This sensor will create four sensor
channels with the application name, e.g., "Application (ACK)".

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

756 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
64 Passive Application Performance Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

24.10.2013 757
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
64 Passive Application Performance Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

758 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
64 Passive Application Performance Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

24.10.2013 759
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
64 Passive Application Performance Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

760 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
65 PerfCounter Custom Sensor

6.8.65 PerfCounter Custom Sensor

The PerfCounter Custom sensor monitors a configured set of Windows Performance Counters.
You can define your own channels. There are no predefined channels available for this sensor
type. To find out which performance counters are available on the target system and what
their names are, please see section More 766 .

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible.

Note: The user account has to be a member of the Performance Monitor Users user group on
the target system.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
RemoteRegistry "Remote Registry" Windows service is running on the target computer. If you
fail to do so, a connection via Performance Counters will not be possible.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

28.05.2014 761
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
65 PerfCounter Custom Sensor

Performance Count er Set t ings

List of Counters Enter a list of performance counters which will be queried. Define
one counter per row. PRTG will create one channel for each
counter. Use the following syntax: the name of the counter,
followed by two colons (::) and the unit. Example: \Processor
(_Total)\% Processor Time::%

Mode This setting determines if the returning value will be displayed as


absolute value or if the difference between the last and the current
value will be used. Choose between:
§ Absolut e (recommended): The returning value will be displayed
as absolute value.
§ Difference: The difference between last and current value will be
displayed. Note: Please make sure that all counters which are
monitored are capable of this mode if you select it.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

762 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
65 PerfCounter Custom Sensor

Performance Count er Set t ings

List of Counters The list of counters monitored by this sensor. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Mode The mode in which the returning values are displayed. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

28.05.2014 763
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
65 PerfCounter Custom Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

764 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
65 PerfCounter Custom Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 765
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
65 PerfCounter Custom Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More

Knowledge Base: How can I find out the names of available Performance Counters?

766 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
65 PerfCounter Custom Sensor

§ http://kb.paessler.com/en/topic/50673

Knowledge Base: Remote Monitoring of Specific Performance Counters


§ http://kb.paessler.com/en/topic/59804

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 767
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
66 PerfCounter IIS Application Pool Sensor

6.8.66 PerfCounter IIS Application Pool Sensor

The PerfCounter IIS Application Pool sensor monitors a Microsoft Internet Information Services
(IIS) application pool using Windows Performance Counters. This sensor can show the overall
state of an application pool, the number of worker processes, the number of failures in worker
processes, as well as the number of ping failures, shutdown failures, and startup failures in
worker processes.

Requirement: Microsoft IIS Version 7.5

In order to monitor Microsoft Internet Information Services (IIS) application pools, this sensor
needs IIS version 7.5 or later to be installed on the target system.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible.

Note: The user account has to be a member of the Performance Monitor Users user group on
the target system.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
RemoteRegistry "Remote Registry" Windows service is running on the target computer. If you
fail to do so, a connection via Performance Counters will not be possible.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

768 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
66 PerfCounter IIS Application Pool Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor Microsoft Internet Information Services (IIS) application pools, PRTG will
create one sensor for each pool. The settings you make in this dialog are valid for all of the
sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

IIS Applicat ion Pool Specific

Application Pool A list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

03.05.2013 769
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
66 PerfCounter IIS Application Pool Sensor

IIS Applicat ion Pool Specific

Application Pool The name of the application pool that is monitored by this sensor.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

770 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
66 PerfCounter IIS Application Pool Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

03.05.2013 771
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
66 PerfCounter IIS Application Pool Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

772 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
66 PerfCounter IIS Application Pool Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

03.05.2013 773
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
66 PerfCounter IIS Application Pool Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

774 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
67 Ping Sensor

6.8.67 Ping Sensor

The Ping sensor sends an Internet Control Message Protocol (ICMP) echo request ("Ping") from
the computer running the probe to the device it is created on, in order to monitor the
availability of a device. When using more than one Ping per interval, it also measures minimum
and maximum Ping time as well as packet loss in percent.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Ping Set t ings

Timeout (Sec.) Enter a timeout in seconds for the Ping. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Packet Size (Bytes) Enter the packet size in bytes for the Ping. You can choose any
value between 1 and 10000. We recommend using the default
value.

28.05.2014 775
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
67 Ping Sensor

Ping Set t ings

Ping Method Define the kind of Ping check that will be performed. Choose
between:
§ Send one single Ping: With each scanning interval, send a single
Ping only. A sensor in this setting will show the Ping time only.
This setting is good for simply availability monitoring.
§ Send mult iple Ping request : With each scanning interval, send
multiple Pings in a row. A sensor in this setting will also show
minimum and maximum Ping time as well as packet loss (in
percent). This setting is good if you want to create reports about
average Ping times out of a series of ping requests. Note: When
using multiple request, all of them have to get lost in order for
the sensor to switch to a Down status. For example, if there is
only one Ping request answered in a series of five, the sensor will
still show a green Up status.

Ping Count This field is only visible if sending multiple Pings is enabled above.
Enter the number of Pings that are sent in a row for one interval.
Please enter an integer value.

Ping Delay (in ms) This field is only visible if sending multiple Pings is enabled above.
Enter the time in milliseconds PRTG has to wait between two Ping
requests. Please enter an integer value. Note: Increase the value if
the target device drops Ping packets due to denial-of-service (DOS)
suspicion.

Auto Acknowledge You can define that a Down status of this sensor will be
acknowledged 145 automatically.
§ Show "Down" st at us on error (default ): Do not automatically
acknowledge an alarm if this sensor changes to a Down status.
§ Show "Down (Acknowledged)" st at us on error: Automatically
acknowledge an alarm. If this sensor changes to a Down status,
it will automatically change to Down (Acknowledged). Note: The
sensor will also go through a Down status, so any sensor state
triggers 1716 using this will still provoke notifications, as
configured.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

776 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
67 Ping Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 777
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
67 Ping Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

778 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
67 Ping Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How to create/customize statistical PING sensor?
§ http://kb.paessler.com/en/topic/1873

Knowledge Base: Can I create an inverse Ping sensor?

28.05.2014 779
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
67 Ping Sensor

§ http://kb.paessler.com/en/topic/10203

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

780 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
68 Ping Jitter Sensor

6.8.68 Ping Jitter Sensor

The Ping Jitter sensor sends a series of Internet Control Message Protocol (ICMP) echo
requests ("Pings") to the given URI to determine the statistical jitter. The Real Time Jitter value is
updated every time a packet is received using the formula described in RFC 1889:

Jitter = Jitter + ( abs( ElapsedTime – OldElapsedTime ) – Jitter ) / 16

The Statistical Jitter value is calculated on the first x packets received using the statistical
variance formula:

Jitter Statistical = SquareRootOf( SumOf( ( ElapsedTime[i] – Average) ^ 2 ) /


( ReceivedPacketCount – 1 ) )

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be

07.02.2013 781
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
68 Ping Jitter Sensor

Basic Sensor Set t ings

shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Ping Count Define the number of pings that will be sent. Please enter an
integer value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

782 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
68 Ping Jitter Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

07.02.2013 783
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
68 Ping Jitter Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

784 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
68 Ping Jitter Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 785
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
69 Pingdom Sensor

6.8.69 Pingdom Sensor

The Pingdom sensor queries an account at Pingdom.com and retrieves values for one "check"
configured in the respective Pingdom account. With every scanning interval, the sensor will
always catch the last value available in the "detailed check log" of your Pingdom account.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

786 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
69 Pingdom Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Pingdom Check Name Enter the name of the "check" you want to retrieve data for. Enter it
exactly the way configured in your Pingdom account. This setting is
case sensitive! Please enter a string.

Username Please enter the username of the Pingdom account you want to
query. Please enter a string.

Password Please enter the password of the Pingdom account you want to
query. Please enter a string.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

07.02.2013 787
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
69 Pingdom Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1831 . Note: Please make sure you select
the same scanning interval you configured for the "check" in your
Pingdom account. Only if the intervals match PRTG can catch every
measurement from your "check".

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

788 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
69 Pingdom Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

07.02.2013 789
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
69 Pingdom Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

790 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
69 Pingdom Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 791
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
70 POP3 Sensor

6.8.70 POP3 Sensor

The POP3 sensor monitors a mail server using Post Office Protocol version 3 (POP3). It shows
the response time of the server.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

792 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
70 POP3 Sensor

Pop3 Specific

Timeout Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Port Specify the port that will be used for the POP3 connection. For
non-secure connections usually port 110 is used; usually port 995
for SSL connections. The actual setting depends on the server you
are connecting to. Please enter an integer value. We recommend
using the default value. If you do not get a connection, please try
another port number.

Security Specifiy if an encryption will be used for the connection. Choose


between:
§ Encry pt dat a using Transport -Level Securit y (TLS)
§ No encry pt ion (use plain t ext )

SSL-Method This field is only visible if security is enabled above. Select the SSL
method that will be used when connecting to the server. We
recommend using the default value. Only if you experience
connection problems, try another setting. Choose between:
§ SSL V2
§ SSL V2 or V3
§ SSL V3
§ TLS V1

27.11.2012 793
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
70 POP3 Sensor

Pop3 Aut horisat ion

POP3 Authentication Select the kind of authentication for the POP3 connection. Choose
Type between:
· Wit hout Login: Monitor the connection to the POP3 server only.
· Username and Password: Log into the POP3 server with user
name and password (simple login, non-secure).

· 128-bit MD5 hash value (APOP): Send the password in an


encrypted form using APOP. This option must be supported by
the POP3 server you're connecting to.

Username This field is only visible if an option with login is selected above.
Enter a username for POP3 authentication. Please enter a string.

Password This field is only visible if an option with login is selected above.
Enter a password for POP3 authentication. Please enter a string.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

794 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
70 POP3 Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

27.11.2012 795
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
70 POP3 Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

796 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
70 POP3 Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 797
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
71 POP3 Email Count Sensor

6.8.71 POP3 Email Count Sensor

The POP3 Email Count sensor connects to a POP3 email account and returns the number of
emails stored in it. Additionally, you can filter by to or from address, or by subject, to only
count mails matching the search pattern.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

798 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
71 POP3 Email Count Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Username Define the username of the POP3 account you want to log into.
Note: As POP3 server, this sensor will use the parent device's IP
Address/DNS Name value.

Password Define the passwort for the POP3 account. Note: As POP3 server,
this sensor will use the parent device's IP Address/DNS Name
value.

Mailserver POP3 Port Define the port number the POP3 server is running at. Please enter
an integer value. Note: As POP3 server, this sensor will use the
parent device's IP Address/DNS Name value.

Use SSL Define whether to use SSL for the connection to the POP3 server.
Choose between:
§ No
§ Yes
Note: As POP3 server, this sensor will use the parent device's
hostname.

Filter To Address Optionally define a To address. Only mails containing this will be
counted by the sensor. Please enter a string or leave the field
empty.

Filter From Address Optionally define a From address. Only mails containing this will be
counted by the sensor. Please enter a string or leave the field
empty.

Filter Subject Content Optionally define an email Subject. Only mails containing this will be
counted by the sensor. Please enter a string or leave the field
empty.

07.02.2013 799
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
71 POP3 Email Count Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

800 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
71 POP3 Email Count Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

07.02.2013 801
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
71 POP3 Email Count Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

802 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
71 POP3 Email Count Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 803
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
72 Port Sensor

6.8.72 Port Sensor

The Port sensor monitors a network service by connecting to its port. It tries to connect to
the specified TCP/IP port number of a device and waits for the request to be accepted.
Depending on your settings, it can alert you either when the monitored port is open, or when
it is closed.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Port Specific

Timeout (sec.) Enter a timeout in seconds for the port connect. If the reply takes
longer than this value the request is aborted and an error message
is triggered.

Port Enter the number of the port the sensor will try to connect to.
Please enter an integer value.

804 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
72 Port Sensor

Port Specific

SSL (Secure Sockets Specify if an encryption will be used for the connection. Choose
Layer) between:
§ Don't use SSL (recommended)
§ Use SSL

SSL-Method This field is only visible if security is enabled above. Select the SSL
method that will be used when connecting to the server. We
recommend using the default value. Only if you experience
connection problems, try another setting. Choose between:
§ SSL V2
§ SSL V2 or V3
§ SSL V3
§ TLS V1

Advanced Sensor Set t ings

Goal Define how the sensor will report on the port defined above.
Choose between:
§ Open: The sensor will return a green OK status if the port is
open, and show a red Down status if the port is closed.
§ Closed: The sensor will return a green OK status if the port is
closed, and show a red Down status if the port is open.

Command Define whether a command will be sent after the port is opened.
Choose between:
§ Don't send command: Only check if a connection to the port is
possible.
§ Send command: Open a Telnet session to the respective port
and send the command. Note: You cannot use this option if the
target machine is a webserver.

Command This field is only visible if sending a command is enabled above.


Enter a command that will be sent in Telnet session to the
respective port. You cannot use line breaks, but a simple Telnet
command in a single line only. Please enter a string.

Response Define if the response received will be further processed. Choose


between:
§ Ignore response: Do not check the response.

24.10.2013 805
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
72 Port Sensor

Advanced Sensor Set t ings

§ Check response code (int eger): Check if the response matches


a defined response code. Define below.
§ Check response t ext : Check if the response matches a defined
response text. Define below.

Allowed Code This field is only visible if response code check is enabled above.
Enter a code that must be returned. If it does not match the sensor
will be set to a Down status. Please enter an integer value.

Check For Existing This setting is only visible if text processing is activated above.
Keywords (Positive) Check if a certain keyword is part of the received value. If there is
no match, the sensor will show a "Down" status.
§ Disable: Do not check for positive keywords.
§ Enable key word check (posit ive): Check if a certain keyword
exists in the received value. Define below.

Text Must Include This setting is only visible if keyword check is activated above.
Enter a search string that must be contained in the returned value.

For Keyword Search Define the method you want to provide the search string with.
Use Choose between:
§ Plain Text : Search for a simple string.
§ Regular Expression: Search using a regular expression. For
more details, see Regular Expressions 2048 section.

Check For Existing This setting is only visible if text processing is activated above.
Keywords (Negative) Check if a certain keyword is not part of the received value. If
there is a match, the sensor will show a "Down" status.

§ Disable: Do not check for negative keywords.

§ Enable key word check (negat ive): Check if a certain keyword


does not exist in the received value. Define below.

Text Must Not Include This setting is only visible if keyword check is activated above.
Enter a search string that must not be contained in the returned
value.

For Keyword Search Define the method you want to provide the search string with.
Use Choose between:
§ Plain Text : Search for a simple string.
§ Regular Expression: Search using a regular expression. For
more details, see Regular Expressions 2048 section.

806 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
72 Port Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

24.10.2013 807
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
72 Port Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

808 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
72 Port Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

24.10.2013 809
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
72 Port Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

810 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
73 Port Range Sensor

6.8.73 Port Range Sensor

The Port Range sensor monitors a network service by connecting to various TCP/IP ports. It
tries to connect to the specified TCP/IP port numbers of a device in succession and waits for
each request to be accepted. It returns the number of closed ports and open ports in two
different channels. Optionally, you can set limits in the sensor's channel settings. This way you
can get alerted about open/closed ports.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Port Range Specific

Timeout (sec.) Enter a timeout in seconds for the port connect. If the reply takes
longer than this value the request is aborted and an error message
is triggered.

Port-by-Port-Delay (ms) Specify in milliseconds how long the sensor will wait to go to the
next port while running through all given ports.

29.11.2012 811
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
73 Port Range Sensor

Port Range Specific

Port Range Selection Define whether you want to monitor all ports within a range or if
Method you want to monitor several individual ports. Choose between:
§ Port Range wit h st art /end: Monitor ports within a range.
§ List of Port s: Provide a list of several individual ports to monitor.

Range Start This field is only visible if the port range method is enabled above.
Enter the port number where the scan will start. Please enter an
integer value.

Range End This field is only visible if the port range method is enabled above.
Enter the port number where the scan will end. Please enter an
integer value.

Port List This field is only visible if the list of ports method is enabled above.
Enter the numbers of the ports the sensor will try to connect to.
Please enter one or more individual integer values.

If Value Changes Define what will be done in case the value of a sensor channel
changes. Choose between:
§ Ignore changes: No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

812 29.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
73 Port Range Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

29.11.2012 813
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
73 Port Range Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

814 29.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
73 Port Range Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

29.11.2012 815
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
74 Probe Health Sensor

6.8.74 Probe Health Sensor

The Probe Health sensor monitors internal PRTG parameters. It shows the state of the PRTG
probe (either for the local probe, a remote probe 2050 , or a cluster 81 probe). This sensor type is
created automatically by PRTG and cannot be deleted. It checks various parameters of your
PRTG system which can affect the quality of the monitoring results:

§ Healt h: This index value sums up the probe state into a value between 100% (healthy) and
0% (failing). Frequent or repeated health values below 100% should be investigated.
§ CPU Load: This channel shows the current percentage CPU load. Extensive CPU load can lead
to false, incomplete, and incorrect monitoring results. This value usually should stay below
50%.
§ Handles: This is a counter for the data structures of the operating system. It is responsible
for internal resource management. Repeated obviously increasing values should be
investigated.
§ Int erval Delay non-WMI&SNMP: This channel shows the percentage interval delay for all
sensor types which are not from the type SNMP or WMI.
§ Int erval Delay SNMP: This channel shows the percentage interval delay for SNMP sensors. If
this value is above 0% there are probably very slow SNMP V3 sensors. In this case, try to
increase the monitoring intervals or distribute the sensors over several probes.
§ Int erval Delay WMI: This channel shows the percentage interval delay for WMI sensors. If
this value is above 0% WMI sensors could not be checked according to their interval. 100%
means that WMI sensors on the average are checked with twice their interval. For values
above 0% try to increase the monitoring intervals or distribute the sensors over several
probes to keep the number of WMI sensors per probe below 120 (with 60 seconds interval)
or 600 (with 300 seconds interval).
§ Lost Flow Packet s: This channel shows the percentage of lost flow packets.
§ Memory Usage: This channel shows the amount of memory being used by the PRTG probe
service as reported by the memory manager. Repeated obviously increasing values should
be investigated. If the value is constantly above 2 GB this indicates that PRTG runs at its
limits. In this case you should distribute some sensors to Remote Probe 2050 .
§ Message Queue: This channel shows the number of monitoring results from the probe
which have not been processed yet by the core. This value usually should stay below 1/10
of the sensor count.
§ Open Request s: This channel shows the number of currently active monitoring requests.
This value should stay below the maximum of 500 open requests.
§ Threads: This channel shows the number of program parts which are running simultaneously
currently. This value can increase with heavy load. The number should not exceed 100 in
normal operation.

This sensor can be set up on a Probe Device only!

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

816 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
74 Probe Health Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

03.05.2013 817
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
74 Probe Health Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

818 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
74 Probe Health Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.05.2013 819
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
75 QoS (Quality of Service) One Way Sensor

6.8.75 QoS (Quality of Service) One Way Sensor

The QoS (Quality of Service) One Way sensor monitors parameters regarding the quality of a
network connection between two probes, which is important, for example, when using Voice
over IP (VoIP) over this connection. The sensor sends a series of UDP packets from the parent
probe to another probe and measures packet loss, jitter, Packet Delay Variation (PDV), etc.

Note: In order for this sensor to work, there has to be at least one remote probe 2049
configured in your setup. The sensor can be created on the Probe Device of either a local or
remote probe.

Note: This sensor type cannot be cloned using the Clone Object 1734 function.

For a general introduction to the technology behind Quality of Service monitoring, please see
Monit oring Qualit y of Service 1971 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

820 03.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
75 QoS (Quality of Service) One Way Sensor

Qualit y of Service Measurement

Timeout (Sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered. The maximum timeout is 900 seconds (15 minutes).

Target Probe Define the target probe that will receive the UDP packets. In the
drop down menu, all local and remote probes of your setup are
shown. When running the sensor on the local probe, select a
remote probe as Target Probe; if no remote probe is available,
please install and connect a remote probe 2049 first. When running
the sensor on a remote probe, select either another remote probe
or the local probe as target. The sensor will measure values for the
network track between the probe the sensor is created on and the
target probe. Note: You must ensure that firewalls, NAT rules, etc.
will allow the UDP packets to reach the target probe. The Windows
firewall on the target system will be automatically opened by the
probe.

Target Host/IP Define the IP address of the target probe to which the probe the
sensor is created on will connect. When you're not using NAT rules,
this is usually the address shown above next to the target probe's
name.

Port Define the source and t arget port for the UDP packets. This port
will be used on both the source and target probe. Please use a
different port for each QoS sensor to make sure packets can be
assigned correctly. Enter an integer value between 1024 and
65536. Note: This port must be available on both the source and
target system.

Number of Packets Define how many packets are sent for each scanning interval. We
recommend using 1000. Please enter an integer value.

Size of Packets (Bytes) Define the size in bytes of the packets sent. We recommend using
172. Please enter an integer value.

Time between Packets Define the size in milliseconds that will be waited between two
(ms) packets. We recommend using 20. Please enter an integer value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

03.06.2014 821
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
75 QoS (Quality of Service) One Way Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

822 03.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
75 QoS (Quality of Service) One Way Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

03.06.2014 823
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
75 QoS (Quality of Service) One Way Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

824 03.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
75 QoS (Quality of Service) One Way Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.06.2014 825
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
76 QoS (Quality of Service) Round Trip Sensor

6.8.76 QoS (Quality of Service) Round Trip Sensor

The QoS (Quality of Service) Round Trip sensor monitors parameters regarding the quality of a
network connection between two probes. This is important, for example, when using Voice
over IP (VoIP) over this connection. The sensor sends a series of UDP packets from the parent
probe to another probe. Then, the traffic is sent back to the original probe. The sensor
measures packet loss, jitter, Packet Delay Variation (PDV), the round trip time (RTT), etc.

Note: In order for this sensor to work, there has to be at least one remote probe 2049
configured in your setup. The sensor can be created on the Probe Device of either a local or
remote probe.

Note: This sensor type cannot be cloned using the Clone Object 1734 function.

For a general introduction to the technology behind Quality of Service monitoring, please see
Monit oring Qualit y of Service 1971 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

826 03.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
76 QoS (Quality of Service) Round Trip Sensor

Qualit y of Service Measurement

Timeout (Sec.) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered. The maximum timeout is 900 seconds (15 minutes).

Target Probe Define the target probe that will receive the UDP packets. In the
drop down menu, all local and remote probes of your setup are
shown. When running the sensor on the local probe, select a
remote probe as Target Probe; if no remote probe is available,
please install and connect a remote probe 2049 first. When running
the sensor on a remote probe, select either another remote probe
or the local probe as target. The sensor will measure values for the
network track between the probe the sensor is created on and the
target probe. Note: You must ensure that firewalls, NAT rules, etc.
will allow the UDP packets to reach the target probe. The Windows
firewall on the target system will be automatically opened by the
probe.

Target Host/IP Define the IP address of the target probe to which the probe the
sensor is created on will connect. When you're not using NAT rules,
this is usually the address shown above next to the target probe's
name.

Port Define the source and t arget port for the UDP packets. This port
will be used on both the source and target probe. Please use a
different port for each QoS sensor to make sure packets can be
assigned correctly. Enter an integer value between 1024 and
65536. Note: This port must be available on both the source and
target system.

Number of Packets Define how many packets are sent for each scanning interval. We
recommend using 1000. Please enter an integer value.

Size of Packets (Bytes) Define the size in bytes of the packets sent. We recommend using
172. Please enter an integer value.

Time between Packets Define the size in milliseconds that will be waited between two
(ms) packets. We recommend using 20. Please enter an integer value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

03.06.2014 827
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
76 QoS (Quality of Service) Round Trip Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

828 03.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
76 QoS (Quality of Service) Round Trip Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

03.06.2014 829
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
76 QoS (Quality of Service) Round Trip Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

830 03.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
76 QoS (Quality of Service) Round Trip Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.06.2014 831
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
77 RADIUS Sensor

6.8.77 RADIUS Sensor

The RADIUS sensor monitors a Remote Authentication Dial-In User Service (RADIUS) server.
The sensor tries to authenticate at the server and shows the response time. If authentication
fails, it will show an error.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

832 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
77 RADIUS Sensor

Radius specific

Timeout (sec) Enter a timeout in seconds for the request. If the reply takes longer
than this value, the request is aborted and an error message is
triggered.

User Define the user name used for authentication at the server. Please
enter a string.

Password Define the password used for authentication between the client
and the RADIUS server. Please enter a string. Note: The password
must not be longer than 6 characters.

Secret Define the shared secret used for authentication between the
authenticator (here the PRTG Probe) and the server. Please enter a
string.

Port Enter the port number used for connection to the server. Default
value is 1812. Please enter an integer value.

NAS IP Address Define a valid NAS IP address or leave the field empty.

NAS-Identifier Enter a NAS identifier. Please enter a string or leave the field empty.

Use Chap Add a check mark if you want to use the Challenge Handshake
Authentication Protocol.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

03.04.2014 833
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
77 RADIUS Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

834 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
77 RADIUS Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

03.04.2014 835
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
77 RADIUS Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

836 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
78 RDP (Remote Desktop) Sensor

6.8.78 RDP (Remote Desktop) Sensor

The RDP (Remote Desktop) Sensor monitors remote desktop services (RDP, Terminal Services
Client).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Specific

Timeout (sec) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Port Enter the number of the port the sensor will try to connect to.
Please enter an integer value. Default value is 3389. We recommend
using the default value.

27.11.2012 837
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
78 RDP (Remote Desktop) Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

838 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
78 RDP (Remote Desktop) Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

27.11.2012 839
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
78 RDP (Remote Desktop) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

840 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
78 RDP (Remote Desktop) Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 841
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
79 SCVMM Host Sensor

6.8.79 SCVM M Host Sensor

The SCVMM Host sensor monitors a host that is managed by a Microsoft System Center Virtual
Machine Manager (SCVMM). This can be, for example, a Hyper-V host, a VMware host, or a
XenServer host. It can show the CPU usage, free memory (in bytes and percentage), the overall
status, the communication status, the status of the cluster node, the status of the virtual
server, the computer status, and the VM count.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Requirement: Remote PowerShell 2.0

This sensor type uses PowerShell commands. In order to monitor devices with this sensor,
Remot e PowerShell 2.0 has to be enabled. For detailed information, please see More 847
section below. Note: PowerShell 1.0 is not supported.

Requirement: VMM PowerShell Plugin

This sensor type needs the VMM PowerShell Plugin to be installed on the target machine.
Under Windows 2008 and 2012 it is part of the VMM 2008 Administrator Console, or the VMM
2012 Management Console, respectively.

842 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
79 SCVMM Host Sensor

Note: To provide good performance, the System Center Virtual Manager (SCVMM) only reads
the performance data from time to time and caches them. Because of this, updates can take up
to several minutes. If your monitoring returns the same values again and again, please increase
the scanning interval.

Requirement for Windows Server 2012 Compatibility

In order to make this sensor type compatible for Windows Server 2012 systems, the following
requirements have to be met:

§ The SCVMM PowerShell module has to be in the directory C:\Program Files\Microsoft System
Center 2012\Virtual Machine Manager\bin\psModules\virtualmachinemanager
\virtualmachinemanager.
§ You have to set the execution policy in PowerShell to allow the execution of Import-Module
C:\Program Files\Microsoft System Center 2012\Virtual Machine Manager\bin\psModules
\virtualmachinemanager\virtualmachinemanager. Use the command Set -Execut ionPolicy . We
recommend the execution policy Remot eSigned; AllSigned and Unrest rict ed are also
possible.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor hosts, PRTG will create one sensor for each host. The settings you make in
this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Host Set t ings

Host Select the hosts you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head. Note: Please make
sure the name of your hosts do not contain unsupported
characters, especially avoid the hash ('#') sign. We recommend to
not rename hosts once you've set up monitoring. For detailed
information, please see More 602 section below.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

28.05.2014 843
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
79 SCVMM Host Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Host Set t ings

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

844 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
79 SCVMM Host Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 845
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
79 SCVMM Host Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

846 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
79 SCVMM Host Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Why don't my Hyper-V sensors work after changing names?
§ http://kb.paessler.com/en/topic/15533
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

28.05.2014 847
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
79 SCVMM Host Sensor

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

848 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
80 SCVMM Virtual Machine Sensor

6.8.80 SCVM M Virtual M achine Sensor

The SCVMM Virtual Machine sensor monitors a virtual machine (VM) that is managed by a
Microsoft System Center Virtual Machine Manager (SCVMM). This can be, for example, a Hyper-
V virtual machine, a VMware virtual machine, or a XenServer virtual machine. It can show the
CPU usage, the status of a VM, and disk read and write speed.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Requirement: Remote PowerShell 2.0

This sensor type uses PowerShell commands. In order to monitor devices with this sensor,
Remot e PowerShell 2.0 has to be enabled. For detailed information, please see More 854
section below. Note: PowerShell 1.0 is not supported.

Requirement: VMM PowerShell Plugin

This sensor type needs the VMM PowerShell Plugin to be installed on the target machine.
Under Windows 2008 and 2012 it is part of the VMM 2008 Administrator Console, or the VMM
2012 Management Console, respectively.

28.05.2014 849
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
80 SCVMM Virtual Machine Sensor

Note: To provide good performance, the System Center Virtual Manager (SCVMM) only reads
the performance data from time to time and caches them. Because of this, updates can take up
to several minutes. If your monitoring returns the same values again and again, please increase
the scanning interval.

Requirement for Windows Server 2012 Compatibility

In order to make this sensor type compatible for Windows Server 2012 systems, the following
requirements have to be met:

§ The SCVMM PowerShell module has to be in the directory C:\Program Files\Microsoft System
Center 2012\Virtual Machine Manager\bin\psModules\virtualmachinemanager
\virtualmachinemanager.
§ You have to set the execution policy in PowerShell to allow the execution of Import-Module
C:\Program Files\Microsoft System Center 2012\Virtual Machine Manager\bin\psModules
\virtualmachinemanager\virtualmachinemanager. Use the command Set -Execut ionPolicy . We
recommend the execution policy Remot eSigned; AllSigned and Unrest rict ed are also
possible.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor VMs, PRTG will create one sensor for each VM. The settings you make in
this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Virt ual Machine Set t ings

Virtual Machine Select the Virtual Machines (VMs) you want to add a sensor for. A
list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head. Note: Please make sure the name of your VMs do not
contain unsupported characters, especially avoid the hash ('#') sign.
We recommend to not rename VMs once you've set up monitoring.
For detailed information, please see More 602 section below.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

850 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
80 SCVMM Virtual Machine Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Virt ual Machine Set t ings

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

28.05.2014 851
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
80 SCVMM Virtual Machine Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

852 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
80 SCVMM Virtual Machine Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

28.05.2014 853
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
80 SCVMM Virtual Machine Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Why don't my Hyper-V sensors work after changing names?
§ http://kb.paessler.com/en/topic/15533
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

854 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
80 SCVMM Virtual Machine Sensor

Knowledge Base: My Powershell sensor returns an error message. What can I do?
§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 855
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

6.8.81 Sensor Factory Sensor

The Sensor Factory sensor is a powerful tool that allows you to create your own sensor with
channels based on data from other sensors. You can define one or more channels using
formulas that combine monitoring results from other sensors.

Samples for usage are:

§ Show single channels of one or more sensors in one graph.


§ Use the data from single channels of one or more sensors to calculate new values (for
example, you can subtract, multiply, and divide).
§ Create graphs with data from other sensor channels and add horizontal lines at specific
vertical positions.

Note: A sensor factory sensor does not show a "Downtime" channel. Downtime cannot be
calculated for this sensor type.

Note: The Sensor Factory sensor might not work with flow sensors 1966 . Sensor types using
active flow timeout, this is, NetFlow and jFlow sensors 291 , are not supported by the Sensor
Factory sensor.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

856 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

04.06.2014 857
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Sensor Fact ory Specific Set t ings

Channel Definition Enter a channel definition for the sensor. Using a specific syntax,
you can refer to data from channels of other sensors here. You can
also calculate values. Enter one channel definition for each new
channel you want to add to this sensor. Please see section Define
Sensor Channels 861 below.

Error Handling Define the sensor's behavior if one of the sensors defined above is
in an error status. In this case, you can set the sensor factory
sensor either to error or to warning status. Choose between:
· Fact ory sensor shows error st at us when one or more source
sensors are in error st at us: If at least one sensor used in a
channel definition is in a Down status, the factory sensor will
show a Down status as well until all referred sensors leave this
status. While the factory sensor is Down it will still show data of
all available sensor channels.
· Fact ory sensor shows warning st at us when one or more
source sensors are in error st at us: If at least one sensor used
in a channel definition is in a Down status, the factory sensor will
show a Warning status until all referred sensors leave the Down
status.
· Use cust om formula: Define the status of the factory sensor by
adding a status definition in the field below.

Status Definition This field is only visible if custom formula is enabled above. Define
when the sensor will switch to a Down status. You can use the
status() function in combination with Boolean operations. For
advanced users it is also possible to calculate a status value. Please
see section Define Sensor St at us 868 below.

If a Sensor Has No Choose how this Sensor Factory sensor will react in case a sensor
Data referred to in the channel definition does not provide any data (for
example, because it is paused or does not exist). Choose
between:
§ Do not calculat e fact ory channels t hat use t he sensor: For
channels that are defined using one or more sensor(s) that
deliver no data, no data will be shown. Additionally, the sensor
will show a Warning state.
§ Calculat e t he fact ory channels and use zero as source value:
If a sensor used in a channel definition does not deliver any data,
zero values will be filled in instead. The channel will be calculated
and shown using these values.

858 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

04.06.2014 859
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

860 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Define Sensor Channels

The channels of a Sensor Factory sensor are controlled by the Channel Definit ion text field.
Using a special syntax you can refer to other sensor channels, calculate values, and add
horizontal lines. You can define factory sensor channels using data from any other sensor's
channels on your PRTG core server.

04.06.2014 861
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Example

You see a definition of two factory sensor channels, both using the channel() function which
simply collects data from the channels of other sensors in your monitoring and displays
them:
#1:Local Probe Health
channel(1001,0)
#2:Local Traffic Out[kbit]
channel(1004,1)

The first channel of the factory sensor (#1) collects data from the Healt h channel (ID 0) of
the Core/Probe Healt h sensor (ID 1001) running on the Local Probe device. The second
channel (#2) collects data from the Traffic out channel (ID 1) of a traffic sensor (ID 1004)
measuring the system's local network card. Both channels will be shown together in the
factory sensor's data tables and graphs.

The basic syntax for a sensor factory channel definition looks like this:
#<id>:<name>[<unit>]
<formula>

For each channel one section is used. A section begins with the # sign. Function names in
formulas are not case sensitive.

The parameters are:

§ <id> is the ID of the factory sensor's channel and must be a unique number > 0.
§ <name> is the name of the factory sensor's channel (displayed in graphs and tables).
§ [<unit >] is an optional unit description for the factory sensor's channel (e.g. bytes). If it is
not provided a fitting unit string is selected automatically (recommended).
§ <formula> contains the formula to calculate the factory sensor's channel. For the formula,
you can use the following functions: channel() 863 , min() 864 , max() 864 , avg() 864 , or percent ()
865 .

Define Sensor Channels—Formula Calculations

Within a formula the following elements are allowed to perform calculations with the values
that are returned by one or more functions:

§ Basic operations: + (add), - (substract), * (multiply), / (divide)


Example: 3 + 5 * 2
§ Brackets: ( )
Example: 3 * (2 + 6)

862 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

§ Compare: = (equal), <> (not equal), > (greater), < (less), >= (greater or equal), <= (less or
equal)
If the compare is true the value is 10,000; if false the value is 0. For delta sensors the speed
is compared.

Example

You see a Sensor Factory channel definition with calculation.


#1:Traffic Total x Minus Traffic Out y
( channel(2001,-1) - channel(1004,1) ) * 2

This full channel definition will result in a factory sensor showing a calculation with values
from two channels (channel IDs -1 and 1) of two traffic sensors (sensor IDs 2001 and 1004).
The returned values will be subtracted and then multiplied by two.

Channels can be gauge values (e.g. Ping ms) or delta values (e.g. traffic kbit/s). Not all
combinations are allowed in a formula. Note: When performing percentage calculation, please
use the percent () Funct ion 865 to make sure you obtain the expected values!

There are calculations you cannot do:

· You cannot add/subtract a delta from a gauge channel (and vice versa).
· You cannot multiply two delta channels.
· You cannot compare a delta with a gauge channel.
· You cannot use a channel of (another) Sensor Factory sensor channel in the formula.

Define Sensor Channels—channel() Function

The channel() function allows to read the data from a channel of a different sensor. The syntax
is:
channel(<sensorId>,<channelId>)

The parameters are:

§ <sensorId> is the ID of the sensor. It is displayed on the sensor details page, in the
Overview tab behind the sensor name.
§ <channelId> is the ID of the sensor channel. It is displayed on the sensor details page, in
the Channels tab for each channel behind the channel name.

04.06.2014 863
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Example

channel(2001,2)

This function reads the data from channel ID 2 of the sensor with the ID 2001.

#1:Sample
channel(2001,2)

This full channel definition reads the data from channel ID 2 of the sensor with the ID 2001
and displays it in the first factory sensor channel (#1), without any additional calculations.

Define Sensor Channels—min() and max() Functions

The min() and max() functions return the minimum or maximum of the two values. The syntax
is:
min(<a>,<b>)
max(<a>,<b>)

Values for <a> and <b> are either numbers or channel() 863 functions.

Examples

min(10,5)

This function in the first line returns 5, as this is the smaller value out of 10 and 5.

min( channel(2001,1),channel(2002,1) )

This function returns the minimum of channel 1 of the sensor with ID 2001 and channel 1 of
the sensor with ID 2002.

Define Sensor Channels—avg() Function

The avg() function returns the average of the two values. This equals: (a+b) / 2. The syntax is:
avg(<a>,<b>)

Values for <a> and <b> are either numbers or channel() 863 functions.

864 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Examples

avg(20,10)

This function returns 15: (20+10) / 2 = 15.

avg( channel(2001,1),channel(2002,1) )

This function returns the average of channel 1 of the sensor with ID 2001 and channel 1 of
the sensor with ID 2002.

Define Sensor Channels—percent() Function

The percent () function calculates the percent value of two given values, for example, a channel
and a fixed value. The syntax is:
percent(<source>,<maximum>[,<unit>])

The parameters are:

§ <source> is the value the percent is calculated for. This is usually a channel() 863 function.
§ <maximum> is the limit value used for the percent calculation.
§ [<unit >] is an optional unit the maximum is provided in. You can use constants with this
function (see Const ant s 867 section below for a list). This can be used for gauge (e.g. Ping
sensors) or delta (e.g. traffic sensors). If no unit is provided 1 will be used. Note: As unit
string % will be added automatically.

PRTG will calculate: <source> / <maximum> * <unit> * 100

04.06.2014 865
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Examples

#1:Usage Traffic In
percent(channel(2001,0),100,kilobit)
#2:Usage Traffic Out
percent(channel(2001,1),100,kilobit)

This full channel definition will result in a factory sensor showing two channels of a traffic
sensor (sensor ID 2001): Traffic in (channel ID 0) and traffic out (channel ID 1). The values will
be displayed as % of maximum bandwidth (100 kilobit/second).

#1:Ping %
percent(channel(2002,0),200)

This full channel definition will result in a factory sensor showing the Ping Time channel
(channel ID 0) of a Ping sensor (sensor ID 2002). The values will be displayed as a percentage
of 200 ms.

Define Sensor Channels—Horizontal Lines

You can add lines to the graph using a formula without channel() function. Use a fixed value
instead. The syntax is:
#<id>:<name>[<unit>]
<value>

The parameters are:

§ <id> is the ID of the factory sensor's channel and must be a unique number > 1. Although a
horizontal line will not be shown as a channel, the ID has to be unique.
§ <name> is the name of the factory sensor's channel. When used here it will not be displayed
in graphs and tables, but can be used as a comment to describe the nature of the line.
§ [<unit >] is an optional unit description (e.g. kbit/s). If it is not provided the line is applied
automatically to the scale of the first factory sensor channel. If your factory sensor uses
different units you should provide a unit to make sure the line is added for the right scale.
Please enter the unit exactly as shown in your graphs' legend. If you enter a unit that does
not yet exist in your graph, a new scale will be added automatically.
§ <value> contains a number defining where the line will be shown in the graph.

866 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Examples

#5:Line at 100ms [ms]


100

This channel definition will result in graph showing a horizontal line at the value of 100 on
the ms scale.

#6:Line at 2 Mbit/s [kbit/s]


2000

This channel definition will result in graph showing a horizontal line at the value of 2000 on
the kbit /s scale.

#1:Ping Time
channel(2002,0)
#2:Line at 120ms [ms]
120

This full channel definition will result in a factory sensor showing the Ping Time channel
(channel ID 0) of a Ping sensor (sensor ID 2002). Additionally, the sensor's graphs will show a
horizontal line at 120 ms.

Define Sensor Channels—Constants

The following constants are defined and can be used in calculations:

§ one = 1
§ kilo = 1000
§ mega = 1000 * kilo
§ giga = 1000 * mega
§ t era = 1000 * giga
§ by t e = 1
§ kiloby t e = 1024
§ megaby t e = 1024 * kilobyte
§ gigaby t e = 1024 * megabyte
§ t eraby t e = 1024 * gigabyte
§ bit = 1/8
§ kilobit = kilo / 8

04.06.2014 867
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

§ megabit = mega / 8
§ gigabit = giga / 8
§ t erabit = tera / 8

Define Sensor Status—status() Function

The status of a Sensor Factory sensor can be controlled by the St at us Definit ion text field, if
the custom formula option is enabled in the Sensor Set t ings 856 . Using a special syntax you
can define when the factory sensor will change to a Down status. In all other cases the sensor
will be in an Up status. The syntax is:
status(sensorID) <boolean> status(sensorID)

The parameters are:

§ <sensorId> is the ID of the sensor you want to check the status of. The ID is displayed on
the sensor details page, in the Overview tab behind the sensor name.
§ <boolean> is one of the Boolean operators AND, OR, or NOT. If the resulting expression is
true, the factory sensor will change to a Down status.

868 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Examples

status(2031) AND status(2044)

This will change the factory sensor to a Down status if both sensors, with IDs 2031 and
2044, are Down. Otherwise the factory sensor will show an Up status.

status(2031) OR status(2044)

This will change the factory sensor to a Down status if at least one of the sensors with ID
2031 or ID 2044 is Down. Otherwise the factory sensor will show an Up status.

status(2031) AND NOT status(2044)

This will change the factory sensor to a Down status if the sensor with ID 2031 is Down, but
the sensor with ID 2044 is not in a Down status. Otherwise the factory sensor will show an
Up status.

§ Note: A status() function with NOT has to be connected with AND or OR if it is combined
with other status() functions:
status(sensorID) AND NOT status(sensorID)
status(sensorID) OR NOT status(sensorID)

( status(2031) AND status(2044) ) OR status(2051)

This will change the factory sensor to a Down status if both the sensor with ID 2031 and the
sensor with ID 2044 is Down, or if the sensor with ID 2051 is Down. Otherwise the factory
sensor will show an Up status.

Additionally, the following elements are allowed to perform calculations and comparisons with
the values that are returned by the status functions:

§ Basic operations: + (add), - (substract), * (multiply), / (divide)


Example: 3 + 5 * 2
§ Brackets: ( )
Example: 3 * (2 + 6)
§ Compare: = (equal), <> (not equal), > (greater), < (less), >= (greater or equal), <= (less or
equal)
If the compare is true the value is 10,000; if false the value is 0. For delta sensors the speed
is compared.

Internally, the status() function returns the downtime channel of the sensor in hundreds of
percent (10,000 = 100%).

§ true corresponds to a value of 10,000 which is a Down status.


§ false corresponds to a value of 0 which is an Up status.

04.06.2014 869
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
81 Sensor Factory Sensor

Understanding this, more complex formulas are possible.

Example

( status(1031) + status(1032) + status(1033) + status(1034) ) >= 20000

This will change the factory sensor to a Down status if at least any two of the sensors with
IDs 1031, 1032, 1033, or 1034 are Down. Otherwise the factory sensor will show an Up
status.

Note: The status() function may also be used in channel definitions 861 . Using this functionality,
it is for example possible to display the numeric status value of sensors in a factory sensor
channel.

Using Factory Sensors in a Cluster Setup

If you're running PRTG in Clustering 81 mode, please note these additional facts:

§ If you add a Sensor Factory sensor underneath the Clust er Probe, and in the Sensor Factory
formula, you refer to a channel of a sensor running on the Clust er Probe as well, the Sensor
Factory sensor will show the data of all cluster nodes for this sensor channel.

§ If you add a Sensor Factory sensor underneath the Local Probe, and in the Sensor Factory
formula, you refer to a channel of a sensor running on the Clust er Probe, the Sensor
Factory sensor will only show data of the primary master node for this sensor channel.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

870 04.06.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

6.8.82 sFlow Sensor

The sFlow sensor receives traffic data from a sFlow V5 compatible device and shows the traffic
by type. Only header traffic will be analyzed. Please make sure the device matches the sFlow
version V5! There are several filter options available to divide traffic into different channels.

Note: In order for the sensor to work, sFlow V5 export must be enabled on the device. The
device must send the flow data stream to the IP address of the PRTG probe system on which
the sensor is set up (either a local or remote probe).

The sensor accepts RAW data only. The stream must be sent via IPv4. This sensor type cannot
be used in cluster mode. You can set it up on a local probe or remote probe only, not on a
cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Limitations of This Sensor Type


There are some limitations that you want to consider before using this sensor type:
§ Only sFlow version 5 datagrams are supported
§ Only IPv4 flows are supported
§ Only the "raw packet header" format is supported
§ Only the "Flow sample" format is supported. "Extended flow" and "Counter" formats cannot be
processed
§ PRTG processes only samples where the source ID matches the ifIndex of the input interface
(avoiding double counted traffic) and ascending sequence numbers. Due to internal
limitations, only interface numbers up to 65535 are supported.
§ Sample packets have to be of ethernet type "IP" (with optional VLAN tag)
§ Sampled packets of type TCP and UDP are supported

We recommend using sFlow tester for debugging (see More section below).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

28.05.2014 871
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

sFlow Specific Set t ings

Receive sFlow Packets Enter the UDP port number on which the flow packets are received.
on UDP Port It must match the one you have configured in the sFlow export
options of your hardware router device. Default value is 6343.
Please enter an integer value. Note: When configuring export,
please make sure you select the appropriate sFlow version 5.

Sender IP Enter the IP address of the sending device you want to receive the
sFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive sFlow Packets Select the IP address(es) on which PRTG listens to sFlow packets.
on IP The list of IP addresses shown here is specific to your setup. To
select an IP address, add a check mark in front of the respective
line. The IP address selected here must match the one configured
in the sFlow export options of your hardware router device. Note:
When configuring export, please make sure you select the
appropriate sFlow version 5.

Channel Configurat ion

Channel Selection Define the categories the traffic will be accounted to. There are
different groups of traffic available. Choose between:
§ Web: Internet web traffic.

872 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

Channel Configurat ion

§ File Transfer: Traffic caused by FTP.


§ Mail: Internet mail traffic.
§ Chat : Traffic caused by chat and instant messaging.
§ Remot e Cont rol: Traffic caused by remote control applications,
such as RDP, SSH, Telnet, VNC.
§ Infrast ruct ure: Traffic caused by network services, such as
DHCP, DNS, Ident, ICMP, SNMP.
§ Net BIOS: Traffic caused by NetBIOS communication.
§ Ot her Prot ocols: Traffic caused by various other protocols via
UDP and TCP.
For each traffic group, you can select how many channels will be
used for each group, i.e. how detailed traffic will be divided. For
each group, choose between:
§ No: Do not account traffic of this group in an own channel. All
traffic of this group will be accounted to the default channel
named Ot her.
§ Yes: Count all traffic of this group and summarize it into one
channel.
§ Det ail: Count all traffic of this group and further divide it into
different channels. The traffic will appear in several channels as
shown in the Cont ent column. Note: Extensive use of this
option can cause load problems on your probe system. We
recommend setting specific, well-chosen filters for the data you
really want to analyze.
Note: You can change the default configuration for groups and
channels. For details, please see section More.

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

28.05.2014 873
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

874 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

28.05.2014 875
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

876 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

28.05.2014 877
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
82 sFlow Sensor

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

More

Paessler Website: Paessler sFlow Tester


§ http://www.paessler.com/tools/sflowtester

Knowledge Base: How can I change the default groups and channels for xFlow and Packet
Sniffer sensors?
§ http://kb.paessler.com/en/topic/60203

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

Related Topics
§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

878 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

6.8.83 sFlow (Custom) Sensor

The sFlow (Custom) sensor receives traffic data from a sFlow V5 compatible device and shows
the traffic by type. Please make sure the device matches the sFlow version V5! There are
several filter options available to divide traffic into different channels.

Note: In order for the sensor to work, sFlow V5 export must be enabled on the device. The
device must send the flow data stream to the IP address of the PRTG probe system on which
the sensor is set up (either a local or remote probe). The sensor accepts RAW data. This
sensor type cannot be used in cluster mode. You can set it up on a local probe or remote
probe only, not on a cluster probe.

For a general introduction to the technology behind flow monitoring, please see Monit oring
Bandwidt h via Flows 1966 section.

Limitations of This Sensor Type


There are some limitations that you want to consider before using this sensor type:
§ Only sFlow version 5 datagrams are supported
§ Only IPv4 flows are supported
§ Only the "raw packet header" format is supported
§ Only the "Flow sample" format is supported. "Extended flow" and "Counter" formats cannot be
processed
§ PRTG processes only samples where the source ID matches the ifIndex of the input interface
(avoiding double counted traffic) and ascending sequence numbers. Due to internal
limitations, only interface numbers up to 65535 are supported.
§ Sample packets have to be of ethernet type "IP" (with optional VLAN tag)
§ Sampled packets of type TCP and UDP are supported

We recommend using sFlow tester for debugging (see More section below).

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

24.10.2013 879
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

sFlow Specific Set t ings

Receive sFlow Packets Enter the UDP port number on which the flow packets are received.
on UDP Port It must match the one you have configured in the sFlow export
options of your hardware router device. Default value is 6343.
Please enter an integer value. Note: When configuring export,
please make sure you select the appropriate sFlow version 5.

Sender IP Enter the IP address of the sending device you want to receive the
sFlow from. Enter an IP address to receive data from a specific
device only, or leave the field empty to receive data from any
device on the specified port.

Receive sFlow Packets Select the IP address(es) on which PRTG listens to sFlow packets.
on IP The list of IP addresses shown here is specific to your setup. To
select an IP address, add a check mark in front of the respective
line. The IP address selected here must match the one configured
in the sFlow export options of your hardware router device. Note:
When configuring export, please make sure you select the
appropriate sFlow version 5.

880 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

Channel Definition Please enter a channel definition to divide the traffic into different
channels. Write each definition in one line. For detailed information,
please see Channel Defint ions for xFlow and Packet Sniffer
Sensors 2036 section. All traffic for which no channel is defined will
be accounted to the default channel named Ot her. Note: Extensive
use of many filters can cause load problems on your probe system.
We recommend defining specific, well-chosen filters for the data
you really want to analyse.

Filt ering

Include Filter Define if you want to filter any traffic. If you leave this field empty,
all traffic will be included. To include specific traffic only, define
filters using a special syntax. For detailed information, please see
Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032
section.

Exclude Filter First, the filters defined in the Include Filt er field are considered.
From this subset, you can explicitly exclude traffic, using the same
syntax. For detailed information, please see Filt er Rules for xFlow,
IPFIX , and Packet Sniffer Sensors 2032 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

24.10.2013 881
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

Primary Toplist

Primary Toplist Define which will be your primary toplist. It will be shown in maps
when adding a toplist object. Choose from:
§ Top Talkers
§ Top Connect ions
§ Top Prot ocols
§ [Any custom toplists you have added]

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:

882 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

§ Not set (monit or cont inuously ): No maintenance window will


be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

24.10.2013 883
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

884 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Toplists

For all flow and packet sniffer sensors there are Toplist s available on the Overview tab of a
sensor's detail page. Using toplists, you can review traffic data of small time periods in great
detail. For more information, please see Toplist s 1728 section.

More
Paessler Website: Paessler sFlow Tester
§ http://www.paessler.com/tools/sflowtester

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

24.10.2013 885
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
83 sFlow (Custom) Sensor

Related Topics

§ Filt er Rules for xFlow, IPFIX , and Packet Sniffer Sensors 2032

§ Channel Defint ions for xFlow, IPFIX , and Packet Sniffer Sensors 2036

886 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
84 SFTP Secure File Transfer Protocol Sensor

6.8.84 SFTP Secure File Transfer Protocol Sensor

The sFTP Secure File Transfer Protocol sensor monitors FTP servers of a Linux/Unix system
using SSH File Transfer Protocol (FTP over SSH). It tries to connect to a server and shows the
response time.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

24.10.2013 887
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
84 SFTP Secure File Transfer Protocol Sensor

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result data received by the
sensor. Choose between:
· Discard result : Do not store the result data.
· Writ e result t o disk (Filename: "Result of Sensor [ID].t xt ):
Store the last result received from the query to the "Logs
(Sensors)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

888 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
84 SFTP Secure File Transfer Protocol Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

24.10.2013 889
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
84 SFTP Secure File Transfer Protocol Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

890 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
84 SFTP Secure File Transfer Protocol Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

24.10.2013 891
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
84 SFTP Secure File Transfer Protocol Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

892 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
85 Share Disk Free Sensor

6.8.85 Share Disk Free Sensor

The Share Disk Free sensor monitors free disk space of a share (Windows/Samba) using Server
Message Block (SMB). It shows the free space in percent and total.

Note: This sensor only works if no quotas are enabled on the target share. If there are quotas
enabled for the user account this sensor uses to connect to the share, the absolute value will
be okay, but the percentage variable will show wrong values.

Requirement: Server Service

In order to monitor shares on Windows machines, please make sure the LanmanServer "Server"
Windows service is running on the target computer.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

28.05.2014 893
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
85 Share Disk Free Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Share Configurat ion

Share Enter the name of the share this sensor will monitor. Only a share
name is allowed here (for example, enter C$). Please do not enter a
complete UNC name here. The server name (\\server\) is taken
from the parent device of this sensor. Note: In order to provide any
shares under Windows, the LanmanServer "Server" Windows service
must be running on the target computer.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

894 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
85 Share Disk Free Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

28.05.2014 895
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
85 Share Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

896 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
85 Share Disk Free Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: What can I do if PRTG doesn't succeed with monitoring a share? PE029 PE032
§ http://kb.paessler.com/en/topic/513

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

28.05.2014 897
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
85 Share Disk Free Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

898 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
86 SIP Options Ping Sensor

6.8.86 SIP Options Ping Sensor

The SIP Options Ping sensor monitors the connectivity for a Session Initiation Protocol (SIP)
server using SIP options "Ping". It can be used to monitor voice-over-IP (VoIP) services. The
sensor sends "auth" and "options" requests to the SIP server and shows the response time. It
can alert in case of an error.

Note: A SIP server might return a 480 Service temporarily unavailable error until at least one
reachable SIP client is connected to the server.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

07.02.2013 899
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
86 SIP Options Ping Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SIP Specific

Port Define the UDP port this sensor will connect to. Please enter an
integer value.

Username Enter the username of the SIP account this sensor will log into after
a connection to the SIP server has been established. Please enter a
string.

Password Enter the password of the SIP account this sensor will log into after
a connection to the SIP server has been established. Please enter a
string.

Timeout (Seconds) Enter the timeout for the connection to the SIP server. Please enter
an integer value.

Retry Count In case the connection to the SIP server fails, the sensor can re-try
to connect. Enter the maximum number of retries. After reaching
the maximum count the sensor will show a red Down status.
Please enter an integer value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

900 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
86 SIP Options Ping Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

07.02.2013 901
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
86 SIP Options Ping Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

902 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
86 SIP Options Ping Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

07.02.2013 903
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
86 SIP Options Ping Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

904 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
87 SMTP Sensor

6.8.87 SM TP Sensor

The SMTP sensor monitors a mail server using Simple Mail Transfer Protocol (SMTP) and shows
the server's response time. It can optionally send a test email with every check.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SMTP specific

Timeout (sec) Enter a timeout in seconds for the SMTP connect. If the reply takes
longer than this value the request is aborted and an error message
is triggered.

14.01.2014 905
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
87 SMTP Sensor

SMTP specific

Port Enter the number of the port that will be used to send an email via
SMTP. For non-secure connections usually port 25 is used; usually
port 465 or 587 for SSL connections. The actual setting depends
on the server you are connecting to. Please enter an integer value.
We recommend using the default value. If you do not get a
connection, please try another port number.

TLS (Transport-Level Select if the SMTP connection will be secured via SSL. Choose
Security) between:
· Don't use: Do not use encryption for the SMTP connection.
· Use: Connect to the SMTP server using the SSL method selected
below.

SSL-Method This field is only visible if security is enabled above. Select the SSL
method that will be used when connecting to the server. We
recommend using the default value. Only if you experience
connection problems, try another setting. Choose between:
§ SSL V2
§ SSL V2 or V3
§ SSL V3
§ TLS V1

Aut hent icat ion

Type Select whether to use an authentication method for the SMTP


connection. Choose between:

· None: Do not use any authentication method.


· Username/Password: Authenticate at the SMTP server via
username and password.

Username This field is only visible if SMTP authentication is enabled above.


Enter a username for SMTP authentication. Please enter a string.

Password This field is only visible if SMTP authentication is enabled above.


Enter a password for SMTP authentication. Please enter a string.

906 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
87 SMTP Sensor

Monit oring

Send Mail Define if an email will be sent when connecting to the SMTP server.
Choose between:
· None: Do not send an email, just connect to the SMTP server.
· Send Mail: Send an email through the SMTP server. If there is an
error when sending mail, an error message will be triggered and
the sensor will change to a Down status.

Helo Ident Enter a server name for the helo part of the mail protocol. For
some mail servers the helo ident must be the valid principal host
domain name for the client host.

From Specify which address the sent emails will contain in the from field.
Please enter a valid email address.

To Specify to which address the emails will be sent to. Please enter a
valid email address.

Topic Specify which subject will be used in the sent emails. Please enter a
string or leave the field empty.

Content Specify which body will be used in the sent emails. Please enter a
string or leave the field empty.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

14.01.2014 907
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
87 SMTP Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

908 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
87 SMTP Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 909
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
87 SMTP Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

910 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

6.8.88 SM TP&IM AP Round Trip Sensor

The SMTP&IMAP Round Trip sensor monitors the time it takes for an email to reach an Internet
Message Access Protocol (IMAP) mailbox after being sent using Simple Mail Transfer Protocol
(SMTP). It sends an email to the parent device via SMTP and then scans a dedicated IMAP
mailbox until this email comes in. The sensor shows the response time of SMTP and IMAP
server, and the sum of both.

The SMTP&IMAP Round Trip sensor will delete these emails automatically from the mailbox as
soon as PRTG retrieves them. Emails will only remain in the mailbox particularly if a timeout or a
restart of the PRTG server occurred during sensor run-time.

Note: Please use dedicated email accounts with this sensor type. If you use more sensors of
this type, please make sure that each sensor uses its own email accounts.

For a general introduction to the technology behind round trip monitoring, please see
Monit oring Email Round Trip 1975 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

We recommend adding this sensor on an SMTP server device only, because this sensor type's
settings are optimized for this scenario.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

14.01.2014 911
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Email Set t ings

From Specify which address the sent emails will contain in the from field.
Please enter a valid email address.

To Specify to which address the emails will be sent to. Please enter a
valid email address.

Helo Ident Enter a server name for the helo part of the mail protocol. For
some mail servers the helo ident must be the valid principal host
domain name for the client host.

912 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

St ep 1: Send Email t o Parent Device Using SMTP

In this step, you configure how emails will be sent. As SMTP server, the sensor uses the IP-
Address/DNS Name property's value of the device it is added on.

Port Enter the number of the port that will be used to send an email via
SMTP. Please enter an integer value. For non-secure connections
usually port 25 is used; usually port 465 or 587 for SSL
connections. The actual setting depends on the server you are
connecting to. Please enter an integer value. We recommend using
the default value. If you do not get a connection, please try
another port number.

Timeout for SMTP Enter a timeout in seconds for the SMTP connect. If the reply takes
Connection (Sec.) longer than this value the request is aborted and an error message
is triggered.

TLS (Transport-Level Select if the SMTP connection will be secured via SSL. Choose
Security) between:
· Don't use: Do not use encryption for the SMTP connection.
· Use: Connect to the SMTP server using the SSL method selected
below.

SSL-Method This field is only visible if security is enabled above. Select the SSL
method that will be used when connecting to the server. We
recommend using the default value. Only if you experience
connection problems, try another setting. Choose between:
§ SSL V2
§ SSL V2 or V3
§ SSL V3
§ TLS V1

SMTP Authentication Define if you want to use an authentication for the SMTP
Type connection. Choose between:
· None: Do not use any authentication method.
· Username/Password: Authenticate at the SMTP server via
username and password.

Username This field is only visible if SMTP authentication is enabled above.


Enter a username for SMTP authentication. Please enter a string.

Password This field is only visible if SMTP authentication is enabled above.


Enter a password for SMTP authentication. Please enter a string.

Additional Text for The subject part of the round trip email is created automatically by
Email Subject PRTG. It consists of the string "PRTG Roundtrip Mail:" followed by a
unique GUID to correctly identify the email in the IMAP mailbox (e.g.
14.01.2014 PRTG Roundtrip Mail: {5E858D9C-AC70-466A-9B2A- 913
55630165D276}). Use this field to place your custom text before
the automatically created text.
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

St ep 2: Check an IMAP Mailbox Unt il Email Arrives

In this step, you configure how the sent emails will be received.

IP-Address/DNS Name Specify the IMAP server. Enter a valid IP address or DNS name.

Mailbox Specify the IMAP Mailbox (resp. "IMAP folder") you want to check.
Please enter the IMAP mailbox/folder name.

Port Specify the port that will be used for the IMAP connection. For non-
secure connections usually port 143 is used; usually port 993 for
SSL connections. The actual setting depends on the server you are
connecting to. Please enter an integer value. We recommend using
the default value. If you do not get a connection, please try
another port number.

TLS (Transport-Level Select if the IMAP connection will be secured via SSL. Choose
Security) between:
· Don't use: Do not use encryption for the SMTP connection.
· Use: Connect to the SMTP server using the SSL method selected
below.

SSL-Method This field is only visible when TLS is enabled above. Select the SSL
method that will be used when connecting to the IMAP server. We
recommend using the default value. If you experience connection
problems, try another setting.

Connection Interval Enter the number of seconds the sensor will wait between two
(Sec.) connections to the IMAP server. PRTG will repeatedly check the
mailbox in this interval until the email arrives. Please enter an
integer value.

Maximum Trip Time Enter the number of seconds an email may take to arrive in the
(Sec.) IMAP mailbox. PRTG will repeatedly check the mailbox in the interval
specified above until the email arrives. If it does not arrive within
the maximum trip time, an error message will be triggered for the
sensor. Please enter an integer value.

IMAP Authentication Select the kind of authentication for the IMAP connection. Choose
Type between:
· Username and Password (simple)
· Simple Aut hent icat ion and Securit y Lay er (SASL)

Username Enter a username for IMAP authentication. Please enter a string.

Password Enter a username for IMAP authentication. Please enter a string.

914 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

14.01.2014 915
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

916 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

14.01.2014 917
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
88 SMTP&IMAP Round Trip Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

918 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

6.8.89 SM TP&POP3 Round Trip Sensor

The SMTP&POP3 Round Trip sensor monitors the time it takes for an email to reach an Post
Office Protocol version 3 (POP3) mailbox after being sent using Simple Mail Transfer Protocol
(SMTP). It sends an email to the parent device via SMTP and then scans a dedicated POP3
mailbox until the email comes in. The sensor shows the response time of SMTP and POP3
server, and the sum of both.

The SMTP&POP3 Round Trip sensor will delete these emails automatically from the mailbox as
soon as PRTG retrieves them. Emails will only remain in the mailbox particularly if a timeout or a
restart of the PRTG server occurred during sensor run-time.

Note: Please use dedicated email accounts with this sensor type. If you use more sensors of
this type, please make sure that each sensor uses its own email accounts.

For a general introduction to the technology behind round trip monitoring, please see
Monit oring Email Round Trip 1975 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

We recommend adding this sensor on an SMTP server device only, as the sensor's settings are
optimized for this scenario.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

14.01.2014 919
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Email Set t ings

From Specify which address the sent emails will contain in the from field.
Please enter a valid email address.

To Specify to which address the emails will be sent to. Please enter a
valid email address.

Helo Ident Enter a server name for the helo part of the mail protocol. For
some mail servers the helo ident must be the valid principal host
domain name for the client host.

920 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

St ep 1: Send Email t o t he Parent Device Using SMTP

In this step, you configure how emails will be sent. As SMTP server, the sensor uses the IP-
Address/DNS Name property's value of the device it is added on.

Port Enter the number of the port that will be used to send an email via
SMTP. Please enter an integer value. For non-secure connections
usually port 25 is used; usually port 465 or 587 for SSL
connections. The actual setting depends on the server you are
connecting to. Please enter an integer value. We recommend using
the default value. If you do not get a connection, please try
another port number.

Timeout for SMTP Enter a timeout in seconds for the SMTP connect. If the reply takes
Connection (Sec.) longer than this value the request is aborted and an error message
is triggered.

TLS (Transport-Level Select if the SMTP connection will be secured via SSL. Choose
Security) between:
· Don't use: Do not use encryption for the SMTP connection.
· Use: Connect to the SMTP server using the SSL method selected
below.

SSL-Method This field is only visible if security is enabled above. Select the SSL
method that will be used when connecting to the server. We
recommend using the default value. Only if you experience
connection problems, try another setting. Choose between:
§ SSL V2
§ SSL V2 or V3
§ SSL V3
§ TLS V1

SMTP Authentication Define if you want to use an authentication for the SMTP
Type connection. Choose between:
· None: Do not use any authentication method.
· Username/Password: Authenticate at the SMTP server via
username and password.

14.01.2014 921
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

Username This field is only visible if SMTP authentication is enabled above.


Enter a username for SMTP authentication. Please enter a string.

Password This field is only visible if SMTP authentication is enabled above.


Enter a password for SMTP authentication. Please enter a string.

Additional Text for The subject part of the round trip email is created automatically by
Email Subject PRTG. It consists of the string "PRTG Roundtrip Mail:" followed by a
unique GUID to correctly identify the email in the POP3 mailbox
(e.g. PRTG Roundtrip Mail: {5E858D9C-AC70-466A-9B2A-
55630165D276}). Use this field to place your custom text before
the automatically created text.

922 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

St ep 2: Check a POP3 Mailbox Unt il Email Arrives

In this step, you configure how the sent emails will be received.

IP-Address/DNS Name Specify the POP3 server. Enter a valid IP address or DNS name.

Port Specify the port that will be used for the POP3 connection. For
non-secure connections usually port 110 is used; usually port 995
for SSL connections. The actual setting depends on the server you
are connecting to. Please enter an integer value. We recommend
using the default value. If you do not get a connection, please try
another port number.

TLS (Transport-Level Select if the POP3 connection will be secured via SSL. Choose
Security) between:
· Don't use: Do not use encryption for the SMTP connection.
· Use: Connect to the SMTP server using the SSL method selected
below.

SSL-Method This field is only visible when TLS is enabled above. Select the SSL
method that will be used when connecting to the IMAP server. We
recommend using the default value. If you experience connection
problems, try another setting.

Connection Interval Enter the number of seconds the sensor will wait between two
(Sec.) connections to the IMAP server. PRTG will repeatedly check the
mailbox in this interval until the email arrives. Please enter an
integer value.

Maximum Trip Time Enter the number of seconds an email may take to arrive in the
(Sec.) IMAP mailbox. PRTG will repeatedly check the mailbox in the interval
specified above until the email arrives. If it does not arrive within
the maximum trip time, an error message will be triggered for the
sensor. Please enter an integer value.

POP3 Authentication Select the kind of authentication for the POP3 connection. Choose
Type between:
· Wit hout Login: Monitor the connection to the POP3 server only.
· Username and Password: Log into the POP3 server with user
name and password (simple login, non-secure).
· 128-bit MD5 hash value (APOP): Send the password in an
encrypted form using APOP. This option must be supported by
the POP3 server you're connecting to.

Username This field is only visible if an option with login is selected above.
Enter a username for POP3 authentication. Please enter a string.

Password This field is only visible if an option with login is selected above.
Enter a username for POP3 authentication. Please enter a string.
14.01.2014 923
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

924 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 925
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
89 SMTP&POP3 Round Trip Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

926 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
90 SNMP APC Hardware Sensor

6.8.90 SNM P APC Hardware Sensor

The SNMP APC Hardware sensor monitors performance counters on an APC UPS device using
Simple Network Management Protocol (SNMP). It can show actual voltage of a battery, its
capacity and temperature, and its remaining runtime, the input and output frequency, input and
output voltage, and output load. For additional counters, please see section More 932 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For devices with multiple performance counters multiple sensors are created at once in the
Add Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

APC UPS Specific

Library OIDs Select the performance counters you want to add a sensor for. A
list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

28.05.2014 927
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
90 SNMP APC Hardware Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

APC UPS Specific

Selected Interface Shows the name of the interface (performance counter) monitored
by this sensor. Once a sensor is created this value cannot be
changed. It is shown for reference purposes only. If you need to
change this, please add the sensor anew.

Unit String Define the unit of the numerical data that will be received at the
given OID. Please enter a string.

Multiplication If you want to multiply the received data with a certain value, enter
the quotient here. Please enter an integer or float value.

Division If you want to divide the received data by a certain value, enter the
divisor here. Please enter an integer or float value.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

928 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
90 SNMP APC Hardware Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 929
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
90 SNMP APC Hardware Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

930 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
90 SNMP APC Hardware Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 931
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
90 SNMP APC Hardware Sensor

More

Knowledge Base: How can I monitor additional counters with the SNMP APC Hardware sensor?
§ http://kb.paessler.com/en/topic/60367

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

932 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
91 SNMP Cisco ADSL Sensor

6.8.91 SNM P Cisco ADSL Sensor

The SNMP Cisco ADSL sensor monitors Asymmetric Digital Subscriber Line (ADSL) statistics of a
Cisco router using Simple Network Management Protocol (SNMP). It shows the speed of
downlink and uplink, remote and local attenuation, remote and local SNR (signal-to-noise ratio),
and remote and local power output.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For devices with multiple performance counters, multiple sensors are created at once in the
Add Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Cisco ADSL Set t ings

Line Index Select the performance counters you want to add a sensor for. A
list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

14.01.2014 933
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
91 SNMP Cisco ADSL Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

934 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
91 SNMP Cisco ADSL Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

14.01.2014 935
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
91 SNMP Cisco ADSL Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

936 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
91 SNMP Cisco ADSL Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 937
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
92 SNMP Cisco ASA VPN Connections Sensor

6.8.92 SNM P Cisco ASA VPN Connections Sensor

The SNMP Cisco ASA VPN Connections sensor monitors the Virtual Private Network (VPN)
connections on a Cisco Adaptive Security Appliance using Simple Network Management
Protocol (SNMP). It shows the active sessions of the connection types email, IPsec, L2L, LB,
SVC, WebVPN, as well as the total number of sessions, active users, and groups with active
users.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

938 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
92 SNMP Cisco ASA VPN Connections Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

14.01.2014 939
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
92 SNMP Cisco ASA VPN Connections Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

940 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
92 SNMP Cisco ASA VPN Connections Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

14.01.2014 941
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
92 SNMP Cisco ASA VPN Connections Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

942 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
93 SNMP Cisco ASA VPN Traffic Sensor

6.8.93 SNM P Cisco ASA VPN Traffic Sensor

The SNMP Cisco ASA VPN Traffic sensor monitors the traffic of an Internet Protocol Security
(IPsec) Virtual Private Network (VPN) connection on a Cisco Adaptive Security Appliance using
Simple Network Management Protocol (SNMP). It shows incoming and outgoing traffic, as well
as total traffic.

This sensor type is indented to monitor permanent connections. It will show an error if a
connection is interrupted. It can monitor IPsec connections only!

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one connections, multiple sensors are created at once in the Add
Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

ASA VPN Specific

Connections Select the IPsec VPN connections you want to add a sensor for.
You see a list of all active IPsec VPN connections available on the
target ASA, listed with remote IP, user name, and the kind of
connection. Select the desired items by adding check marks in
front of the respective lines. One sensor will be created for each
selection. You can also select and deselect all items by using the
check box in the table head. Note: This sensor type can only
monitor VPN connections based on IPsec. This means, for example,
that connections using "Cisco AnyConnect" will not be listed here.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

12.05.2014 943
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
93 SNMP Cisco ASA VPN Traffic Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

ASA VPN Specific

Remote IP The IP address of the connection this sensor monitors. Once a


sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew. Note: This sensor type can only monitor VPN
connections based on IPsec.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

944 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
93 SNMP Cisco ASA VPN Traffic Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

12.05.2014 945
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
93 SNMP Cisco ASA VPN Traffic Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

946 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
93 SNMP Cisco ASA VPN Traffic Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 947
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
94 SNMP Cisco ASA VPN Users Sensor

6.8.94 SNM P Cisco ASA VPN Users Sensor

The SNMP Cisco ASA VPN Users sensor monitors account connections to a Virtual Private
Network (VPN) on a Cisco Adaptive Security Appliance via Simple Network Management
Protocol (SNMP). It can show the number of currently connected accounts and if a user
account is currently offline or online.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

948 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
94 SNMP Cisco ASA VPN Users Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

14.01.2014 949
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
94 SNMP Cisco ASA VPN Users Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

950 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
94 SNMP Cisco ASA VPN Users Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

14.01.2014 951
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
94 SNMP Cisco ASA VPN Users Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

952 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
95 SNMP Cisco CBQoS Sensor

6.8.95 SNM P Cisco CBQoS Sensor

The SNMP Cisco CBQoS sensor monitors network parameters using Cisco's Class Based Quality
of Service (CBQoS) via Simple Network Management Protocol (SNMP). It supports the classes
Class Map, Match Statement, and Queueing. The sensor shows current and maximum queue
depth, pre policy packets, pre and post policy size, drop packets and size, drop packets
without buffer, as well as fragment packets and size, depending on the particular class type.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

For a general introduction to the technology behind Quality of Service monitoring, please see
Monit oring Qualit y of Service 1971 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor quality-of-service via compatible devices, PRTG will create one sensor for
each CBQoS entry you choose. The settings you make in this dialog are valid for all of the
sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Class Based QoS Specific

CBQoS Entries Select the measurements you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

03.04.2014 953
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
95 SNMP Cisco CBQoS Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Class Based QoS Specific

Interface Shows further information about the parameter this sensor is


monitoring. Once a sensor is created this value cannot be changed.
It is shown for reference purposes only. If you need to change this,
Description
please add the sensor anew.

Bitmask

ObjectID

ConfigID

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

954 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
95 SNMP Cisco CBQoS Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

03.04.2014 955
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
95 SNMP Cisco CBQoS Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

956 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
95 SNMP Cisco CBQoS Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.04.2014 957
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
96 SNMP Cisco System Health Sensor

6.8.96 SNM P Cisco Sy stem Health Sensor

The SNMP Cisco System Health sensor monitors the system health of a Cisco device via Simple
Network Management Protocol (SNMP). It can show the percentage CPU load, available memory
in absolute and percentage values, the status of power supplies, temperatures (in Celsius), the
current temperature states, and many more, depending on the available components of your
device.

This sensor type has predefined limits for several metrics. These limits can be changed
individually in the channel settings. For detailed information about channel limits please refer to
the section Sensor Channels Set t ings 1709 .

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the system health of a Cisco device, PRTG will create one sensor for each
measurement you choose. The settings you make in this dialog are valid for all of the sensors
that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Cisco Sy st em Healt h Specific

Measurement Select the measurements you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

958 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
96 SNMP Cisco System Health Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Cisco Sy st em Healt h Specific

Measurement Shows the ID of the measurement that this sensor is monitoring.


Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

19.07.2013 959
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
96 SNMP Cisco System Health Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

960 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
96 SNMP Cisco System Health Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

19.07.2013 961
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
96 SNMP Cisco System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

962 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
96 SNMP Cisco System Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

19.07.2013 963
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
97 SNMP Cisco UCS Chassis Sensor

6.8.97 SNM P Cisco UCS Chassis Sensor

The SNMP Cisco UCS Chassis sensor monitors the health status of the chassis of a Cisco
Unified Computing and Server (UCS) device via Simple Network Management Protocol (SNMP). It
can show the states of configuration, license, oper, the operability, power status, thermal
status, as well as the serial electronic erasable programmable read-only memory (SEEPROM)
status. The creation of these channels depends on the available measurement components on
the UCS chassis.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the health status of a Cisco UCS chassis, PRTG will create one sensor for
each chassis you choose. The settings you make in this dialog are valid for all of the sensors
that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Chassis Select the chassis you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

964 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
97 SNMP Cisco UCS Chassis Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Chassis Shows the chassis monitored by this sensor. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

14.01.2014 965
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
97 SNMP Cisco UCS Chassis Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

966 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
97 SNMP Cisco UCS Chassis Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 967
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
97 SNMP Cisco UCS Chassis Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

968 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
97 SNMP Cisco UCS Chassis Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 969
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
98 SNMP Cisco UCS Physical Disk Sensor

6.8.98 SNM P Cisco UCS Phy sical Disk Sensor

The SNMP Cisco UCS Physical Disk sensor monitors a physical disk of a Cisco Unified
Computing and Server (UCS) device via Simple Network Management Protocol (SNMP). It can
show the operability status of the disk, as well as if the monitored disk is still connected.

Important notice: Currently, this sensor type is in bet a status. The methods of operating can
change at any time, as well as the available settings. Do not expect that all functions will work
properly, or that this sensor works as expected at all. Be aware that this type of sensor can be
removed again from PRTG at any time.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor physical disks in a UCS device, PRTG will create one sensor for each disk
you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

UCS Phy sical Disk

Disks Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.
Note: Only working disks (with the current status Up or Warning)
will be shown here.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

970 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
98 SNMP Cisco UCS Physical Disk Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

UCS Phy sical Disk

Disk Shows the disk which this sensor monitors. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Display Name Shows the display name of the physical disk which this sensor
monitors. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

12.05.2014 971
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
98 SNMP Cisco UCS Physical Disk Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

972 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
98 SNMP Cisco UCS Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

12.05.2014 973
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
98 SNMP Cisco UCS Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

974 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
98 SNMP Cisco UCS Physical Disk Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 975
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
99 SNMP Cisco UCS System Health Sensor

6.8.99 SNM P Cisco UCS Sy stem Health Sensor

The SNMP Cisco UCS System Health sensor monitors the system health of a Cisco Unified
Computing and Server (UCS) device via Simple Network Management Protocol (SNMP). It can
show the following: the number of operable resp. inoperable fans, the status of fan
performance, fan thermal and fan voltage, and if a fan failure is predicted; the number of
operable resp. inoperable fan modules, the status of fan module performance, fan module
thermal and fan module voltage, and if a fan module failure is predicted; the number of operable
resp. inoperable power supplies, the status of power supply performance, power supply
thermal and power supply voltage, and if a power supply failure is predicted.

The creation of these channels depends on the available measurement components in the UCS
device.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

976 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
99 SNMP Cisco UCS System Health Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

12.05.2014 977
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
99 SNMP Cisco UCS System Health Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

978 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
99 SNMP Cisco UCS System Health Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 979
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
99 SNMP Cisco UCS System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

980 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
99 SNMP Cisco UCS System Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 981
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
100 SNMP CPU Load Sensor

6.8.100 SNM P CPU Load Sensor

The SNMP CPU Load sensor monitors the system load using Simple Network Management
Protocol (SNMP). It can show the load of several CPUs in percent.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

982 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
100 SNMP CPU Load Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

07.02.2013 983
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
100 SNMP CPU Load Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

984 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
100 SNMP CPU Load Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

07.02.2013 985
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
100 SNMP CPU Load Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

986 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
101 SNMP Custom Sensor

6.8.101 SNM P Custom Sensor

The SNMP Custom sensor monitors a numerical value returned by a specific OID using Simple
Network Management Protocol (SNMP).

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

OID values

Channel Name Enter a name for the channel the results at the given OID will be will
shown in. You can change this value later in the sensor's channel
settings 1709 .

Value Type Select how the results at the given OID will be handled. Choose
between:
§ Gauge (unsigned Int eger): For integer values, such as 10 or
120.
§ Gauge (signed int eger): For integer values, such as -12 or 120.
§ Gauge (float ): For float values, such as -5.80 or 8.23.
§ Delt a (Count er): For counter values. PRTG will calculate the
difference between the last and the current value.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

28.05.2014 987
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
101 SNMP Custom Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

988 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
101 SNMP Custom Sensor

OID values

OID value Enter the OID of the SNMP object you want to receive numerical
data from. Note: Most OIDs begin with 1.3.6.1. However, entering
OIDs starting with 1.0, or 1.1, or 1.2 is also allowed. If you want to
disable the validation of your entry entirely, add the string
norfccheck: at the beginning of your OID, for example,
norfccheck:2.0.0.0.1.

Unit String Define the unit of the numerical data that will be received at the
given OID. Please enter a string.

Value Type Shows the value type of the numerical data that will be received at
the given OID.Once a sensor is created this value cannot be
changed. It is shown for reference purposes only. If you need to
change this, please add the sensor anew.

Multiplication If you want to multiply the received data with a certain value, enter
the quotient here. Please enter an integer or float value.

Division If you want to divide the received data by a certain value, enter the
divisor here. Please enter an integer or float value.

If value changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'On Change' not ificat ion: The sensor will send an
internal message indicating that its value has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

28.05.2014 989
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
101 SNMP Custom Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

990 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
101 SNMP Custom Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

28.05.2014 991
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
101 SNMP Custom Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

992 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
101 SNMP Custom Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How do I find out what OID I need to use for a custom sensor?
§ http://kb.paessler.com/en/topic/903

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 993
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

6.8.102 SNM P Custom String Sensor

The SNMP Custom String sensor monitors a string returned by a specific OID using Simple
Network Management Protocol (SNMP). It can check for keywords. If you want to use limits for
the sensor channel value, you can also extract a numeric value contained in the string.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

994 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

OID Values

OID Value Enter the OID of the SNMP object you want to receive a string
from. Note: Most OIDs begin with 1.3.6.1. However, entering OIDs
starting with 1.0, or 1.1, or 1.2 is also allowed. If you want to
disable the validation of your entry entirely, add the string
norfccheck: at the beginning of your OID, for example,
norfccheck:2.0.0.0.1.

Maximum Length of Define the maximum length of the string that will be received from
String the SNMP object at the given OID. If the string is longer than this
value, the sensor will be set to an error status. Please enter an
integer value or leave the field empty.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'On Change' not ificat ion: The sensor will send an
internal message indicating that its value has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the sensor value changes.

28.05.2014 995
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

Key word Search

Response Must Include Define which string must be part of the data that is received from
(Error State) the SNMP object at the given OID. You can either enter plain text or
a Regular Expression 2048 . If the data does not include the search
pattern, the sensor will be set to an error state. Please enter a
string or leave the field empty.

For Keyword Search Define in which format you have entered the search expression in
Use the field above.
§ Plain Text : Search for the string as plain text. The characters *
and ? work here as placeholder, whereas * stands for no or any
number of characters and ? stands for exactly one character (as
known from Windows search). This behavior cannot be disabled,
so the literal search for these characters is not possible with
plain text search.
§ Regular Expression: Treat the search pattern as a Regular
Expression 2048 .

Response Must Not Define which string must not be part of the data that is received
Include (Error State) form the SNMP object at the given OID. You can either enter plain
text or a Regular Expression 2048 . If the data does include the
search pattern, the sensor will be set to an error state. Please
enter a string or leave the field empty.

For Keyword Search Define in which format you have entered the search expression in
Use the field above.
§ Plain Text : Search for the string as plain text. The characters *
and ? work here as placeholder, whereas * stands for no or any
number of characters and ? stands for exactly one character (as
known from Windows search). This behavior cannot be disabled,
so the literal search for these characters is not possible with
plain text search.
§ Regular Expression: Treat the search pattern as a Regular
Expression 2048 .

Response Must Include Define which string must be part of the data that is received from
(Warning State) the SNMP object at the given OID. You can either enter plain text or
a Regular Expression 2048 . If the data does not include the search
pattern, the sensor will be set to a warning state. Please enter a
string or leave the field empty.

For Keyword Search Define in which format you have entered the search expression in
Use the field above.
§ Plain Text : Search for the string as plain text. The characters *
and ? work here as placeholder, whereas * stands for no or any
number of characters and ? stands for exactly one character (as
known from Windows search). This behavior cannot be disabled,
so the literal search for these characters is not possible with
plain text search.
996 § Regular Expression: Treat the search pattern as a Regular
28.05.2014
Expression 2048 .

Response Must Not Define which string must not be part of the data that is received
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

Ext ended Processing

Extract Number Using Define if you want to filter out a numeric value from the string
Regular Expression received from the SNMP object at the given OID. You can convert
this into a float value in order to use it with channel limits (see
Sensor Channels Set t ings 1709 ).
§ No ext ract ion: Do not extract a float value. Use the result as a
string value.
§ Ext ract a numeric value using a regular expression: Use a
regular expression to identify a numeric value in the string and
convert it to a float value. Define below. See also the example 1000

below.

Regular Expression This setting is only visible if number extraction is enabled above.
Enter a Regular Expression 2048 to identify the numeric value you
want to extract from the string returned by the SNMP object at the
given OID. You can use capturing groups here. Make sure the
expression returns numbers only (including decimal and thousands
separators). The result will be further refined by the settings below.

Index of Capturing This setting is only visible if number extraction is enabled above. If
Group your regular expression uses capturing groups, please specify
which one will be used to capture the number. Please enter an
integer value or leave the field empty.

Decimal Separator This setting is only visible if number extraction is enabled above.
Define which character is used as decimal separator for the number
extracted above. Please enter a string or leave the field empty.

Thousands Separator This setting is only visible if number extraction is enabled above.
Define which character is used as thousands separator for the
number extracted above. Please enter a string or leave the field
empty.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

28.05.2014 997
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

998 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

28.05.2014 999
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Example: Number Extraction with Regular Expression

If you want to extract a number in the response string using a regular expression, please note
that the index for captures in this sensor is based on 1 (not on 0). Furthermore, capturing
groups are not created automatically. The example below will illustrate this issue.

Consider the following string as returned by a request for CPU usage:

1000 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
102 SNMP Custom String Sensor

5 Sec (3.49%), 1 Min (3.555%), 5 Min (3.90%)

Assuming you would like to filter for the number 3.555, i.e., the percentage in the second
parentheses. Then enter the following regex in the Regular Expression field:
(\d+\.\d+).*(\d+\.\d+).*(\d+\.\d+)

As Index of Capt uring Group enter 3. This will extract the desired number 3.555.

The index has to be 3 in this case because the capturing groups here are the following:

§ Group 1 contains "3.49%), 1 Min (3.555), 5 Min (3.90"


§ Group 2 contains "3.49"
§ Group 3 contains "3.555"
§ Group 4 contains "3.90"

Please keep in mind this note about index and capturing groups when using number
extraction.

More
Knowledge Base: How do I find out what OID I need to use for a custom sensor?
§ http://kb.paessler.com/en/topic/903

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1001
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
103 SNMP Dell Hardware Sensor

6.8.103 SNM P Dell Hardware Sensor

The SNMP Dell Hardware sensor monitors performance counters on a Dell hardware device
using Simple Network Management Protocol (SNMP).

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For devices with multiple performance counters multiple sensors are created at once in the
Add Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Dell Hardware Specific

Library OIDs Select the performance counters you want to add a sensor for. A
list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1002 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
103 SNMP Dell Hardware Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Dell Hardware Specific

Selected Interface Shows the name of the interface (performance counter) monitored
by this sensor. Once a sensor is created this value cannot be
changed. It is shown for reference purposes only. If you need to
change this, please add the sensor anew.

Unit String Define the unit of the numerical data that will be received at the
given OID. Please enter a string.

Multiplication If you want to multiply the received data with a certain value, enter
the quotient here. Please enter an integer or float value.

Division If you want to divide the received data by a certain value, enter the
divisor here. Please enter an integer or float value.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

07.02.2013 1003
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
103 SNMP Dell Hardware Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1004 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
103 SNMP Dell Hardware Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

07.02.2013 1005
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
103 SNMP Dell Hardware Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1006 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
103 SNMP Dell Hardware Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1007
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
104 SNMP Dell PowerEdge Physical Disk Sensor

6.8.104 SNM P Dell PowerEdge Phy sical Disk Sensor

The SNMP Dell PowerEdge Physical Disk sensor monitors a physical disk in a Dell PowerEdge
server using Simple Network Management Protocol (SNMP). It can show the disk status, the roll
up status, the component status, as well as if there is currently a warning regarding the Self-
Monitoring, Analysis and Reporting Technology (S.M.A.R.T.) status.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: Dell OpenManage Server Administrator or iDRAC 7

This sensor needs the Dell OpenManage Server Administrator tool to be installed on the
device in order to monitor PowerEdge servers. Please make sure that you enable SNMP in the
OpenManage Server Administrator. For details, please see section More below. Note: You can
also monitor Dell PowerEdge servers with this sensor type via Integrated Dell Remote Access
Controller (iDRAC) 7.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor physical disks in a Dell PowerEdge server, PRTG will create one sensor for
each disk. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Dell PowerEdge Phy sical Disk Set t ings

Disk Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

1008 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
104 SNMP Dell PowerEdge Physical Disk Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Dell PowerEdge Phy sical Disk Set t ings

Disk Shows the name of the disk that this sensor is monitoring. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Data Source Shows the interface which is used to get monitoring data. This is
either Dell OpenManage Server Administrator (OMSA) or Integrated
Dell Remote Access Controller (iDRAC).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

12.05.2014 1009
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
104 SNMP Dell PowerEdge Physical Disk Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1010 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
104 SNMP Dell PowerEdge Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 1011
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
104 SNMP Dell PowerEdge Physical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More

Knowledge Base: What do I need to monitor Dell servers?

1012 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
104 SNMP Dell PowerEdge Physical Disk Sensor

§ http://kb.paessler.com/en/topic/45333

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
105 SNMP Dell PowerEdge System Health Sensor

6.8.105 SNM P Dell PowerEdge Sy stem Health Sensor

The SNMP Dell PowerEdge System Health sensor monitors the system health of a Dell
PowerEdge server using Simple Network Management Protocol (SNMP). It can show the global
system status, the power supply status, the temperature status, the cooling device status, the
memory device status, the voltage status, and many more, depending on the available
components of your device.

This sensor type has predefined limits for several metrics. These limits can be changed
individually in the channel settings. For detailed information about channel limits please refer to
the section Sensor Channels Set t ings 1709 .

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: Dell OpenManage Server Administrator or iDRAC 7

This sensor needs the Dell OpenManage Server Administrator tool to be installed on the
device in order to monitor PowerEdge servers. Please make sure that you enable SNMP in the
OpenManage Server Administrator. For details, please see section More below. Note: You can
also monitor Dell PowerEdge servers with this sensor type via Integrated Dell Remote Access
Controller (iDRAC) 7.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the health status of a Dell PowerEdge server, PRTG will create one sensor
for each chassis you choose. The settings you make in this dialog are valid for all of the
sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Dell PowerEdge Sy st em Healt h Specific

Chassis Select the chassis you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

1014 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
105 SNMP Dell PowerEdge System Health Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Dell PowerEdge Sy st em Healt h Specific

Chassis Shows the chassis this sensor monitors. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Channel Mask Shows the channel mask that describes which sensors are
available. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Data Source Shows the interface which is used to get monitoring data. This is
either Dell OpenManage Server Administrator (OMSA) or Integrated
Dell Remote Access Controller (iDRAC).

12.05.2014 1015
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
105 SNMP Dell PowerEdge System Health Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1016 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
105 SNMP Dell PowerEdge System Health Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

12.05.2014 1017
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
105 SNMP Dell PowerEdge System Health Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1018 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
105 SNMP Dell PowerEdge System Health Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More

Knowledge Base: What do I need to monitor Dell servers?

§ http://kb.paessler.com/en/topic/45333

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1019
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
106 SNMP Disk Free Sensor

6.8.106 SNM P Disk Free Sensor

The SNMP Disk Free sensor monitors the free disk space on a logical disk via Simple Network
Management Protocol (SNMP). It can show free space in percent and in total, as well as the
total space. Note: This sensor uses more generic Object Identifier (OID) values compared to
the SNMP Linux Disk Free Sensor 1122 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor memory usage, PRTG will create one sensor for each memory type you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Disk Free Set t ings

Disk Select one or more disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1020 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
106 SNMP Disk Free Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Disk Free Set t ings

Disk Shows the name of the disk that this sensor is monitoring. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

07.02.2013 1021
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
106 SNMP Disk Free Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1022 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
106 SNMP Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

07.02.2013 1023
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
106 SNMP Disk Free Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1024 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
106 SNMP Disk Free Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1025
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
107 SNMP GSA System Health Sensor

6.8.107 SNM P GSA Sy stem Health Sensor

The SNMP GSA System Health sensor monitors the system health of a Google Search Appliance
(GSA) via Simple Network Management Protocol (SNMP). It can show the number of queries per
minute, the number of processed documents, the number of indexed documents, the number
of processed bytes, the activity status of crawling, the crawling rate per second, as well as the
health status of disk, temperature, and machine.

Note: The location you provide in the GSA's SNMP configuration section will be shown in
PRTG's GeoMaps 1744 . In order to use SNMP v3 for monitoring, you need to add an SNMP v3
user in the GSA's SNMP configuration.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1026 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
107 SNMP GSA System Health Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

13.06.2013 1027
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
107 SNMP GSA System Health Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1028 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
107 SNMP GSA System Health Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

13.06.2013 1029
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
107 SNMP GSA System Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1030 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
108 SNMP Hardware Status Sensor

6.8.108 SNM P Hardware Status Sensor

The SNMP Hardware Status sensor monitors the status of a hardware component of a server
via Simple Network Management Protocol (SNMP). It shows the current status of the
component, as well as the number of errors per time period.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor hardware components of a server, PRTG will create one sensor for each
component you choose. The settings you make in this dialog are valid for all of the sensors
that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Hardware Specific

Hardware Component Select the hardware components you want to add a sensor for. A
list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

13.06.2013 1031
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
108 SNMP Hardware Status Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Hardware Specific

Hardware Component

Product ID
Shows further information about the hardware component. Once a
sensor is created this value cannot be changed. It is shown for
Description reference purposes only. If you need to change this, please add
the sensor anew.
Type

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1032 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
108 SNMP Hardware Status Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

13.06.2013 1033
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
108 SNMP Hardware Status Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1034 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
108 SNMP Hardware Status Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

13.06.2013 1035
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
109 SNMP HP LaserJet Hardware Sensor

6.8.109 SNM P HP LaserJet Hardware Sensor

The SNMP HP LaserJet Hardware sensor monitors performance counters on a HP LaserJet


hardware device using Simple Network Management Protocol (SNMP).

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For devices with multiple performance counters multiple sensors are created at once in the
Add Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Dell Hardware Specific

Library OIDs Select the performance counters you want to add a sensor for. A
list of available counters for your device is shown with category
and name:
§ Toner/St at us
§ Paper/St at us
§ Jam/St at us
A list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

1036 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
109 SNMP HP LaserJet Hardware Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HP LaserJet Specific

Selected Interface Shows the name of the interface (performance counter) monitored
by this sensor. Once a sensor is created this value cannot be
changed. It is shown for reference purposes only. If you need to
change this, please add the sensor anew.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

14.01.2014 1037
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
109 SNMP HP LaserJet Hardware Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1038 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
109 SNMP HP LaserJet Hardware Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

14.01.2014 1039
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
109 SNMP HP LaserJet Hardware Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

1040 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
109 SNMP HP LaserJet Hardware Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 1041
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
110 SNMP HP ProLiant Logical Disk Sensor

6.8.110 SNM P HP ProLiant Logical Disk Sensor

The SNMP HP ProLiant Logical Disk sensor monitors a logical disk in an HP server via Simple
Network Management Protocol (SNMP). It can show disk status and completion. Completion is
only important when the disk status is "Reconstructing" or "Expanding" and illustrates the
progress of this task.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: HP System Management Tools

This sensor needs a specific HP system management tool to be installed on the target device,
so it reports data via SNMP: HP Insight Management Agents for Windows Server 2003/2008. In
order to receive SNMP data from RAID controllers you will additionally need HP Insight
Management WBEM Providers. For more details and download links please refer to the
subsection More below.

Note: Some of the HP Object Identifiers (OIDs) which this sensor type uses are only accessible
via the HP Integrated Lights-Out (iLO) interface. If this sensor throws an error that it cannot
find "such device types", please create a device in PRTG which points to the address of the HP
iLO interface (if available) and add the sensor to this device. We recommend using the
Agentless Management feature with configured SNMP. You can set this up in the iLO
configuration interface under Administ rat ion | Management | SNMP Set t ings.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor logical disks in a HP server, PRTG will create one sensor for each disk you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

HP ProLiant Logical Disk Set t ings

Disk Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

1042 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
110 SNMP HP ProLiant Logical Disk Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HP ProLiant Logical Disk Set t ings

Disk Shows the name of the disk that this sensor is monitoring. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

12.05.2014 1043
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
110 SNMP HP ProLiant Logical Disk Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1044 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
110 SNMP HP ProLiant Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

12.05.2014 1045
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
110 SNMP HP ProLiant Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1046 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
110 SNMP HP ProLiant Logical Disk Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Monitor HP ProLiant via SNMP
§ http://kb.paessler.com/en/topic/33133

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1047
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
111 SNMP HP ProLiant Memory Controller Sensor

6.8.111 SNM P HP ProLiant M emory Controller Sensor

The SNMP HP ProLiant Memory Controller sensor monitors a memory controller in an HP server
via Simple Network Management Protocol (SNMP). It shows the error status of the controller,
the condition of the controller, and states and conditions of available modules. Note: If
modules are inserted at a later point, the sensor has to be added again.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For supported lookup values of this specific sensor, please see subsection More 1053 below.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: HP System Management Tools

This sensor needs a specific HP system management tool to be installed on the target device,
so it reports data via SNMP: HP Insight Management Agents for Windows Server 2003/2008. In
order to receive SNMP data from RAID controllers you will additionally need HP Insight
Management WBEM Providers. For more details and download links please refer to the
subsection More below.

Note: Some of the HP Object Identifiers (OIDs) which this sensor type uses are only accessible
via the HP Integrated Lights-Out (iLO) interface. If this sensor throws an error that it cannot
find "such device types", please create a device in PRTG which points to the address of the HP
iLO interface (if available) and add the sensor to this device. We recommend using the
Agentless Management feature with configured SNMP. You can set this up in the iLO
configuration interface under Administ rat ion | Management | SNMP Set t ings.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor memory controllers in a HP server, PRTG will create one sensor for each
controller you choose. The settings you make in this dialog are valid for all of the sensors that
are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

1048 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
111 SNMP HP ProLiant Memory Controller Sensor

HP ProLiant Memory Cont roller Set t ings

Controller Select the controllers you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HP ProLiant Memory Cont roller Set t ings

Controller Shows the name of the controller that this sensor is monitoring.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

28.05.2014 1049
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
111 SNMP HP ProLiant Memory Controller Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1050 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
111 SNMP HP ProLiant Memory Controller Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

28.05.2014 1051
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
111 SNMP HP ProLiant Memory Controller Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1052 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
111 SNMP HP ProLiant Memory Controller Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Monitor HP ProLiant via SNMP
§ http://kb.paessler.com/en/topic/33133

Knowledge Base: Which lookup values are supported by the SNMP HP ProLiant Memory
Controller Sensor?

§ http://kb.paessler.com/en/topic/44803

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1053
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
112 SNMP HP ProLiant Network Interface Sensor

6.8.112 SNM P HP ProLiant Network Interface Sensor

The SNMP HP ProLiant Network Interface sensor monitors a network interface in an HP server
via Simple Network Management Protocol (SNMP). It can show traffic in and out, the number of
transmitted and received good frames, the number of transmitted and received bad frames,
alignment and FCS (Frame Check Sequence) errors, late and excessive collisions, carrier sense
errors, and when the frames are too long.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: HP System Management Tools

This sensor needs a specific HP system management tool to be installed on the target device,
so it reports data via SNMP: HP Insight Management Agents for Windows Server 2003/2008. In
order to receive SNMP data from RAID controllers you will additionally need HP Insight
Management WBEM Providers. For more details and download links please refer to the
subsection More below.

Note: Some of the HP Object Identifiers (OIDs) which this sensor type uses are only accessible
via the HP Integrated Lights-Out (iLO) interface. If this sensor throws an error that it cannot
find "such device types", please create a device in PRTG which points to the address of the HP
iLO interface (if available) and add the sensor to this device. We recommend using the
Agentless Management feature with configured SNMP. You can set this up in the iLO
configuration interface under Administ rat ion | Management | SNMP Set t ings.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor network interfaces in a HP server, PRTG will create one sensor for each
interface. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

HP ProLiant Net work Int erface Set t ings

Network Interface Select the interfaces you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

1054 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
112 SNMP HP ProLiant Network Interface Sensor

Note: In the HP ProLiant Net work Int erface Set t ings section, the St at us of each available
network interface is shown. If this status is Link Failure, it is still possible to add a sensor for
the respective interface. Though, most likely the sensor for this interface will not work
correctly. The error message in this case will be No Such Name (SNMP error # 2).

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HP ProLiant Net work Int erface Set t ings

Network Interface Shows the name of the interface that this sensor is monitoring.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

12.05.2014 1055
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
112 SNMP HP ProLiant Network Interface Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1056 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
112 SNMP HP ProLiant Network Interface Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

12.05.2014 1057
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
112 SNMP HP ProLiant Network Interface Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1058 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
112 SNMP HP ProLiant Network Interface Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Monitor HP ProLiant via SNMP
§ http://kb.paessler.com/en/topic/33133

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1059
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
113 SNMP HP ProLiant Physical Disk Sensor

6.8.113 SNM P HP ProLiant Phy sical Disk Sensor

The SNMP HP ProLiant Physical Disk sensor monitors a physical disk in an HP server via Simple
Network Management Protocol (SNMP). It can show read and written sectors, hard and
corrected read errors, hard and corrected write errors, the disk status, the drive condition, the
Self-Monitoring, Analysis and Reporting Technology (S.M.A.R.T.) status, and if the threshold is
passed.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: HP System Management Tools

This sensor needs a specific HP system management tool to be installed on the target device,
so it reports data via SNMP: HP Insight Management Agents for Windows Server 2003/2008. In
order to receive SNMP data from RAID controllers you will additionally need HP Insight
Management WBEM Providers. For more details and download links please refer to the
subsection More below.

Note: Some of the HP Object Identifiers (OIDs) which this sensor type uses are only accessible
via the HP Integrated Lights-Out (iLO) interface. If this sensor throws an error that it cannot
find "such device types", please create a device in PRTG which points to the address of the HP
iLO interface (if available) and add the sensor to this device. We recommend using the
Agentless Management feature with configured SNMP. You can set this up in the iLO
configuration interface under Administ rat ion | Management | SNMP Set t ings.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor physical disks in a HP server, PRTG will create one sensor for each disk.
The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

HP ProLiant Phy sical Disk Set t ings

Disk Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

1060 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
113 SNMP HP ProLiant Physical Disk Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

HP ProLiant Phy sical Disk Set t ings

Disk Shows the name of the disk that this sensor is monitoring. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

12.05.2014 1061
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
113 SNMP HP ProLiant Physical Disk Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1062 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
113 SNMP HP ProLiant Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

12.05.2014 1063
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
113 SNMP HP ProLiant Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1064 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
113 SNMP HP ProLiant Physical Disk Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Monitor HP ProLiant via SNMP
§ http://kb.paessler.com/en/topic/33133

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1065
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
114 SNMP HP ProLiant System Health Sensor

6.8.114 SNM P HP ProLiant Sy stem Health Sensor

The SNMP HP ProLiant System Health sensor monitors the system health of an HP ProLiant
server via Simple Network Management Protocol (SNMP). It can show the overall status, the
thermal status, the system fan status, the CPU fan status, the number of broken and running
fans, as well as the number of broken and running fans that are fault tolerant, and status and
condition of the power supply.

Furthermore, it can show several temperatures for various components of an HP ProLiant


server—for example: memory, power supply, CPU, system, and storage. It is also possible to
display the power consumption and disk controller status. These channels are created at run-
time, depending on the available measurement components.

The SNMP HP ProLiant System Health sensor has predefined limits for temperatures and broken
frames. These limits can be changed individually in the channel settings. For detailed
information about channel limits please refer to the subsection Channels 1071 below.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: HP System Management Tools

This sensor needs a specific HP system management tool to be installed on the target device,
so it reports data via SNMP: HP Insight Management Agents for Windows Server 2003/2008. In
order to receive SNMP data from RAID controllers you will additionally need HP Insight
Management WBEM Providers. For more details and download links please refer to the
subsection More below.

Note: Some of the HP Object Identifiers (OIDs) which this sensor type uses are only accessible
via the HP Integrated Lights-Out (iLO) interface. If this sensor throws an error that it cannot
find "such device types", please create a device in PRTG which points to the address of the HP
iLO interface (if available) and add the sensor to this device. We recommend using the
Agentless Management feature with configured SNMP. You can set this up in the iLO
configuration interface under Administ rat ion | Management | SNMP Set t ings.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

1066 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
114 SNMP HP ProLiant System Health Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

12.05.2014 1067
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
114 SNMP HP ProLiant System Health Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1068 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
114 SNMP HP ProLiant System Health Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 1069
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
114 SNMP HP ProLiant System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Monitor HP ProLiant via SNMP

1070 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
114 SNMP HP ProLiant System Health Sensor

§ http://kb.paessler.com/en/topic/33133

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1071
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
115 SNMP IBM System X Logical Disk Sensor

6.8.115 SNM P IBM Sy stem X Logical Disk Sensor

The SNMP IBM System X Logical Disk sensor monitors a logical disk in an IBM server via Simple
Network Management Protocol (SNMP). It shows the status of a logical disk.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: IBM Systems Director Platform Agent

This sensor type needs the IBM Systems Director Platform Agent to be installed on the target
IBM device in order to monitor it through SNMP. For more information, please see section
More below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the logical disks of an IBM device, PRTG will create one sensor for each
disk you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

IBM Sy st em X Logical Disk Set t ings

Disk Select the logical disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

1072 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
115 SNMP IBM System X Logical Disk Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

IBM Sy st em X Logical Disk Set t ings

Disk Shows the ID of the logical disk. Once a sensor is created this
value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

24.10.2013 1073
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
115 SNMP IBM System X Logical Disk Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1074 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
115 SNMP IBM System X Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

24.10.2013 1075
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
115 SNMP IBM System X Logical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: What are the requirements to monitor IBM System x?

1076 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
115 SNMP IBM System X Logical Disk Sensor

§ http://kb.paessler.com/en/topic/59393

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

24.10.2013 1077
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
116 SNMP IBM System X Physical Disk Sensor

6.8.116 SNM P IBM Sy stem X Phy sical Disk Sensor

The SNMP IBM System X Physical Disk sensor monitors a physical disk in an IBM server via
Simple Network Management Protocol (SNMP). It shows the status of a physical disk.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: IBM Systems Director Platform Agent

This sensor type needs the IBM Systems Director Platform Agent to be installed on the target
IBM device in order to monitor it through SNMP. For more information, please see section
More below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the physical disks of an IBM device, PRTG will create one sensor for each
disk you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

IBM Sy st em X Phy sical Disk Set t ings

Disk Select the physical disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

1078 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
116 SNMP IBM System X Physical Disk Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

IBM Sy st em X Phy sical Disk Set t ings

Disk Shows the ID of the physical disk. Once a sensor is created this
value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

24.10.2013 1079
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
116 SNMP IBM System X Physical Disk Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1080 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
116 SNMP IBM System X Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

24.10.2013 1081
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
116 SNMP IBM System X Physical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: What are the requirements to monitor IBM System x?

1082 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
116 SNMP IBM System X Physical Disk Sensor

§ http://kb.paessler.com/en/topic/59393

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

24.10.2013 1083
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
117 SNMP IBM System X Physical Memory Sensor

6.8.117 SNM P IBM Sy stem X Phy sical M emory Sensor

The SNMP IBM System X Physical Memory sensor monitors the memory modules in an IBM
server via Simple Network Management Protocol (SNMP). It shows the condition of a memory
module, as well as its power status.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: IBM Systems Director Platform Agent

This sensor type needs the IBM Systems Director Platform Agent to be installed on the target
IBM device in order to monitor it through SNMP. For more information, please see section
More below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the memory modules of an IBM device, PRTG will create one sensor for
each module you choose. The settings you make in this dialog are valid for all of the sensors
that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

IBM Sy st em X Phy sical Memory Set t ings

Module Select the memory modules you want to add a sensor for. A list of
all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

1084 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
117 SNMP IBM System X Physical Memory Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

IBM Sy st em X Phy sical Memory Set t ings

Name

Caption
Shows further information about the module. Once a sensor is
created this value cannot be changed. It is shown for reference
Serial Number purposes only. If you need to change this, please add the sensor
anew.
Size

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

24.10.2013 1085
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
117 SNMP IBM System X Physical Memory Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1086 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
117 SNMP IBM System X Physical Memory Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

24.10.2013 1087
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
117 SNMP IBM System X Physical Memory Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: What are the requirements to monitor IBM System x?

1088 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
117 SNMP IBM System X Physical Memory Sensor

§ http://kb.paessler.com/en/topic/59393

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

24.10.2013 1089
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
118 SNMP IBM System X System Health Sensor

6.8.118 SNM P IBM Sy stem X Sy stem Health Sensor

The SNMP IBM System X System Health sensor monitors the system health of an IBM device via
Simple Network Management Protocol (SNMP). It can show revolutions per minute of fans (or
the current percentage of the possible maximum), temperatures of ambient and CPUs, voltage,
status of power supplies, and many more, depending on the available measurement
components.

Note: If the IBM device returns a string in an unexpected format for the percentage of fan
revolutions (for example, "offline"), this sensor will show -1% in the corresponding channel. You
can define a Down status for this via channel limits 1710 .

This sensor type has predefined limits for several metrics. These limits can be changed
individually in the channel settings. For detailed information about channel limits please refer to
the section Sensor Channels Set t ings 1709 .

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Requirement: IBM Systems Director Platform Agent

This sensor type needs the IBM Systems Director Platform Agent to be installed on the target
IBM device in order to monitor it through SNMP. For more information, please see section
More below.

Note: The SNMP IBM System X System Health sensor can also run directly on an Integrated
Management Module (IMM) network port and can show the overall health on IMMs.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the system health of an IBM device, PRTG will create one sensor for each
measurement you choose. The settings you make in this dialog are valid for all of the sensors
that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

1090 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
118 SNMP IBM System X System Health Sensor

IBM Sy st em X Sy st em Healt h Specific

Measurement Select the measurements you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

IBM Sy st em X Sy st em Healt h Specific

Source Shows the source of the measurement. Once a sensor is created


this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Measurement Shows the ID of the measurement that this sensor is monitoring.


Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

12.05.2014 1091
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
118 SNMP IBM System X System Health Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1092 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
118 SNMP IBM System X System Health Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

12.05.2014 1093
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
118 SNMP IBM System X System Health Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1094 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
118 SNMP IBM System X System Health Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: What are the requirements to monitor IBM System x?
§ http://kb.paessler.com/en/topic/59393

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1095
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
119 SNMP interSeptor Pro Environment Sensor

6.8.119 SNM P interSeptor Pro Environment Sensor

The SNMP interSeptor Pro Environment sensor queries data from a Jacarta interSeptor Pro
environmental monitoring system via Simple Network Management Protocol (SNMP). It can
monitor temperature and humidity as measured by the Jacarta interSeptor Pro device.

Note: In order to monitor an interSeptor Pro device's data with this sensor, you have to add
the IP address of your PRTG installation to Access Cont rol in the interSeptor Pro control
panel. Open the interSeptor Pro web interface, select Int erSept or Pro Menu | Sy st em
Configurat ion | Access Cont rol for this purpose, and allow access for PRTG's IP address.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the environment via an interSeptor Pro device, PRTG will create one sensor
for each measuring point you choose. The settings you make in this dialog are valid for all of
the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Int erSept or Environment Specific

Measuring Point Select the measuring points you want to add a sensor for. A list of
all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1096 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
119 SNMP interSeptor Pro Environment Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Int erSept or Environment Specific

Name Shows information about the measurement which this sensor


monitors. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Measuring Point Shows the measuring point which this sensor monitors. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

12.05.2014 1097
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
119 SNMP interSeptor Pro Environment Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1098 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
119 SNMP interSeptor Pro Environment Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 1099
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
119 SNMP interSeptor Pro Environment Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1100 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
119 SNMP interSeptor Pro Environment Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1101
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
120 SNMP LenovoEMC Physical Disk Sensor

6.8.120 SNM P LenovoEM C Phy sical Disk Sensor

The SNMP Lenovo Physical Disk sensor monitors a physical disk in a LenovoEMC Network
Attached Storage (NAS) via Simple Network Management Protocol (SNMP). It shows the overall
disk status. States of the disk can be Normal (sensor status Up), Unknown and Foreign (both
with sensor status Warning), as well as Faulted and Missing (both with sensor status Down).

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor physical disks in a LenovoEMC NAS, PRTG will create one sensor for each
disk you select. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

LenovoEMC Phy sical Disk Set t ings

Disk Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1102 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
120 SNMP LenovoEMC Physical Disk Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

LenovoEMC Phy sical Disk Set t ings

Disk Shows the disk monitored by this sensor. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Name Shows the name of the disk monitored by this sensor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Size Shows the size of the disk monitored by this sensor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

14.01.2014 1103
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
120 SNMP LenovoEMC Physical Disk Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1104 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
120 SNMP LenovoEMC Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

14.01.2014 1105
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
120 SNMP LenovoEMC Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

1106 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
120 SNMP LenovoEMC Physical Disk Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 1107
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
121 SNMP LenovoEMC System Health Sensor

6.8.121 SNM P LenovoEM C Sy stem Health Sensor

The SNMP LenovoEMC System Health sensor monitors the system health of a LenovoEMC
Network Attached Storage (NAS) via Simple Network Management Protocol (SNMP). It shows
the overall status of the RAID. States can be Normal (sensor status Up), Unknown, Rebuilding,
Degraded, and RebuildFS (all with sensor status Warning), as well as Faulted (sensor status
Down).

Furthermore, this sensor can show, for example, states of several fans, voltages, and
temperatures. These channels are created at run-time depending on the available measurement
components in the LenovoEMC NAS.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1108 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
121 SNMP LenovoEMC System Health Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

14.01.2014 1109
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
121 SNMP LenovoEMC System Health Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1110 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
121 SNMP LenovoEMC System Health Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

14.01.2014 1111
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
121 SNMP LenovoEMC System Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1112 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

6.8.122 SNM P Library Sensor

The SNMP Library sensor monitors a device using Simple Network Management Protocol
(SNMP) in combination with a compiled Management Information Base (MIB) library file. This
provides extended monitoring beyond the standard SNMP sensors of PRTG.

In order to monitor any SNMP capable device, you can download the manufacturer's MIB files
for these devices, convert them to the Paessler oidlib format, and import them into PRTG. To
make your monitoring setup as convenient as possible, PRTG is delivered with pre-compiled
oidlib library files that already contain the Object Identifier (OID) of SNMP counters for the most
common devices in a network.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

Manually add 220 a new sensor to an SNMP device and from the Add Sensor dialog, select
SNMP Library sensor. PRTG will show a list of oidlib files available on the system. This contains
all library files stored at the \snmplibs sub-directory of your PRTG installation directory—both
the ones delivered with PRTG and your own files. For details about directory paths, please see
section Dat a St orage 2074 .

List of SNMP Library Files

28.05.2014 1113
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

The file names in the list indicate the potential purpose. Select a name that appears appropriate
for your device and confirm with the OK button. Often, Paessler common oid library .oidlib is
a good start. If the file does not fit to your device, this will result in an error message saying
that the scan for available monitoring items has failed on this device: No such object (SNMP
error # 222). If you see this message, please hit the Cancel button and try adding the sensor
with another file. If counters were found for your device, you will see the sensor's settings.

Default OIDLIB Files Overview

The following files are delivered with PRTG and allow to extend your SNMP monitoring for many
devices. Please be aware that not all devices and/or parameters may be supported by the
libraries.

§ APC UPS.oidlib
Can be used to monitor uninterruptible power supplies (UPS) from APC American Power
Conversion Corp.

§ APCSensorst at ionlib.oidlib
Can be used to monitor alarm status, communication status, humidity, and temperature as
shown by an APC sensor station.

§ Basic Linux Library (UCD-SNMP-MIB).oidlib


Can be used to monitor basic system parameters on Linux systems, such as memory, disk
and swap, CPU, etc.

§ cisco-int erfaces.oidlib
Can be used to monitor Cisco specific parameters, for example, the number of present
network interfaces on a system, several states of an interface (admin, oper, speed, type,
errors, discards, etc.), and more.

§ cisco-queue.oidlib
Can be used to monitor queues on a Cisco interface, for example, queue depth and its
maximum, discarded messages from the queue, the number of the queue within the queue
set, etc.

§ Dell St orage Management .oidlib


Can be used to monitor Dell storage devices. Possible parameters include disk arrays,
battery and power supply, fan and temperature, virtual disk, etc.

§ Dell Sy st ems Management Inst rument at ion.oidlib


Can be used to monitor the hardware of Dell systems. Possible parameters include ACPower
and battery, alerts, base board, Bios, BMC, chassis, COO, cooling, event log, firmware, IDE,
keyboard, memory, port, network, processor, SCSI, system, temperature, USB, UUID, etc.

§ Linux SNMP (AX BGP DisMan Et herLike Host ).oidlib


Can be used to monitor different aspects of Linux systems. Note: This file can find a very
large number of possible interfaces. It may take a few seconds until the selection table is
shown.

1114 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

§ Linux SNMP (Framework Proxy Not i v2).oidlib


Can be used to monitor different aspects of Linux systems. Note: This file can find a very
large number of possible interfaces. It may take a few seconds until the selection table is
shown.

§ Linux SNMP (IP Net SNMP Not i OSPF RMON SMUX ).oidlib
Can be used to monitor different aspects of Linux systems. Note: This file can find a very
large number of possible interfaces. It may take a few seconds until the selection table is
shown.

§ Linux SNMP (Source TCP UCD UDP).oidlib


Can be used to monitor different aspects of Linux systems. Note: This file can find a very
large number of possible interfaces. It may take a few seconds until the selection table is
shown.

§ Paessler Common OID Library .oidlib


Can be used to monitor many common hardware devices. It is used for several sensors and
is encrypted.

Import MIB Files

Additionally you can create your own oidlib files by importing your device manufacturers' MIB
files, using a the free Paessler MIB Import er. Simply convert your mib files and save the
resulting oidlib files to the \snmplibs sub-folder of your PRTG program directory. For details
about directory paths, please see Dat a St orage 2074 . For more information and download of
MIB Import er, please see the link in the More 1120 section below.

SNMP Library Sensor—Add Sensor Settings

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SNMP Library Specific

Library This shows the path to the oidlib file selected before. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Library-OIDs Select the aspects of the device you want to monitor. A list specific
to your setup is shown. It contains all counters found in the
chosen library that match your device. Select one or more items by
adding a check mark in front of the respective line. For each
selection one sensor will be created when you click the Cont inue
button.

28.05.2014 1115
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1116 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

SNMP Library Specific

Selected Interface Shows the interface monitored by this sensor. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Unit String Enter a string describing the unit of the returned values. This is for
display purposes only. Please enter a string.

Multiplication If you want to multiply the received data with a certain value, enter
the quotient here. Please enter an integer or float value, or leave
the field empty.

Division If you want to divide the received data by a certain value, enter the
divisor here. Please enter an integer or float value, or leave the field
empty.

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
§ Ignore changes (default ): No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

28.05.2014 1117
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1118 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 1119
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How can I import my MIB files into PRTG?
§ http://kb.paessler.com/en/topic/733

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

1120 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
122 SNMP Library Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1121
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

6.8.123 SNM P Linux Disk Free Sensor

The SNMP Linux Disk Free sensor monitors free space on disks of a Linux/Unix system using
Simple Network Management Protocol (SNMP). It shows the total free disk space (sum), and the
free disk space in percent for every mounted partition (volume).

Note: The free space returned by this sensor type shows the disk space that is not yet used.
Not all of this space may be available for use, as a part of this space can be reserved by the
system, e.g. for redundancy purposes. For details, please see the article linked in the More 1129
section below.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1122 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

Set limit s checked against ALL disks

In this section you can set limits that are valid for all channels and all drives. By entering
limits, you can define when the sensor will enter a Warning or Down status; depending on
the data provided by all drives that this sensor monitors. If you want to define limits for
separate channels individually please use the limit settings in the sensor's Channels settings.
Note: All limits defined here are valid additionally to the limits defined in the particular
Channels settings!

Percentage Limit Check Enable or disable a limit check for the free space in percentage
channels of all drives. By default percentage limits are enabled with
lower warning and lower error limit. Choose between:
· Disable Percent age Limit s: Do not use the drives' data to
control the sensor's status.
· Enable Percent age Limit s: Define limits. Additional fields appear
below. The sensor will enter a warning or down state when free
space limits are undercut or overrun.

Upper Error Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Down status. If the free disk
space of one of your drives overruns this percent value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Warning status. If the free
disk space of one of your drives overruns this percent value, the
sensor will be set to Warning. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for a warning state. If the free disk
space of one of your drives undercuts this percent value, the
sensor will be set to warning. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

28.05.2014 1123
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

Set limit s checked against ALL disks

Lower Error Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for entering a Down status. If the
free disk space of one of your drives undercuts this percent value,
the sensor will be set to Down. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Byte Limit Check Enable or disable a limit check for the free bytes channels of all
drives. Choose between:
· Disable By t e Limit s: Do not use the drives' data to control the
sensor's status.
· Enable By t e Limit s: Define limits. Additional fields appear below.
The sensor will enter a warning or down state when free space
limits are undercut or overrun.

Upper Error Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives overruns this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives overruns this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives undercuts this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

1124 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

Set limit s checked against ALL disks

Lower Error Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives undercuts this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Alarm on Missing/ If a monitored disk is removed or not found, values are set to zero.
Removed Disk Select the alarming approach in this case. Choose between:
§ Deact ivat e alarm (default ): Select this option if you do not
want an alarm for a removed disk.
§ Act ivat e Alarm: Select this option if you want to be alerted if a
monitored disk is removed.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

28.05.2014 1125
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1126 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 1127
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1128 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
123 SNMP Linux Disk Free Sensor

More

Knowledge Base: Why do SSH Disk Free and SNMP Linux Disk Free show different values for
my target Linux system?
§ http://kb.paessler.com/en/topic/43183

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1129
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
124 SNMP Linux Load Average Sensor

6.8.124 SNM P Linux Load Average Sensor

The SNMP Load Average sensor monitors the system load average of a Linux/Unix system
using Simple Network Management Protocol (SNMP). It shows the average system load within a
one, five, and 15 minutes interval (each in one channel).

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol

1130 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
124 SNMP Linux Load Average Sensor

Sensor Display

of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

27.11.2012 1131
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
124 SNMP Linux Load Average Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1132 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
124 SNMP Linux Load Average Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

27.11.2012 1133
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
124 SNMP Linux Load Average Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1134 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
125 SNMP Linux Meminfo Sensor

6.8.125 SNM P Linux M eminfo Sensor

The SNMP Linux Meminfo sensor monitors the memory usage of a Linux/Unix system using
Simple Network Management Protocol (SNMP). It shows the available memory in total and in
percent.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol

08.10.2013 1135
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
125 SNMP Linux Meminfo Sensor

Sensor Display

of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1136 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
125 SNMP Linux Meminfo Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

08.10.2013 1137
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
125 SNMP Linux Meminfo Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1138 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
125 SNMP Linux Meminfo Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

08.10.2013 1139
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

6.8.126 SNM P Linux Phy sical Disk Sensor

The SNMP Linux Physical Disk sensor monitors input/output (I/O) on disks of a Linux/Unix
system using Simple Network Management Protocol (SNMP). It shows read and written bytes
per second, read and write accesses per second, as well as load average within a specific time
span (1, 5, and 15 minutes), depending on the counters available on the disk.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor I/O on disks of a Linux/Unix system, PRTG will create one sensor for each
disk you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Phy sical Disk Set t ings

Disk Select one or more disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1140 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Phy sical Disk Set t ings

Disk Shows further information about the disk that this sensor is
monitoring. Once a sensor is created this value cannot be changed.
It is shown for reference purposes only. If you need to change this,
Bitmask please add the sensor anew.

Set limit s checked against ALL disks

In this section you can set limits that are valid for all channels and all drives. By entering
limits, you can define when the sensor will enter a Warning or Down status; depending on
the data provided by all drives that this sensor monitors. If you want to define limits for
separate channels individually please use the limit settings in the sensor's Channels settings.
Note: All limits defined here are valid additionally to the limits defined in the particular
Channels settings!

Percentage Limit Check Enable or disable a limit check for load average in percentage
channels of all drives. By default percentage limits are enabled with
lower warning and lower error limit. Choose between:
· Disable Percent age Limit s: Do not use the drives' data to
control the sensor's status.
· Enable Percent age Limit s: Define limits. Additional fields appear
below. The sensor will enter a warning or down state when load
average limits are undercut or overrun.

19.07.2013 1141
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

Set limit s checked against ALL disks

Upper Error Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Down status. If load average
of one of your drives overruns this percent value, the sensor will
be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Warning status. If load
average of one of your drives overruns this percent value, the
sensor will be set to Warning. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for a warning state. If load average
of one of your drives undercuts this percent value, the sensor will
be set to warning. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Lower Error Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for entering a Down status. If load
average of one of your drives undercuts this percent value, the
sensor will be set to Down. Please enter an integer value or leave
the field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

Byte Limit Check Enable or disable a limit check for read and written bytes channels
of all drives. Choose between:
· Disable By t e Limit s: Do not use the drives' data to control the
sensor's status.
· Enable By t e Limit s: Define limits. Additional fields appear below.
The sensor will enter a warning or down state when read and
written bytes limits are undercut or overrun.

1142 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

Set limit s checked against ALL disks

Upper Error Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the bytes channels
of this sensor (by default this is MByte). If the read and/or written
bytes of one of your drives overruns this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the bytes channels
of this sensor (by default this is MByte). If the read and/or written
bytes of one of your drives overruns this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the bytes channels of
this sensor (by default this is MByte). If the read and/or written
bytes of one of your drives undercuts this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

Lower Error Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the bytes channels of
this sensor (by default this is MByte). If the read and/or written
bytes of one of your drives undercuts this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Alarm on Missing/ If a monitored disk is removed or not found, values are set to zero.
Removed Disk Select the alarming approach in this case. Choose between:
§ Deact ivat e alarm (default ): Select this option if you do not
want an alarm for a removed disk.
§ Act ivat e Alarm: Select this option if you want to be alerted if a
monitored disk is removed.

19.07.2013 1143
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1144 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

19.07.2013 1145
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1146 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
126 SNMP Linux Physical Disk Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

19.07.2013 1147
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
127 SNMP Memory Sensor

6.8.127 SNM P M emory Sensor

The SNMP Memory sensor monitors the memory usage of a system via Simple Network
Management Protocol (SNMP). It can show the available memory in total and in percent, as well
as the total memory. Note: This sensor uses more generic Object Identifier (OID) values
compared to the SNMP Linux Meminfo Sensor 1135 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor memory usage, PRTG will create one sensor for each memory type you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Memory Set t ings

Memory Select one or more memory types you want to add a sensor for. A
list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1148 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
127 SNMP Memory Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Memory Set t ings

Memory Shows the type of the memory that this sensor is monitoring. Once
a sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

07.02.2013 1149
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
127 SNMP Memory Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1150 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
127 SNMP Memory Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

07.02.2013 1151
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
127 SNMP Memory Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1152 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
127 SNMP Memory Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1153
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
128 SNMP NetApp Disk Free Sensor

6.8.128 SNM P NetApp Disk Free Sensor

The SNMP NetApp Disk Free sensor monitors free space on disks of a NetApp storage system
via Simple Network Management Protocol (SNMP). It can show deduplication saved space and
shared space, in total and in percent; disk free (total and percent), as well as percentage values
for files free and inodes free.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor disk space on a NetApp, PRTG will create one sensor for each disk. The
settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Net App Disk Free Set t ings

File System Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1154 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
128 SNMP NetApp Disk Free Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Net App Disk Free Set t ings

File System Shows the name of the disk that this sensor is monitoring. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Virtual Disk Shows the name of the virtual disk that this sensor is monitoring (if
applicable). Once a sensor is created this value cannot be changed.
It is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

07.02.2013 1155
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
128 SNMP NetApp Disk Free Sensor

Sensor Display

§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1156 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
128 SNMP NetApp Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

07.02.2013 1157
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
128 SNMP NetApp Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1158 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
128 SNMP NetApp Disk Free Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1159
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
129 SNMP NetApp Enclosure Sensor

6.8.129 SNM P NetApp Enclosure Sensor

The SNMP NetApp Enclosure sensor monitors the power supply and cooling of an enclosure
that is part of a NetApp storage system via SNMP. It can measure temperatures, fans, voltages,
and currents.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor power supply and cooling of an enclosure on a NetApp, PRTG will create
one sensor for each enclosure/measurement combination. The settings you make in this
dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Net App Enclosure Set t ings

Enclosure Select the enclosures with the desired measurement you want to
add a sensor for. A list of all available items is shown with their
name. Select the desired items by adding check marks in front of
the respective lines. One sensor will be created for each selection.
You can also select and deselect all items by using the check box
in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1160 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
129 SNMP NetApp Enclosure Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Net App Enclosure Set t ings

Enclosure Shows the identifier of the enclosure that this sensor is


monitoring. Once a sensor is created this value cannot be changed.
It is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Measurement Shows the monitored measurement. Once a sensor is created this


value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

07.02.2013 1161
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
129 SNMP NetApp Enclosure Sensor

Sensor Display

§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1162 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
129 SNMP NetApp Enclosure Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

07.02.2013 1163
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
129 SNMP NetApp Enclosure Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1164 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
129 SNMP NetApp Enclosure Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1165
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
130 SNMP NetApp I/O Sensor

6.8.130 SNM P NetApp I/O Sensor

The SNMP NetApp I/O sensor monitors input/output operations (IOPS) on a NetApp storage
system via Simple Network Management Protocol (SNMP). It can show FCP Read, CIFS Ops, Disk
Read, Disk Write, FCP Ops, FCP Write, HTTP Ops, ISCSI Ops, ISCSI Read, ISCSI Write, Network
Received, Network Sent, NFS Ops, Tape Read, and Tape Write.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1166 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
130 SNMP NetApp I/O Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

27.11.2012 1167
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
130 SNMP NetApp I/O Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

1168 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
130 SNMP NetApp I/O Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

27.11.2012 1169
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
130 SNMP NetApp I/O Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1170 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
130 SNMP NetApp I/O Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 1171
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
131 SNMP NetApp License Sensor

6.8.131 SNM P NetApp License Sensor

The SNMP NetApp License sensor monitors the licenses for the services of a NetApp storage
system via Simple Network Management Protocol (SNMP). It indicates how much time is left
until the license for a service expires. This can help you to detect when a timely limited NetApp
license is going to expire.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor licenses on a NetApp, PRTG will create one sensor for each license. The
settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Net App License Set t ings

License for Service Select the licenses you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1172 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
131 SNMP NetApp License Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Net App License Set t ings

License for Service Shows the name of the license that this sensor is monitoring. Once
a sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

07.02.2013 1173
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
131 SNMP NetApp License Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1174 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
131 SNMP NetApp License Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

07.02.2013 1175
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
131 SNMP NetApp License Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1176 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
131 SNMP NetApp License Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1177
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
132 SNMP NetApp Logical Unit Sensor

6.8.132 SNM P NetApp Logical Unit Sensor

The SNMP NetApp Logical Unit sensor monitors the input/output operations (IOPS) on a logical
unit of a NetApp storage system via Simple Network Management Protocol (SNMP). It can show
the total number of operations, the amount of read and written data, the number of errors, the
number of read, write, and other operations, as well as the overall status of the logical unit.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor logical units on a NetApp, PRTG will create one sensor for each unit. The
settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Net App Disk Free Set t ings

Logical Unit Select the logical units you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1178 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
132 SNMP NetApp Logical Unit Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Net App Disk Free Set t ings

Logical Unit Shows the name of the logical unit that this sensor is monitoring.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

14.01.2014 1179
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
132 SNMP NetApp Logical Unit Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1180 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
132 SNMP NetApp Logical Unit Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 1181
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
132 SNMP NetApp Logical Unit Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1182 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
132 SNMP NetApp Logical Unit Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 1183
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
133 SNMP NetApp Network Interface Sensor

6.8.133 SNM P NetApp Network Interface Sensor

The SNMP NetApp Network Interface sensor monitors a network card of a NetApp storage
system via Simple Network Management Protocol (SNMP). It can show traffic in and out, as well
as the number of errors per second (in and out).

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor network interfaces on a NetApp, PRTG will create one sensor for each
interface. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Net App Net work Int erface Set t ings

Network Interface Select the interfaces you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1184 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
133 SNMP NetApp Network Interface Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Net App Net work Int erface Set t ings

Network Interface Shows the name of the interface that this sensor is monitoring.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

07.02.2013 1185
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
133 SNMP NetApp Network Interface Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1186 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
133 SNMP NetApp Network Interface Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

07.02.2013 1187
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
133 SNMP NetApp Network Interface Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1188 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
133 SNMP NetApp Network Interface Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1189
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
134 SNMP NetApp System Health Sensor

6.8.134 SNM P NetApp Sy stem Health Sensor

The SNMP NetApp System Health sensor monitors the status of a NetApp storage system via
Simple Network Management Protocol (SNMP). It can show the CPU load in percent, active
restore, current CIFS users; the number of disks active, being added, being scrubbed, failed,
failing soon, being out of date, reconstructing (parity), spare, verifying parity, and total; the
number of fans and power supplies failed; the max used disk space and max used inodes, in
percent. This depends on the available measurement components on the NetApp.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1190 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
134 SNMP NetApp System Health Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

28.05.2014 1191
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
134 SNMP NetApp System Health Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

1192 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
134 SNMP NetApp System Health Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 1193
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
134 SNMP NetApp System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1194 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
134 SNMP NetApp System Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1195
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
135 SNMP Poseidon Environment Sensor

6.8.135 SNM P Poseidon Environment Sensor

The SNMP Poseidon Environment sensor monitors performance counters for environmental
measurements on Poseidon hardware via Simple Network Management Protocol (SNMP). It can
show, for example, humidity and temperature in the environment, depending on available
measurement components on the hardware device.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor performance counters for environmental measurements on Poseidon


hardware, PRTG will create one sensor for each measuring point you choose. The settings you
make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Poseidon Environment Specific

Measuring Point Select the measurements you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1196 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
135 SNMP Poseidon Environment Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Poseidon Environment Specific

Name
Shows further information about the measurement. Once a sensor
Unit is created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
Measuring Point anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

13.06.2013 1197
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
135 SNMP Poseidon Environment Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1198 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
135 SNMP Poseidon Environment Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

13.06.2013 1199
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
135 SNMP Poseidon Environment Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1200 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
136 SNMP Printer Sensor

6.8.136 SNM P Printer Sensor

The SNMP Printer sensor is a generic sensor which monitors various types of printers via
Simple Network Management Protocol (SNMP). It can show the total number of printed pages,
the fill level of cartridges and toners, and the status of the printer cover. Additionally, the
sensor shows the printer status as sensor message.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Important notice: Currently, this sensor type is in bet a status. The methods of operating can
change at any time, as well as the available settings. Do not expect that all functions will work
properly, or that this sensor works as expected at all. Be aware that this type of sensor can be
removed again from PRTG at any time.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

28.05.2014 1201
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
136 SNMP Printer Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1202 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
136 SNMP Printer Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

28.05.2014 1203
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
136 SNMP Printer Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1204 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
136 SNMP Printer Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1205
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
137 SNMP QNAP Logical Disk Sensor

6.8.137 SNM P QNAP Logical Disk Sensor

The SNMP QNAP Logical Disk sensor monitors a logical disk in a QNAP Network Attached
Storage (NAS) via Simple Network Management Protocol (SNMP). It can show free space and
free bytes, as well as the status of a volume.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the logical disks in a QNAP NAS, PRTG will create one sensor for each disk
you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

QNAP NAS Set t ings

Disk Select the logical disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1206 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
137 SNMP QNAP Logical Disk Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

QNAP NAS Set t ings

Disk
Shows further information about the disk. Once a sensor is created
Description this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.
File System

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

13.06.2013 1207
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
137 SNMP QNAP Logical Disk Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1208 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
137 SNMP QNAP Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

13.06.2013 1209
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
137 SNMP QNAP Logical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1210 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
138 SNMP QNAP Physical Disk Sensor

6.8.138 SNM P QNAP Phy sical Disk Sensor

The SNMP QNAP Physical Disk sensor monitors a physical disk in a QNAP Network Attached
Storage (NAS) via Simple Network Management Protocol (SNMP). It can show the temperature,
the HD status, and the Self-Monitoring, Analysis and Reporting Technology (S.M.A.R.T.) status
of the disk.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the physical disks in a QNAP NAS, PRTG will create one sensor for each disk
you choose. You can also define the unit of the temperature measurement. The settings you
make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

QNAP NAS Set t ings

Disk Select the physical disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Unit Select the unit of the temperature measurement. Choose between


Celsius and Fahrenheit .

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

13.06.2013 1211
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
138 SNMP QNAP Physical Disk Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

QNAP NAS Set t ings

Disk

Description

Model Shows further information about the disk. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
Capacity only. If you need to change this, please add the sensor anew.

Unit

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1212 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
138 SNMP QNAP Physical Disk Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

13.06.2013 1213
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
138 SNMP QNAP Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1214 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
138 SNMP QNAP Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

13.06.2013 1215
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
138 SNMP QNAP Physical Disk Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1216 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
139 SNMP QNAP System Health Sensor

6.8.139 SNM P QNAP Sy stem Health Sensor

The SNMP QNAP System Health sensor monitors the system health of a QNAP Network
Attached Storage (NAS) via Simple Network Management Protocol (SNMP). It can show the
usage of the CPU, available memory in absolute numbers and percent, the temperature of CPU
and system, as well as various other values, for example, revolutions of fans per minute,
depending on the available measurement components.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the system health of a QNAP NAS, please specify the unit of the
temperature measurement.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

QNAP NAS Set t ings

Unit Select the unit of the temperature measurement. Choose between


Celsius and Fahrenheit .

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

13.06.2013 1217
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
139 SNMP QNAP System Health Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

QNAP NAS Set t ings

Unit Shows the unit of temperatures as monitored with this sensor.


Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1218 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
139 SNMP QNAP System Health Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

13.06.2013 1219
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
139 SNMP QNAP System Health Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1220 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
139 SNMP QNAP System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

13.06.2013 1221
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
140 SNMP RMON Sensor

6.8.140 SNM P RM ON Sensor

The SNMP RMON sensor monitors traffic on a device using the Remote Monitoring (RMON)
standard via Simple Network Management Protocol (SNMP). It can be created on an SNMP
compatible device which provides traffic data via RMON. Depending on the data returned by
your device, traffic data for each port can be displayed in different channels, allowing detailed
analysis.

For example, available channels for each traffic port may include Transmitted kbit/s, Packets (#/
s), Broadcast Packets (#/s), Multicast Packets (#/s), CRC Errors (#/s), Undersize Packets (#/s),
Oversize Packets (#/s), Fragments (#/s), Jabbers (#/s), Collisions (#/s), Packets <= 64 Byte (#/
s), Packets 65 - 127 Bytes (#/s), Packets 128 - 255 Bytes (#/s), Packets 256 - 511 Bytes (#/s),
Packets 512 - 1023 Bytes (#/s), Packets 1024 - 1518 Bytes (#/s), and Drop Events (#/s).

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For SNMP devices with multiple interfaces multiple sensors are created at once in the Add
Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

RMON Specific

Ports Select the ports you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.
In the In Use column you will see a Yes if there was already traffic
detected on this interface in the past, and a No if there wasn't any
traffic yet on this interface (since last device restart, usually). The In
Use column does not show whether or not an interface is currently
connected!

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

1222 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
140 SNMP RMON Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

RMON Specific

Port Shows the number of the interface port in your physical device that
this sensor is monitoring. Once a sensor is created this value
cannot be changed. It is shown for reference purposes only. If you
need to change this, please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

14.01.2014 1223
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
140 SNMP RMON Sensor

Sensor Display

§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1224 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
140 SNMP RMON Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

14.01.2014 1225
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
140 SNMP RMON Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1226 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
140 SNMP RMON Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 1227
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
141 SNMP SonicWALL System Health Sensor

6.8.141 SNM P SonicWALL Sy stem Health Sensor

The SNMP SonicWALL System Health sensor monitors health values of a Dell SonicWALL
Network Security Appliance (NSA) via Simple Network Management Protocol (SNMP). It shows
usage of CPU and memory, as well as usage of the connection cache.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol

1228 15.08.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
141 SNMP SonicWALL System Health Sensor

Sensor Display

of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

15.08.2013 1229
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
141 SNMP SonicWALL System Health Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1230 15.08.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
141 SNMP SonicWALL System Health Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

15.08.2013 1231
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
141 SNMP SonicWALL System Health Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1232 15.08.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
142 SNMP SonicWALL VPN Traffic Sensor

6.8.142 SNM P SonicWALL VPN Traffic Sensor

The SNMP SonicWALL VPN Traffic sensor monitors the traffic of an Internet Protocol Security
(IPsec) Virtual Private Network (VPN) on a Dell SonicWALL Network Security Appliance (NSA) via
Simple Network Management Protocol (SNMP). It can show the number of encrypted and
decrypted packets, the number of bytes of encrypted and decrypted transmissions, as well as
the number of in- and outgoing fragmented packets.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the traffic of a SonicWALL VPN, PRTG will create one sensor for each
connection you choose. The settings you make in this dialog are valid for all of the sensors
that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SonicWALL VPN Specific

Connections Select the connections you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Identification Method Select the criteria PRTG will use to identify the connection. PRTG
will always use the first connection found that matches all criteria.
Choose between:
§ By Index: Every connection has a unique index. This is the safest
method to identify your connection. Though, if the connection is
lost and reconnected, a new index will be assigned.
§ By Remot e IP: If the target of the VPN has always the same IP,
you can use this IP to identify the connection.
§ By Securit y Policy Name: If you use a different Security Policy
for every VPN, you can use its name to identify the connection.
§ By Remot e IP and Securit y Policy Name: You can also combine
both identification methods.

Sensor Settings

08.10.2013 1233
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
142 SNMP SonicWALL VPN Traffic Sensor

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SonicWALL VPN Specific

Security Policy Shows further information about the monitored connection. Once
a sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
Remote IP
the sensor anew.

Index

Identification Method

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1234 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
142 SNMP SonicWALL VPN Traffic Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

08.10.2013 1235
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
142 SNMP SonicWALL VPN Traffic Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1236 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
142 SNMP SonicWALL VPN Traffic Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

08.10.2013 1237
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
142 SNMP SonicWALL VPN Traffic Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1238 08.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
143 SNMP Synology Logical Disk Sensor

6.8.143 SNM P Sy nology Logical Disk Sensor

The SNMP Synology Logical Disk sensor monitors a logical disk in a Synology Network
Attached Storage (NAS) via Simple Network Management Protocol (SNMP). It can show the
status of a volume.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the logical disks in a Synology NAS, PRTG will create one sensor for each
disk you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sy nology NAS Set t ings

Disk Select the logical disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

13.06.2013 1239
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
143 SNMP Synology Logical Disk Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sy nology NAS Set t ings

Disk
Shows further information about the disk. Once a sensor is created
Name this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1240 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
143 SNMP Synology Logical Disk Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

13.06.2013 1241
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
143 SNMP Synology Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1242 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
143 SNMP Synology Logical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

13.06.2013 1243
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
144 SNMP Synology Physical Disk Sensor

6.8.144 SNM P Sy nology Phy sical Disk Sensor

The SNMP Physical Disk sensor monitors a physical disk in a Synology Network Attached
Storage (NAS) via Simple Network Management Protocol (SNMP). It can show temperature and
disk status.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the physical disks in a Synology NAS, PRTG will create one sensor for each
disk you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sy nology NAS Set t ings

Disk Select the physical disks you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1244 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
144 SNMP Synology Physical Disk Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sy nology NAS Set t ings

Disk

Name
Shows further information about the disk. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
Model only. If you need to change this, please add the sensor anew.

Type

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

13.06.2013 1245
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
144 SNMP Synology Physical Disk Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1246 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
144 SNMP Synology Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

13.06.2013 1247
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
144 SNMP Synology Physical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1248 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
145 SNMP Synology System Health Sensor

6.8.145 SNM P Sy nology Sy stem Health Sensor

The SNMP Synology System Health sensor monitors the system health of a Synology Network
Attached Storage (NAS) via Simple Network Management Protocol (SNMP). It can show
temperature, system status, power status, fan status, as well as several other values,
depending on the available measurement components.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the system health of a Synology NAS, please specify the unit of the
temperature measurement.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sy nology NAS Set t ings

Unit Select the unit of the temperature measurement. Choose between


Celsius and Fahrenheit .

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

13.06.2013 1249
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
145 SNMP Synology System Health Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sy nology NAS Set t ings

Unit Shows the unit of temperatures as monitored with this sensor.


Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1250 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
145 SNMP Synology System Health Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

13.06.2013 1251
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
145 SNMP Synology System Health Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1252 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
145 SNMP Synology System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

13.06.2013 1253
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
146 SNMP System Uptime Sensor

6.8.146 SNM P Sy stem Uptime Sensor

The SNMP System Uptime sensor monitors the time a device is running via Simple Network
Management Protocol (SNMP). It reads the device's value for system uptime and shows it.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

1254 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
146 SNMP System Uptime Sensor

Sensor Display

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

03.04.2014 1255
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
146 SNMP System Uptime Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1256 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
146 SNMP System Uptime Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

03.04.2014 1257
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
146 SNMP System Uptime Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1258 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

6.8.147 SNM P Traffic Sensor

The SNMP Traffic sensor monitors traffic on a device using Simple Network Management
Protocol (SNMP). It can be created on a device which provides traffic data. For each individual
port one traffic sensor is created. It can show traffic in, traffic out, and traffic total. Additional
channels can be added.

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For SNMP devices with multiple interfaces multiple sensors are created at once in the Add
Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Traffic Specific

Interface Number Select the interfaces you want to add a sensor for. A list of SNMP
device interfaces is shown; containing all interfaces which your
device provides. Connected interfaces are printed in bold face; not
connected in non-bold face. One sensor will be created for each
interface. You can group-select and -unselect interfaces by using
the buttons Select all connect ed int erfaces, Select all
disconnect ed int erfaces, and Deselect all int erfaces. You can
also select and deselect all items by using the check box in the
table head.

Description IN For the standard channel "Traffic In" enter the description here. It
will be shown in graphs and tables. You can change this description
and the description of all other channels in the sensor's channel
settings 1709 later.

Description OUT For the standard channel "Traffic Out" enter the description here. It
will be shown in graphs and tables. You can change this description
and the description of all other channels in the sensor's channel
settings 1709 later.

Description SUM For the standard channel traffic "Sum" enter the description here. It
will be shown in graphs and tables. You can change this description
and the description of all other channels in the sensor's channel
settings 1709 later.

28.05.2014 1259
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1260 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

Traffic Specific

Interface Number Shows the number and name of the interface in your physical
device that this sensor is monitoring. Once a sensor is created this
value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

Additional Channels By default, the channels "Traffic In" and "Traffic out" are created for
each sensor. Choose additional channels for all selected interfaces.
Please click on the respective channel name(s); a check mark
symbol will appear in front of them. You can choose from the
following additional channels:
§ Errors In & Out
§ Discards In & Out
§ Unicast Packet s In & Out
§ Non Unicast Packet s In & Out (32-bit only )
§ Mult icast Packet s In & Out (64-bit only )
§ Broadcast Packet s In & Out (64-bit only )
§ Unknown Prot ocols
Channels that are once created cannot be deleted later. They can
be disabled only.

Connection Status Define how PRTG will react when an interface is operational. A
Handling interface which is not operational is, for example, an ethernet port
on a switch with no cable plugged in. This setting is valid for all
interfaces selected above. You can choose between:
§ Show alarm for all "disconnect ed" st at es: The sensor for the
interface will always turn into a red error status for a
disconnected interface. This applies if the ifOperStatus of the
interface is not "up".
§ Show alarm when disconnect ed, but ignore when
deact ivat ed: The sensor will go into an error status for a
disconnected interface only if it is not deliberately deactivated in
the configuration. This applies if the ifOperStatus of the interface
is not "up" and the ifAdminStatus is "up".
§ Ignore all "disconnect ed" st at es: No alarm will be shown in
PRTG; the sensor status remains green and monitoring will be
discontinued without notice.

28.05.2014 1261
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

1262 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

28.05.2014 1263
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1264 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

28.05.2014 1265
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
147 SNMP Traffic Sensor

More

Knowledge Base: How do PRTG's automatic port name and number updates work for SNMP
traffic sensors?
§ http://kb.paessler.com/en/topic/25893

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1266 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

6.8.148 SNM P Trap Receiver Sensor

The SNMP Trap Receiver sensor receives and analyzes Simple Network Management Protocol
(SNMP) traps. It shows the overall number of received traps per second, warning and error
traps per second, as well as the number of dropped packets per second.

With the available filter options, you can define individually which types of messages will be
considered for monitoring, and which messages will be recognized as warning or error
messages. Depending on the filters, received messages will be counted in the respective
channels.

You can add the sensor to the probe device on the one hand; then the sensor will receive all
messages of the system running the probe. Alternatively, you can add the sensor to a specific
device to gain all messages from this device directly; this will make this sensor type faster than
just using source filters.

Note: You can copy the Management Information Base (MIB) file for your traps into the \MIB
subfolder of your PRTG installation 2074 . PRTG will then be able to translate the OIDs for the
traps into readable messages. For example, instead of the Object Identifier (OID)
1.3.6.1.4.1.32446.1.1.2 you would see SNMPv2-SMI-v1::enterprises.32446.1.1.2 = 0 (example
from the PRTG MIB).

You can use trap specific placeholders in notification templates in order to see the messages
when you receive a notification. See the More 1274 section below for more information.

For a general introduction to the SNMP trap receiver's configuration, please see section
Monit oring Sy slogs and SNMP Traps 1989 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be

28.05.2014 1267
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

Basic Sensor Set t ings

shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SNMP Trap Specific

Listen on Port Enter the port the sensor will listen on for SNMP traps. Usually port
162 is used. Please enter an integer value. We recommend using
the default value.

Purge Messages After Define how long received trap messages will be stored for analysis.
Choose a period of time from the drop down list.

Filt er

Include Filter Define if you want to filter traps. If you leave this field empty or use
the keyword "any", all data will be processed. To include specific
types of traps only, define filters using a special syntax. For more
information, see section Filt er Rules 1273 .

Exclude Filter Define which types of traps will be discarded and not processed.
To exclude specific types of traps, define filters using a special
syntax. For more information, see section Filt er Rules 1273 .

Warning Filter Define which types of traps will count for the Warnings channel. To
categorize received traps as warning messages, define filters using
a special syntax. For more information, see section Filt er Rules 1273 .

1268 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

Filt er

Note: Messages are collected until a scanning interval ends; as long


as the scanning interval is running, no status change will happen.
By default, the sensor will turn into a Warning status after a
scanning interval has finished and there was at least one warning
message (and no error message) during this interval. The status will
remain Warning at least until the succeeding scanning interval has
finished. If in this scanning interval no warning or error message
occurred, the status of the sensor will turn Up again after the
interval.

Error Filter Define which types of traps will count for the Errors channel. To
categorize received traps as error messages, define filters using a
special syntax. For more information, see section Filt er Rules 1273 .
Note: Messages are collected until a scanning interval ends; as long
as the scanning interval is running, no status change will happen.
By default, the sensor will turn into a Down status after a scanning
interval has finished and there was at least one error message
during this interval. The status will remain Down at least until the
succeeding scanning interval has finished. If in this scanning interval
no warning or error message occurred, the status of the sensor
will turn Up again after the interval.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

28.05.2014 1269
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1270 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 1271
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1272 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

Debugging

Log Data to Disk Define if the probe will write a log file of the received data to the
data folder (see Dat a St orage 2074 ) to the disk for debugging
purposes. Choose between:
§ Off (recommended): Do not write additional log files.
Recommended for normal use cases.
§ On: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Filter Rules for Traps

Filter rules are used for the include, exclude, warning, and error definition fields of the Trap
Receiver sensor. They are based on the following format:
field[filter]

You can use various filters suitable to your needs. Include and exclude filters define which
traps will be monitored; warning and error filters define how received traps will be categorized.
Provide these filters in the sensor settings as formulas. Formulas are fields which can be
combined with boolean operators (AND, OR, NOT) and brackets.

Field Paramet er Examples

source[ip] Enter an IP address where the UDPs come from; IP source[10.0.23.50],


masks and ranges 2038 are also possible. source[10.0.23.10-50],
source[10.0.23.10/255]
agent [ip] Enter an IP address which specifies the object that agent[10.0.0.1]
creates the SNMP trap. Only v1 is supported.
ent erprise Enter an OID which specifies the object that enterprise
[oid] originates the trap. Only v1 is supported. [1.3.6.1.4.1.2.6.182.1.2.3
1.1.0]
bindings Enter a substring to match all OIDs and values in the bindings[ERROR],
[text] bindings. bindings
[1.3.6.1.4.1.2.6.182.1.2.3
1.1.0]
bindings Enter an OID and a substring to match a value in the bindings
[oid,value] given OID. Separate OID and value with a comma. [1.3.6.1.4.1.2.6.182.1.2.3
1.1.0,error]
gent rap Enter a number which specifies the generic trap gentrap[3], gentrap[2-6]
[number] type. Ranges are also possible.

28.05.2014 1273
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

spect rap Enter a number which defines the specific trap spectrap[4], spectrap[0-3]
[number] code. Ranges are also possible.
version Enter a number (1 or 2) which specifies the SNMP version[1], version[2]
[number] version.
communit y Enter a community string for exact, case sensitive community[public],
[text] match. community[private]

Messages Tab: Review and Analyze Traps

Received traps are stored as common files in PRTG's data folder (see section Dat a St orage 2074
). In order to review and analyze all received messages, you can access the most recent data
directly in PRTG's web interface via the respective sensors on the Overview tab in a table list
156 . Note: Received traps are only shown after an (automatic) page refresh following to a

sensor scan in the table on the Overview tab (default for auto refresh 1812 is 30 seconds).

For more details and further filter options, click on the Messages tab of the SNMP Trap
Receiver sensor. You will see all received messages in a table list 156 . On the top, you have
display filter options to drill down into the data for specific events of your interest. The filters
are the same as available in the sensor settings, but you can define them without using
formulas. Provide the desired parameters and PRTG will load the filtered list automatically.

Advanced Filt er Set t ings

You can open advanced filter settings with a click on the gear icon in the Filt er row. The
Advanced Filt er will appear in a popup window. In the text field, you can define a filter using
the syntax as given in section Filt er Rules for Traps 1273 . If you have provided filter parameters
on the Messages tab, these will be already included in the advanced filter as a corresponding
formula with the correct syntax. You can adjust this filter to your needs. You can also copy the
automatically created and manually adjusted formula for usage in the filter fields of the sensor
settings.

More

Blog Article: Introducing the New High Performance Syslog and SNMP Trap Receiver Sensors
§ http://www.paessler.com/blog/2013/10/11/prtg/introducing-the-new-high-performance-
syslog-and-snmp-trap-receiver-sensors

Knowledge Base: How do I test an SNMP Trap Receiver Sensor?


§ http://kb.paessler.com/en/topic/10193

Knowledge Base: What placeholders can I use with PRTG?


§ http://kb.paessler.com/en/topic/373

1274 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
148 SNMP Trap Receiver Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1275
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
149 SNMP Windows Service Sensor

6.8.149 SNM P Windows Service Sensor

The SNMP Windows Service sensor monitors a Windows service via Simple Network
Management Protocol (SNMP). It shows the operating status of the monitored service.
Operating states can be Active (sensor status Up), or Continue-Pending, Pause-Pending, and
Paused (all with sensor status Down).

Note: This sensor type cannot distinguish the status "not installed" from "not running".

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For a general introduction to the technology behind SNMP, please see Monit oring via SNMP
1955 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor services on Windows, PRTG will create one sensor for each service you
select. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SNMP Windows Service Monit or

Service Select the services you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be

1276 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
149 SNMP Windows Service Sensor

Basic Sensor Set t ings

shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SNMP Windows Service Monit or

Service Shows the service monitored by this sensor. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

14.01.2014 1277
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
149 SNMP Windows Service Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1278 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
149 SNMP Windows Service Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 1279
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
149 SNMP Windows Service Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1280 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
150 SNTP Sensor

6.8.150 SNTP Sensor

The SNTP Sensor monitors a Simple Network Time Protocol (SNTP) server. It returns the
response time and the time difference in comparison to the local system time.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Timeout (Sec.) Enter a timeout in seconds. If the reply takes longer than this value
the request is aborted and an error message is triggered. The
maximum timeout value is 900 seconds (equals 15 minutes).

03.04.2014 1281
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
150 SNTP Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1282 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
150 SNTP Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

03.04.2014 1283
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
150 SNTP Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1284 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
150 SNTP Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

03.04.2014 1285
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

6.8.151 SSH Disk Free Sensor

The SSH Disk Free sensor monitors free space on disks of a Linux/Unix system using Secure
Shell (SSH). It shows the total free disk space (sum), and the free disk space in percent for
every mounted partition (volume).

Note: The free space returned by this sensor type shows the available disk space of the
volume, minus a reserve defined for this volume (e.g. for redundancy purposes). So, this
sensor shows the disk space that is actually available for use. The size of the reserved disk
space can be defined with tune2fs. For details, please see the article linked in the More 1293
section below.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

1286 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

28.05.2014 1287
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

Set limit s checked against ALL disks

In this section you can set limits that are valid for all channels and all drives. By entering
limits, you can define when the sensor will enter a Warning or Down status; depending on
the data provided by all drives that this sensor monitors. If you want to define limits for
separate channels individually please use the limit settings in the sensor's Channels settings.
Note: All limits defined here are valid additionally to the limits defined in the particular
Channels settings!

Percentage Limit Check Enable or disable a limit check for the free space in percentage
channels of all drives. By default percentage limits are enabled with
lower warning and lower error limit. Choose between:
· Disable Percent age Limit s: Do not use the drives' data to
control the sensor's status.
· Enable Percent age Limit s: Define limits. Additional fields appear
below. The sensor will enter a warning or down state when free
space limits are undercut or overrun.

Upper Error Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Down status. If the free disk
space of one of your drives overruns this percent value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Warning status. If the free
disk space of one of your drives overruns this percent value, the
sensor will be set to Warning. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for a warning state. If the free disk
space of one of your drives undercuts this percent value, the
sensor will be set to warning. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

1288 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

Set limit s checked against ALL disks

Lower Error Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for entering a Down status. If the
free disk space of one of your drives undercuts this percent value,
the sensor will be set to Down. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Byte Limit Check Enable or disable a limit check for the free bytes channels of all
drives. Choose between:
· Disable By t e Limit s: Do not use the drives' data to control the
sensor's status.
· Enable By t e Limit s: Define limits. Additional fields appear below.
The sensor will enter a warning or down state when free space
limits are undercut or overrun.

Upper Error Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives overruns this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives overruns this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives undercuts this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

28.05.2014 1289
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

Set limit s checked against ALL disks

Lower Error Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives undercuts this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Alarm on Missing/ If a monitored disk is removed or not found, values are set to zero.
Removed Disk Select the alarming approach in this case. Choose between:
§ Deact ivat e alarm (default ): Select this option if you do not
want an alarm for a removed disk.
§ Act ivat e Alarm: Select this option if you want to be alerted if a
monitored disk is removed.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1290 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

28.05.2014 1291
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1292 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How and Where Does PRTG Store its Data?

28.05.2014 1293
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
151 SSH Disk Free Sensor

§ http://kb.paessler.com/en/topic/463

Knowledge Base: Why do SSH Disk Free and SNMP Linux Disk Free show different values for
my target Linux system?
§ http://kb.paessler.com/en/topic/43183

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1294 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
152 SSH INodes Free Sensor

6.8.152 SSH INodes Free Sensor

The SSH INodes Free sensor monitors the free index nodes on disks of Linux/Unix and Mac OS
systems via Secure Shell (SSH). It shows the free index nodes in percent, for each mount in an
own sensor channel.

UNIX file systems only allow a limited number of index nodes. If the limit is exceeded, no more
data can be stored, although there might be still free space available. This sensor can help you
to notice early on if one of your drives is running out of INodes.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

03.04.2014 1295
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
152 SSH INodes Free Sensor

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1296 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
152 SSH INodes Free Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

03.04.2014 1297
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
152 SSH INodes Free Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1298 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
152 SSH INodes Free Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

03.04.2014 1299
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
152 SSH INodes Free Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1300 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
153 SSH Load Average Sensor

6.8.153 SSH Load Average Sensor

The SSH Load Average sensor monitors the load average of a Linux/Unix system using Secure
Shell (SSH). It shows the average system load within a one, five, and 15 minutes interval (each
in one channel).

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

27.11.2012 1301
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
153 SSH Load Average Sensor

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1302 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
153 SSH Load Average Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

27.11.2012 1303
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
153 SSH Load Average Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1304 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
153 SSH Load Average Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

27.11.2012 1305
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
153 SSH Load Average Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1306 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
154 SSH Meminfo Sensor

6.8.154 SSH M eminfo Sensor

The SSH Meminfo sensor monitors the memory usage of a Linux/Unix system using Secure
Shell (SSH). It shows the available memory in total and in percent. Note: This sensor type is not
compatible with Mac OS systems.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

27.11.2012 1307
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
154 SSH Meminfo Sensor

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1308 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
154 SSH Meminfo Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

27.11.2012 1309
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
154 SSH Meminfo Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1310 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
154 SSH Meminfo Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

27.11.2012 1311
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
154 SSH Meminfo Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1312 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
155 SSH Remote Ping Sensor

6.8.155 SSH Remote Ping Sensor

The SSH Remote Ping sensor remotely monitors the connectivity between a system running
Linux/OS X and an other device, using Internet Control Message Protocol (ICMP) echo
requests ("Ping") and Secure Shell (SSH). It can show packet loss, as well as minimum, maximum,
and average response times; all measured from the remote device you connect to.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

27.11.2012 1313
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
155 SSH Remote Ping Sensor

SSH Remot e Ping Configurat ion

Target Enter the DNS name or IP address of the target device the Ping is
sent to. The sensor will remotely connect to the parent device it is
created on via SSH, then perform a Ping request from this remote
device to the target device/server. Please enter a string.

Packet Size (Bytes) Enter the packet size in bytes for the Ping. You can choose any
value between 1 and 10000. Please enter an integer value. We
recommend using the default value.

Packet Count Enter the number of packets that is sent with each scanning
interval.

Custom Parameter Optionally enter additional parameters that will be added at the end
of the ping command. Please do not use parameters that change
the output format of the result to make sure it can still be parsed.
You cannot enter another command here. Please enter a string or
leave the field empty.

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.

1314 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
155 SSH Remote Ping Sensor

SSH Specific

§ Writ e sensor result t o disk (Filename: "Result of Sensor


[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

27.11.2012 1315
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
155 SSH Remote Ping Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

1316 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
155 SSH Remote Ping Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

27.11.2012 1317
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
155 SSH Remote Ping Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

1318 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
155 SSH Remote Ping Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 1319
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
156 SSH SAN Logical Disk Sensor

6.8.156 SSH SAN Logical Disk Sensor

The SSH SAN Logical Disk sensor monitors a logical disk on a Storage Area Network (SAN) via
Secure Shell (SSH). The SAN has to provide a command-line interface (CLI) for this purpose. The
sensor can show the health status of the disk.

Note: This sensor type does not support every SAN, even if it provides a CLI. The sensor only
works with specific devices, for example, with the HP P2000.

Note: Sometimes the devices which you monitor with this sensor return status values which
are not officially documented so that the shown sensor status in PRTG differs from the "real"
device status. For more information regarding this issue, please see section More below.

For this sensor type, corresponding credentials must be defined in section Credent ials for
Linux/Solaris/Mac OS (SSH/WBEM) Sy st em in the settings of the device 272 you want to use
the sensor on.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor volumes on an SAN device, PRTG will create one sensor for each volume
you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SSH SAN Logical Disk Set t ings

Volume Select the volumes you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

1320 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
156 SSH SAN Logical Disk Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:

12.05.2014 1321
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
156 SSH SAN Logical Disk Sensor

SSH Specific

§ Discard sensor result : Do not store the sensor result.


§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

SSH SAN Logical Disk Set t ings

Volume Shows the volume that this sensor monitors. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Size Shows the size of the volume that this sensor monitors. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1322 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
156 SSH SAN Logical Disk Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

12.05.2014 1323
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
156 SSH SAN Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1324 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
156 SSH SAN Logical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Why does my SSH SAN sensor show a wrong status?

12.05.2014 1325
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
156 SSH SAN Logical Disk Sensor

§ http://kb.paessler.com/en/topic/60145

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1326 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
157 SSH SAN Physical Disk Sensor

6.8.157 SSH SAN Phy sical Disk Sensor

The SSH SAN Physical Disk sensor monitors a physical disk on a Storage Area Network (SAN)
via Secure Shell (SSH). The SAN has to provide a command-line interface (CLI) for this purpose.
The sensor can show the health status of the disk, the total number of I/O operations, as well
as the amount of transferred data.

Note: This sensor type does not support every SAN, even if it provides a CLI. The sensor only
works with specific devices, for example, with the HP P2000.

Note: Sometimes the devices which you monitor with this sensor return status values which
are not officially documented so that the shown sensor status in PRTG differs from the "real"
device status. For more information regarding this issue, please see section More below.

For this sensor type, corresponding credentials must be defined in section Credent ials for
Linux/Solaris/Mac OS (SSH/WBEM) Sy st em in the settings of the device 272 you want to use
the sensor on.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor disks on an SAN device, PRTG will create one sensor for each disk you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SSH SAN Phy sical Disk Set t ings

Disk Select the disks you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

12.05.2014 1327
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
157 SSH SAN Physical Disk Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:

1328 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
157 SSH SAN Physical Disk Sensor

SSH Specific

§ Discard sensor result : Do not store the sensor result.


§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

SSH SAN Phy sical Disk Set t ings

Disk Shows the disk that this sensor monitors. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Disk Name Shows the label of disk that this sensor monitors. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Size Shows the size of the disk that this sensor monitors. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

12.05.2014 1329
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
157 SSH SAN Physical Disk Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1330 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
157 SSH SAN Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 1331
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
157 SSH SAN Physical Disk Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Why does my SSH SAN sensor show a wrong status?

1332 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
157 SSH SAN Physical Disk Sensor

§ http://kb.paessler.com/en/topic/60145

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1333
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
158 SSH SAN System Health Sensor

6.8.158 SSH SAN Sy stem Health Sensor

The SSH SAN System Health sensor monitors the system health of a Storage Area Network
(SAN) via Secure Shell (SSH). The SAN has to provide a command-line interface (CLI) for this
purpose. The sensor can show several metrics of the SAN, such as temperatures, voltages, the
overall unit status, as well as capacitor charge. Which monitoring data this sensor type can
show depends on the available measurement components on the SAN.

Note: This sensor type does not support every SAN, even if it provides a CLI. The sensor only
works with specific devices, for example, with the HP P2000.

Note: Sometimes the devices which you monitor with this sensor return status values which
are not officially documented so that the shown sensor status in PRTG differs from the "real"
device status. For more information regarding this issue, please see section More below.

For this sensor type, corresponding credentials must be defined in section Credent ials for
Linux/Solaris/Mac OS (SSH/WBEM) Sy st em in the settings of the device 272 you want to use
the sensor on.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the system health of an SAN device, PRTG will create one sensor for each
metric you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SSH SAN Specific

Metric Select the metrics you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

1334 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
158 SSH SAN System Health Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SSH SAN Specific

Metric Shows the metric this sensor monitors. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:

12.05.2014 1335
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
158 SSH SAN System Health Sensor

SSH Specific

§ Inherit port number from parent device (default ): Use the


port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1336 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
158 SSH SAN System Health Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

12.05.2014 1337
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
158 SSH SAN System Health Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1338 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
158 SSH SAN System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Why does my SSH SAN sensor show a wrong status?

12.05.2014 1339
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
158 SSH SAN System Health Sensor

§ http://kb.paessler.com/en/topic/60145

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1340 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

6.8.159 SSH Script Sensor

The SSH Script sensor connects to a Linux/Unix system via Secure Shell (SSH) and executes a
script file located on the target system. The sensor shows the execution time, and can show
one value returned by the executable file or script (in one channel only). For details about the
return value format please see the Applicat ion Programming Int erface (API) Definit ion 2031 .

Note: For security reasons, the script file must be stored on the target system. Please make
sure the script has executable rights.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

28.05.2014 1341
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Sensor Set t ings

Script Select a script file from the list. The drop down menu will list all
script files available in the /var/prtg/scripts directory on the target
Linux/Unix system. In order for the files to appear in this list, please
store them into this directory. Please make sure the script has
executable rights. In order for the sensor to show the expected
values and sensor status, your files must use the right format for
the returned values (in this case, exitcode:value:message to
stdout). The exitcode will determine the sensor status. For detailed
information on the expected return format and on how to build
custom sensors, please see the API documentation (Applicat ion
Programming Int erface (API) Definit ion 2031 ). There, find detailed
information the the "Custom Sensors" tab. For an example script,
please see More 1348 section below.

Value Type Define what kind of values your script file gives back. Choose
between:
§ Int eger: An integer is expected as return value. If the script gives
back a float, PRTG will display the value 0.
§ Float : A float is expected as return value, with a dot (.) between
pre-decimal position and decimal places. In this setting, the
sensor will also display integer values unless they don't produce
a buffer overflow.
§ Count er: Your script returns an integer which increases. PRTG
will show the difference between the values of two sensor
scans. Note: A counter must return an integer; float is not
supported here!

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1342 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Script Shows the script that is executed with each sensor scan, as
defined on sensor creation. Once a sensor is created this value
cannot be changed. It is shown for reference purposes only. If you
need to change this, please add the sensor anew.

Parameters If your script file catches command line parameters, you can define
them here. Placeholders can be used as well. For a full list of all
placeholders please see the API documentation (Applicat ion
Programming Int erface (API) Definit ion 2031 ). Note: Please make
sure you write the placeholders in quotes to ensure that they are
working properly if their values contain blanks. Use single
quotation marks ' ' with PowerShell scripts, and double quotes " "
with all others. Please enter a string or leave the field empty.

Mutex Name Define any desired mutex name for the process. All EXE/Script
sensors having the same mutex name will be executed serially (not
simultaneously). This is useful if you use a lot of sensors and want
to avoid high resource usage caused by processes running
simultaneously. For links to more information, please see the More
438 section below. Please enter a string or leave the field empty.

Value Type Shows the expected value type, chosen on sensor creation. Once
a sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew. Note: The sensor cannot handle string values.

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.

28.05.2014 1343
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Sensor Set t ings

· Trigger 'On Change' not ificat ion: The sensor will send an
internal message indicating that its value has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the sensor value changes.

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

1344 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 1345
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1346 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 1347
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Is there a shell script example for PRTG's SSH Script Sensor?
§ http://kb.paessler.com/en/topic/39513

Information about custom scripts and executables


§ Applicat ion Programming Int erface (API) Definit ion 2031

§ Addit ional Sensor Ty pes (Cust om Sensors) 1706

Knowledge Base: What is the Mutex Name in PRTG's EXE/Script Sensor's settings?
§ http://kb.paessler.com/en/topic/6673

Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Knowledge Base: How can I test if parameters are correctly transmitted to my script when
using an EXE/Script sensor?
§ http://kb.paessler.com/en/topic/11283

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

1348 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
159 SSH Script Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1349
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

6.8.160 SSH Script Advanced Sensor

The SSH Script Advanced sensor connects to a Linux/Unix system via Secure Shell (SSH) and
executes a script file located on the target system. The sensor can show values returned by
the script in multiple channels. The return value of this sensor must be valid XML. For details
about the return value format please see the Applicat ion Programming Int erface (API)
Definit ion 2031 .

Note: For security reasons, the script file must be stored on the target system. Please make
sure the script has executable rights.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used
with this sensor type, you might exceed the maximum number of supported sensor channels.
In this case, PRTG will try to display all sensor channels. However, please be aware that you will
experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

1350 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

Sensor Set t ings

Script Select a script file from the list. The drop down menu will list all
script files available in the /var/prtg/scriptsxml directory on the
target Linux/Unix system. In order for the files to appear in this list,
please store them into this directory. Please make sure the script
has executable rights. In order for the sensor to show the
expected values and sensor status, your files must return the
expected XML format to standard output. Values and message
must be embedded in the XML. For detailed information on the
expected return format and on how to build custom sensors,
please see the API documentation (Applicat ion Programming
Int erface (API) Definit ion 2031 ). There, find detailed information the
the "Custom Sensors" tab.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Script Shows the script that is executed with each sensor scan, as
defined on sensor creation. Once a sensor is created this value
cannot be changed. It is shown for reference purposes only. If you
need to change this, please add the sensor anew.

12.05.2014 1351
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

Sensor Set t ings

Parameters If your script file catches command line parameters, you can define
them here. Placeholders can be used as well. For a full list of all
placeholders please see the API documentation (Applicat ion
Programming Int erface (API) Definit ion 2031 ). Note: Please make
sure you write the placeholders in quotes to ensure that they are
working properly if their values contain blanks. Use single
quotation marks ' ' with PowerShell scripts, and double quotes " "
with all others. Please enter a string or leave the field empty.

Mutex Name Define any desired mutex name for the process. All EXE/Script
sensors having the same mutex name will be executed serially (not
simultaneously). This is useful if you use a lot of sensors and want
to avoid high resource usage caused by processes running
simultaneously. For links to more information, please see the More
438 section below. Please enter a string or leave the field empty.

EXE Result Define what will be done with the results the executable file gives
back. Choose between:
· Discard EX E result : Do not store the requested web page.
· Writ e EX E result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the script to the
"Logs (Sensors)" directory (on the Master node, if in a cluster).
This is for debugging purposes. The file will be overridden with
each scanning interval. For information on how to find the folder
used for storage, please see Dat a St orage 2074 section.

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

1352 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

SSH Specific

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

12.05.2014 1353
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1354 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 1355
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Information about custom scripts and executables

1356 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
160 SSH Script Advanced Sensor

§ Applicat ion Programming Int erface (API) Definit ion 2031

§ Addit ional Sensor Ty pes (Cust om Sensors) 1706

Knowledge Base: What is the Mutex Name in PRTG's EXE/Script Sensor's settings?
§ http://kb.paessler.com/en/topic/6673

Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Knowledge Base: How can I test if parameters are correctly transmitted to my script when
using an EXE/Script sensor?
§ http://kb.paessler.com/en/topic/11283

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1357
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
161 SSH VMWare ESX(i) Disk Sensor

6.8.161 SSH VM Ware ESX(i) Disk Sensor

The SSH VMWare ESX(i) Disk sensor monitors free space on disks of a VMware ESX(i) system
using Secure Shell (SSH). It shows the free disk space for different mounts and total, in total
and percent values.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: Not all Linux/Unix and Mac OS distributions can be supported by this sensor type.

For a general introduction to SSH monitoring, please see Monit oring via SSH 1962 section.

Requirement: Root Credentials

In the parent device's Credent ials for Linux/Solaris/Mac OS (SSH/WBEM) Sy st ems settings,
please use the root user of your VMware host for authentication! See More 1363 section below.

Please make sure you enable SSH on your VMware system!

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

1358 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
161 SSH VMWare ESX(i) Disk Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SSH Specific

Connection Timeout Define a timeout for the connection. This is the the time the sensor
(Sec.) waits to establish a connection to the host. You should keep this
value as low as possible.

Shell Timeout (Sec.) Define a timeout for the shell response. This is the time in seconds
the sensor waits for the shell to return a response after it has sent
its specific command (e.g. cat /proc/loadavg).

SSH Port Define which port this sensor will use for the SSH connection.
Choose between:
§ Inherit port number from parent device (default ): Use the
port number as defined in the Credentials for Linux/Solaris/Mac
OS (SSH/WBEM) Systems section of the device this sensor is
created on.
§ Ent er cust om port number: Do not use the port number from
the parent device's settings, but define a different port number
below.

Use Port Number This field is only visible if the custom port number setting is enabled
above. Enter the port number this sensor will use for the SSH
connection. Please enter an integer value.

Result Handling Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

28.05.2014 1359
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
161 SSH VMWare ESX(i) Disk Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1360 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
161 SSH VMWare ESX(i) Disk Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

28.05.2014 1361
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
161 SSH VMWare ESX(i) Disk Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1362 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
161 SSH VMWare ESX(i) Disk Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: How and Where Does PRTG Store its Data?
§ http://kb.paessler.com/en/topic/463

Knowledge Base: Settings on ESXi 5 host when monitoring via SSH VMware ESX(i) Disk Sensor
§ http://kb.paessler.com/en/topic/32603
Knowledge Base: Why do I need root credentials when monitoring VMware hosts via SSH?
§ http://kb.paessler.com/en/topic/33763

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1363
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

6.8.162 Sy slog Receiver Sensor

The Syslog Receiver sensor receives and analyzes syslog messages. It shows the overall
number of received syslog messages per second, warning and error messages per second, as
well as the number of dropped packets per second.

With the available filter options, you can define individually which types of messages will be
considered for monitoring and thus stored, and which messages will be recognized as warning
or error messages. Depending on the filters, received messages will be counted in the
respective channels. The messages are stored in an internal database for later analysis. The
received data will be available on your respective probe system as common files, as well as via
the web interface.

You can add the sensor to the probe device on the one hand; then the sensor will receive all
messages of the system running the probe. Alternatively, you can add the sensor to a specific
device to gain all messages from this device directly; this will make this sensor type faster than
just using source filters.

Note: This sensor type cannot be used in cluster mode. You can set it up on a local probe or
remote probe only, not on a cluster probe.

You can use syslog specific placeholders in notification templates in order to see the
messages when you receive a notification. See the More 1372 section below for more
information.

For a general introduction to the syslog receiver's configuration, please see section
Monit oring Sy slogs and SNMP Traps 1989 .

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1364 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sy slog Specific

Listen on Port Enter the port the sensor will listen on for Syslog messages.
Usually port 514 is used. Please enter an integer value. We
recommend using the default value.

Purge Messages After Define how long received syslog messages will be stored for
analysis. Choose a period of time from the drop down list.

Filt er

Include Filter Define if you want to filter syslog messages. If you leave this field
empty or use the keyword "any", all data will be processed. To
include specific types of messages only, define filters using a
special syntax. For more information, see section Filt er Rules 1370 .

Exclude Filter Define which types of syslog messages will be discarded and not
processed. To exclude specific types of messages, define filters
using a special syntax. For more information, see section Filt er
Rules 1370 .

Warning Filter Define which types of syslog messages will count for the Warnings
channel. To categorize received messages as warning messages,
define filters using a special syntax. For more information, see
section Filt er Rules 1370 .

28.05.2014 1365
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

Filt er

Note: Messages are collected until a scanning interval ends; as long


as the scanning interval is running, no status change will happen.
By default, the sensor will turn into a Warning status after a
scanning interval has finished and there was at least one warning
message (and no error message) during this interval. The status will
remain Warning at least until the succeeding scanning interval has
finished. If in this scanning interval no warning or error message
occurred, the status of the sensor will turn Up again after the
interval.

Error Filter Define which types of syslog messages will count for the Errors
channel. To categorize received messages as error messages,
define filters using a special syntax. For more information, see
section Filt er Rules 1370 .
Note: Messages are collected until a scanning interval ends; as long
as the scanning interval is running, no status change will happen.
By default, the sensor will turn into a Down status after a scanning
interval has finished and there was at least one error message
during this interval. The status will remain Down at least until the
succeeding scanning interval has finished. If in this scanning interval
no warning or error message occurred, the status of the sensor
will turn Up again after the interval.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1366 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

28.05.2014 1367
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1368 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

28.05.2014 1369
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

Debugging

Log Data to Disk Define if the probe will write a log file of the received data to the
data folder (see Dat a St orage 2074 ) to the disk for debugging
purposes. Choose between:
§ Off (recommended): Do not write additional log files.
Recommended for normal use cases.
§ On: Write log files for all data received.
Note: Use with caution! When enabled, huge data files can be
created. Please use for a short time and for debugging purposes
only.

Filter Rules for Syslog Messages

Filter rules are used for the include, exclude, warning, and error definition fields of the Syslog
Receiver sensor. They are based on the following format:
field[filter]

You can use various filters suitable to your needs. Include and exclude filters define which
messages will be monitored; warning and error filters define how received messages will be
categorized. Provide these filters in the sensor settings as formulas. Formulas are fields which
can be combined with boolean operators (AND, OR, NOT) and brackets.

Field Paramet er Example

source[ip] the IP address where the messages will be § source[10.0.23.50]


received from; masks and ranges are also
possible § source[10.0.23.10-50]
§ source[10.0.23.10/255]

facilit y any number (or range) from 0 to 23 specifying § facility[2]


[number] the type of program sending the message
§ facility[5-7]
§ facility[5] OR facility[6]

severit y any number (or range) from 0 (emergency) to 7 § severity[4]


[number] (debug) specifying the type of message
§ severity[1-3]
§ severity[1] AND severity
[2]

host name any string specifying the hostname of a device § hostname


[text] in the message [www.example.com]

1370 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

t ag[text] any string specifying the tag of a program or § tag[su]


process in the message
appname any string specifying the appname part of the § appname[myproc]
[text] message
§ appname[demo] AND
msgid[m42]

procid any string specifying the process identifier part § procid[1860]


[text] of the message
msgid[text] any string specifying the message identifier part § msgid[ID47]
of the message
message any string specifying the message part of the § message[Error]
[parttext] message (substring will match; case insensitive!)
dat a checks the SD-ID block of the message's § data
[id structured data for a parameter matching the [exampleSDID@12345,ev
,param,value] given value entSource,Application]

dat a checks if the given substring matches on § data


[parttext] structured data as displayed in the [exampleSDID@1234]
corresponding table
dat a checks if the parameter exists in the given ID § data
[id,param] element [exampleSDID@1234,eve
ntSource]

Note: String parameters (except the substring in message) have to match exactly the particular
parts of the message; they are case sensitive!

Messages Tab: Review and Analyze Syslog Messages

Received syslog messages are stored as common files in PRTG's data folder (see section Dat a
St orage 2074 ). In order to review and analyze all received messages, you can access the most
recent data directly in PRTG's web interface via the Overview tab of the respective sensor in a
table list 156 . Note: Received syslogs are only shown after an (automatic) page refresh
following to a sensor scan in the table on the Overview tab (default for auto refresh 1812 is 30
seconds).

For more details and further filter options, click on the Messages tab of the Syslog Receiver
sensor. You will see all received messages in a table list 156 . On the top, you have display filter
options to drill down into the data for specific events of your interest. The filters are the same
as available in the sensor settings, but you can define them without using formulas. Provide
the desired parameters and PRTG will load the filtered list automatically.

Advanced Filt er Set t ings

28.05.2014 1371
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
162 Syslog Receiver Sensor

You can open advanced filter settings with a click on the gear icon in the Filt er row. The
Advanced Filt er will appear in a popup window. In the text field, you can define a filter using
the syntax as given in section Filt er Rules for Sy slog Messages 1370 . If you have provided filter
parameters on the Messages tab, these will be already included in the advanced filter as a
corresponding formula with the correct syntax. You can adjust this filter to your needs. You
can also copy the automatically created and manually adjusted formula for usage in the filter
fields of the sensor settings.

More

Blog Article: Introducing the New High Performance Syslog and SNMP Trap Receiver Sensors
§ http://www.paessler.com/blog/2013/10/11/prtg/introducing-the-new-high-performance-
syslog-and-snmp-trap-receiver-sensors

Knowledge Base: What placeholders can I use with PRTG?


§ http://kb.paessler.com/en/topic/373

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1372 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
163 System Health Sensor

6.8.163 Sy stem Health Sensor

The System Health sensor monitors internal PRTG parameters. It shows the status of the
system. This sensor type is created automatically by PRTG and cannot be deleted. It checks
various parameters of your PRTG system which can affect the quality of the monitoring results:

§ Healt h: This index value sums up the probe state into a value between 100% (healthy) and
0% (failing). Frequent or repeated health values below 100% should be investigated.
§ Available Memory : This channel shows the amount of free memory available on the system.
This value should not fall below 500 MB. This way PRTG still can request resources during
report generation, auto-discoveries, and other issues.
§ Available Memory Percent : This channel shows the free memory available on the system in
percent.
§ CPU Load: This channel shows the current percentage CPU load. Extensive CPU load can lead
to false, incomplete, and incorrect monitoring results. This value usually should stay below
50%.

This sensor can be set up on a Probe Device only!

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

03.05.2013 1373
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
163 System Health Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

1374 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
163 System Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

03.05.2013 1375
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
163 System Health Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1376 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
164 TFTP Sensor

6.8.164 TFTP Sensor

The TFTP sensor monitors a Trivial File Transfer Protocol (TFTP) server and checks if a certain file
is available for download. It shows the availability.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Specific

Timeout (sec) Enter a timeout in seconds for the TFTP connect. If the reply takes
longer than this value the request is aborted and an error message
is triggered. Please enter an integer value.

Port Enter the number of the port the TFTP service is running on. The
sensor will try to connect to it. Please enter an integer value.

27.11.2012 1377
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
164 TFTP Sensor

Sensor Specific

Filename Enter the name of the file the sensor will check. If this filename is
not available on the server, the sensor's state will be set to down.
Please enter a string.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

1378 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
164 TFTP Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

27.11.2012 1379
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
164 TFTP Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1380 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
164 TFTP Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

27.11.2012 1381
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
164 TFTP Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1382 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
165 Traceroute Hop Count Sensor

6.8.165 Traceroute Hop Count Sensor

The Traceroute Hop Count sensor traces the number of hops needed from the probe system
the sensor is running on to the IP Address/DNS Name defined in the sensor's parent device.
It returns the number of hops. In case this number changes, you can additionally change the
sensor's status.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

12.05.2014 1383
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
165 Traceroute Hop Count Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

If Route Changes Define what will be done in case the route has changed since the
last check. Choose between:
§ Ignore: Do not perform any action.
§ Set sensor t o "Warning": Set the sensor to warning status.
§ Set sensor t o "Error": Set the sensor to error status.

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1384 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
165 Traceroute Hop Count Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

12.05.2014 1385
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
165 Traceroute Hop Count Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1386 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
165 Traceroute Hop Count Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

12.05.2014 1387
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
165 Traceroute Hop Count Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1388 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
166 Virtuozzo Container Disk Sensor

6.8.166 Virtuozzo Container Disk Sensor

server. This sensor must be created on a Windows server parent device running Virtuozzo.
For each container, it can show free disk space in percent, used disk space (kb-blocks),
allowed quota (kb-blocks), and hard limit (kb-blocks).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Cont ainer Set t ings

Container Select all containers for which you want to create a sensor for disk
monitoring. A list of all available items is shown with their name.
Select the desired items by adding check marks in front of the
respective lines. One sensor will be created for each selection. You
can also select and deselect all items by using the check box in the
table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

28.05.2014 1389
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
166 Virtuozzo Container Disk Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Cont ainer Set t ings

Env ID Shows the unique ID of the container. Once a sensor is created


this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Name Shows the name of the monitored container. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

OS Shows the operating system running on the container. Once a


sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Description Shows a description for the container. Once a sensor is created


this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Powered Off Define if the sensor will go into an error state if the container is
Containers powered off.
· Alarm when powered off: Set the sensor for a container to
error if the container is powered off.

· Ignore powered off st at e: Only show zero values for a sensor


when the monitored container is powered off. Do not set the
sensor to error.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

1390 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
166 Virtuozzo Container Disk Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 1391
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
166 Virtuozzo Container Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1392 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
166 Virtuozzo Container Disk Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

28.05.2014 1393
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
166 Virtuozzo Container Disk Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1394 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
167 Virtuozzo Container Network Sensor

6.8.167 Virtuozzo Container Network Sensor

The Virtuozzo Container Network sensor monitors the network traffic of a container on a

device running Virtuozzo. For each container, it can show network usage as incoming and
outgoing bytes as well as its sum, and the number of incoming and outgoing packets.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Cont ainer Set t ings

Container Select all containers for which you want to create a sensor. A list
of all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

28.05.2014 1395
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
167 Virtuozzo Container Network Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Cont ainer Set t ings

Env ID Shows the unique ID of the container. Once a sensor is created


this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Name Shows the name of the monitored container. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

OS Shows the operating system running on the container. Once a


sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Description Shows a description for the container. Once a sensor is created


this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Powered Off Define if the sensor will go into an error state if the container is
Containers powered off.
· Alarm when powered off: Set the sensor for a container to
error if the container is powered off.

· Ignore powered off st at e: Only show zero values for a sensor


when the monitored container is powered off. Do not set the
sensor to error.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

1396 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
167 Virtuozzo Container Network Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Scanning Int erval

Interval The scanning interval of this sensor type cannot be inherited or


changed. Due to internal restrictions of the Virtuozzo system, a fix
value must be used.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

28.05.2014 1397
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
167 Virtuozzo Container Network Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1398 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
167 Virtuozzo Container Network Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

28.05.2014 1399
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
167 Virtuozzo Container Network Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1400 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
168 VMware Host Hardware (WBEM) Sensor

6.8.168 VM ware Host Hardware (WBEM ) Sensor

The VMware Host Hardware sensor monitors hardware information of a ESX/ESXi server using
Web-Based Enterprise Management (WBEM). It shows the current reading and health state.

Note: The parent device must be a VMware ESX/ESXi server version 3.5, 4.0, 5.0, 5.1, or 5.5.
For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one elements multiple sensors are created at once in the Add Sensor
dialog. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

ESX Server Element s

ESX Element Select the hardware elements you want to add a sensor for. A list
of all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

26.09.2013 1401
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
168 VMware Host Hardware (WBEM) Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

ESX Server Element s

Element Shows the ESX element monitored by this sensor. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Automatic Sensor Define if the sensor will change it's status dependent on the health
State state reading. Choose between:
§ Set sensor st at e aut omat ically t o 'Warning' or 'Down': Set
the sensor to a Warning or Down status when the server
returns respective values. The sensor will additionally change to
a Down status if the connection to the server fails.
§ Just report t he current reading, ignore Server Healt h Value:
Never change the sensor's status dependent on the values
returned by the server. The sensor will only change to a Down
status if the connection to the server fails.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1402 26.09.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
168 VMware Host Hardware (WBEM) Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

26.09.2013 1403
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
168 VMware Host Hardware (WBEM) Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1404 26.09.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
168 VMware Host Hardware (WBEM) Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

26.09.2013 1405
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
168 VMware Host Hardware (WBEM) Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1406 26.09.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
169 VMware Host Hardware Status (SOAP) Sensor

6.8.169 VM ware Host Hardware Status (SOAP) Sensor

The VMware Host Hardware Status (SOAP) sensor monitors the hardware status of a VMware
host server using Simple Object Access Protocol (SOAP). It shows the total number of items in
"Normal", "Warning," and "Alert" states, just as shown in the vSphere client. This sensor is
intended to give you a general status overview for your host. Any states other than "Normal"
will be reported in the sensor message. Note: This sensor only shows items that report an
actual state; therefore you might see more "sensors" in your vSphere client than the number of
states available in the channels of this PRTG sensor.

Note: The parent device must be a VMware ESX/ESXi server version 3.5, 4.0, 5.0, 5.1, or 5.5.
We recommend to not use this sensor type on your vCenter. Reliable hardware information
can only be provided when this sensor is created on your physical host server as parent
device.

For this sensor type credentials for VMware servers must be defined for the device you want
to use the sensor on. Please make sure you enter a user with sufficient access rights to obtain
statistics (read-only should work).

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Settings on VMware Host System

If you set up this sensor on different probes (for example, when using remote probes 2050 or
when running a cluster 81 setup), you might need to change the settings of your VMware
host, so it accepts more incoming connections. Otherwise you might get connection timeouts
when running plenty of VMware sensors with a short scanning interval.

For details about this setting, please see More section below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

03.05.2013 1407
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
169 VMware Host Hardware Status (SOAP) Sensor

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

VMware Host Set t ings

Host Server Select the host server you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

VMware Host Set t ings

MoID The Managed Object ID (MoID) of the host. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

1408 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
169 VMware Host Hardware Status (SOAP) Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

03.05.2013 1409
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
169 VMware Host Hardware Status (SOAP) Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1410 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
169 VMware Host Hardware Status (SOAP) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

03.05.2013 1411
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
169 VMware Host Hardware Status (SOAP) Sensor

More

Knowledge Base: How can I increase the connection limit on VMware systems?
§ http://kb.paessler.com/en/topic/30643

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1412 03.05.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
170 VMware Host Performance (SOAP) Sensor

6.8.170 VM ware Host Performance (SOAP) Sensor

The VMware Host Performance (SOAP) sensor monitors a VMware host server using Simple
Object Access Protocol (SOAP). It shows CPU (percent) and memory (absolute) usage, disk read
and write speed, and network received and transmitted speed of a VMware host server.

Note: The parent device must be a VMware ESX/ESXi server version 3.5, 4.0, 5.0, 5.1, or 5.5.

For this sensor type credentials for VMware servers must be defined for the device you want
to use the sensor on. Please make sure you enter a user with sufficient access rights to obtain
statics (read-only should work).

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Settings on VMware Host System

If you set up this sensor on different probes (for example, when using remote probes 2050 or
when running a cluster 81 setup), you might need to change the settings of your VMware
host, so it accepts more incoming connections. Otherwise you might get connection timeouts
when running plenty of VMware sensors with a short scanning interval.

For details about this setting, please see More section below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

07.02.2013 1413
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
170 VMware Host Performance (SOAP) Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1414 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
170 VMware Host Performance (SOAP) Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

07.02.2013 1415
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
170 VMware Host Performance (SOAP) Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1416 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
170 VMware Host Performance (SOAP) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How can I increase the connection limit on VMware systems?
§ http://kb.paessler.com/en/topic/30643

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

07.02.2013 1417
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
170 VMware Host Performance (SOAP) Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

1418 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
171 VMware Virtual Machine (SOAP) Sensor

6.8.171 VM ware Virtual M achine (SOAP) Sensor

The VMware Virtual Machine (SOAP) sensor monitors a virtual machine on a VMware host
server using Simple Object Access Protocol (SOAP). It shows CPU (percent) and memory
(absolute) usage, disk read and write speed, read and write latency, and network usage (total,
received, and transmitted) of a single virtual machine.

Note: The parent device must be a VMware ESX/ESXi server version 3.5, 4.0, 5.0, 5.1, or 5.5; or
a respective Virtual Center server. We recommend using Virtual Center as parent device,
because this way PRTG will continue to monitor your virtual machines also when they change
the physical host using vMotion.

For this sensor type credentials for VMware servers must be defined for the device you want
to use the sensor on. Please make sure you enter a user with sufficient access rights to obtain
statics (read-only should work).

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Settings on VMware Host System

If you set up this sensor on different probes (for example, when using remote probes 2050 or
when running a cluster 81 setup), you might need to change the settings of your VMware
host, so it accepts more incoming connections. Otherwise you might get connection timeouts
when running plenty of VMware sensors with a short scanning interval.

For details about this setting, please see More section below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Note: PRTG requests a full list of all virtual machines configured on the device. Therefore, it may
take a few seconds before the dialog is loaded.

12.05.2014 1419
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
171 VMware Virtual Machine (SOAP) Sensor

If you select more than one virtual machine, multiple sensors are created at once in the Add
Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Virt ual Machine Set t ings

Virtual Machine You see a list of all virtual machines (VMs) available on the host
server on this device, including the ones that are not running. All
VMs are listed with name and the OS it is running on. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1420 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
171 VMware Virtual Machine (SOAP) Sensor

Virt ual Machine Set t ings

MoID Shows the Managed Object ID (MoID) of the virtual machine. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Handling of "Powered Choose how the sensor will react to a virtual machine that is
off" VM powered off. Please choose between:

· Ignore "powered off" st at e (default ): The sensor will not


change to a Down status if the virtual machine is powered off; it
will report zero values instead.
· Alarm when VM is "powered off": The sensor will change to a
Down 121 status if the virtual machine is powered off. Note: While
in Down status, a sensor does not record any data in all of its
channels.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

12.05.2014 1421
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
171 VMware Virtual Machine (SOAP) Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1422 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
171 VMware Virtual Machine (SOAP) Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 1423
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
171 VMware Virtual Machine (SOAP) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How can I increase the connection limit on VMware systems?
§ http://kb.paessler.com/en/topic/30643

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

1424 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
171 VMware Virtual Machine (SOAP) Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1425
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
172 WBEM Custom Sensor

6.8.172 WBEM Custom Sensor

The WBEM Custom Sensor performs a custom query via Web-Based Enterprise Management
(WBEM). It can show the total and channels received.

For this sensor type credentials for Linux/Solaris/Mac OS (SSH/WBEM) systems must be
defined for the device you want to use the sensor on.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Cust om Query Specific

Namespace Enter the namespace for the query. Default value is root /cimv2.

WBEM Query (WQL) Enter the WBEM Query that will be performed with every scanning
interval. It has to be written in CQL/WQL.

1426 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
172 WBEM Custom Sensor

Cust om Query Specific

Numeric Format Define the expected type of the returned values. Choose between:
§ Int eger: The query returns integer values.
§ Float : The query returns float values.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

14.01.2014 1427
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
172 WBEM Custom Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

1428 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
172 WBEM Custom Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 1429
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
172 WBEM Custom Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1430 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
172 WBEM Custom Sensor

More

For more tips and tricks regarding WQL scripts, please see the Paessler Knowledge Base and
search for WQL.
· http://www.paessler.com/knowledgebase

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 1431
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
173 Windows CPU Load Sensor

6.8.173 Windows CPU Load Sensor

The Windows CPU Load sensor monitors the CPU load on a computer via Windows
Performance Counters or Windows Management Instrumentation (WMI), as configured in the
"Windows Compatibility Options" of the parent device. It shows the CPU usage in percent.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

1432 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
173 Windows CPU Load Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Alt ernat ive Query

Errors and invalid data This is an extended help field only. PRTG's WMI sensors are
equipped with the most efficient and accurate WMI queries.
However, Microsoft has changed (and will continue to do that in
the future) some WMI classes over the various Windows/
ServicePack/patchlevel versions, resulting in errors like "class not
valid" or "invalid data". Wherever possible PRTG features an
alternative query that might work in your specific circumstances.
When you keep getting errors for this sensor please try enabling
the alternative query method below.

Alternative query Choose the method PRTG uses to query via WMI. For compatibility
reasons, an alternative query method can be enabled. We
recommend using the default value. You can choose between:

19.07.2013 1433
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
173 Windows CPU Load Sensor

WMI Alt ernat ive Query

· use default : Use PRTG's standard method to query WMI. This is


the best setting in most cases.
· use alt ernat ive: Use an alternative method to query WMI. If you
keep getting errors, please try this setting.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

1434 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
173 Windows CPU Load Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

19.07.2013 1435
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
173 Windows CPU Load Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1436 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
173 Windows CPU Load Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

19.07.2013 1437
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
174 Windows IIS 6.0 SMTP Received Sensor

6.8.174 Windows IIS 6.0 SM TP Received Sensor

The Windows IIS 6.0 SMTP Receiver Sensor monitors Microsoft's Internet Information Services
regarding the number of received emails for an IIS 6.0 SMTP service (Exchange 2003) using
Windows Performance Counters or Windows Management Instrumentation (WMI), as configured
in the "Windows Compatibility Options" of the parent device. It shows the number of messages,
the bytes, and the number of retries, per second for received messages.

Note: This service is not used by Exchange Server 2007 and higher. Exchange Server 2007
uses its own SMTP stack implemented in the Microsoft Exchange Transport service.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

1438 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
174 Windows IIS 6.0 SMTP Received Sensor

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

19.07.2013 1439
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
174 Windows IIS 6.0 SMTP Received Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1440 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
174 Windows IIS 6.0 SMTP Received Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

19.07.2013 1441
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
174 Windows IIS 6.0 SMTP Received Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1442 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
174 Windows IIS 6.0 SMTP Received Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

19.07.2013 1443
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
175 Windows IIS 6.0 SMTP Sent Sensor

6.8.175 Windows IIS 6.0 SM TP Sent Sensor

The Windows IIS 6.0 SMTP Sent Sensor monitors Microsoft's Internet Information Services
regarding the number of sent emails for an IIS 6.0 SMTP service (Exchange 2003) using
Windows Performance Counters or Windows Management Instrumentation (WMI), as configured
in the "Windows Compatibility Options" of the parent device. It shows the number of messages,
the bytes, and the number of retries, per second for sent messages.

Note: This service is not used by Exchange Server 2007 and higher. Exchange Server 2007
uses its own SMTP stack implemented in the Microsoft Exchange Transport service.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

1444 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
175 Windows IIS 6.0 SMTP Sent Sensor

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

19.07.2013 1445
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
175 Windows IIS 6.0 SMTP Sent Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1446 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
175 Windows IIS 6.0 SMTP Sent Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

19.07.2013 1447
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
175 Windows IIS 6.0 SMTP Sent Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1448 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
175 Windows IIS 6.0 SMTP Sent Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

19.07.2013 1449
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
176 Windows IIS Application Sensor

6.8.176 Windows IIS Application Sensor

The Windows IIS Application sensor monitors a Microsoft Internet Information Services server
using Windows Performance Counters or Windows Management Instrumentation (WMI), as
configured in the "Windows Compatibility Options" of the parent device. It can also monitor
applications that use IIS, such as Microsoft SharePoint or Microsoft Reporting Services (SSRS).
The sensor shows bytes sent and received as well as post, get, and CGI requests, not found
errors, anonymous and known users, and received and sent files, in number/second.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

1450 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
176 Windows IIS Application Sensor

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one web service instance, multiple sensors are created at once in the
Add Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Int ernet Informat ion Services

Specify Instance You see a list of all web service instances running on this device.
There is also a "_Total" instance available. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

19.07.2013 1451
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
176 Windows IIS Application Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Int ernet Informat ion Services

Instance The name of the web services instance that is monitored by this
sensor. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1452 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
176 Windows IIS Application Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

19.07.2013 1453
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
176 Windows IIS Application Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1454 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
176 Windows IIS Application Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

19.07.2013 1455
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
176 Windows IIS Application Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1456 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
177 Windows Last Update Sensor

6.8.177 Windows Last Update Sensor

The Windows Last Update sensor reads the number of days since last Windows update from its
parent device and returns the number of days. Use threshold triggers 1716 to get notified in case
this number breaches a certain value.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Requirement: Enable Remote Registry Service

In order for this sensor to work, you need to enable the RemoteRegistry "Remote Registry"
Windows service on the target machine. To do so, please log in to this machine and open the
services manager (e.g. start services.msc). In the list of services, find the Remot e Regist ry
service and set its Start Type to Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

28.05.2014 1457
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
177 Windows Last Update Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Timeout (sec.) Define the timeout for the internal process. It will be killed if it has
not returned a result after this time. Please enter an integer value.

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

1458 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
177 Windows Last Update Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 1459
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
177 Windows Last Update Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1460 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
177 Windows Last Update Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 1461
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
177 Windows Last Update Sensor

More

Knowledge Base: Fixing a Protocol Error Appearing With Windows Last Update Sensor
§ http://kb.paessler.com/en/topic/41113

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1462 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
178 Windows Logged In Users Sensor

6.8.178 Windows Logged In Users Sensor

The Windows Logged In Users sensor queries the number of users logged in to a Windows
installation on the parent device. It returns the total number. You can optionally filter for
certain user names.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

28.05.2014 1463
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
178 Windows Logged In Users Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

User Filter (optional) To filter the value returned by certain user names, define them
here. Enter a comma separated list of user names, or leave the field
empty.

Processing of Users in Define how the user names entered above will be used. Choose
"User Filter" between:
§ Do not count users list ed in "User Filt er": Exclude the users
entered above from counting and only count other uses.
§ Only count users list ed in "User Filt er": Ignore all other users
and only count user names from the list entered above.

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
§ Ignore changes (default ): No action will be taken on change.
§ Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

1464 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
178 Windows Logged In Users Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 1465
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
178 Windows Logged In Users Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1466 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
178 Windows Logged In Users Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 1467
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
178 Windows Logged In Users Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1468 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
179 Windows MSMQ Queue Length Sensor

6.8.179 Windows M SM Q Queue Length Sensor

The Windows MSMQ Queue Length sensor reads the number of messages in a Microsoft
Message Queue of the parent device. It gives back the total number.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Requirement: Message Queuing Service

In order for this sensor to work, the MSMQ "Message Queuing" service must be started both
on the target system and on the computer running the PRTG probe: Either on the local system
(on every node, if on a cluster probe), or on the system running the remote probe 2050 .
Additionally, the MSMQ "Message Queuing" service must also be started on the target
computer.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Depending on your Windows version you may first need to install the Microsoft Message
Queue (MSMQ) Server.

28.05.2014 1469
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
179 Windows MSMQ Queue Length Sensor

Note: When installing Microsoft Message Queue (MSMQ) Server, make sure you install it
including the Directory Service. Depending on your Windows installation this might have
different names, such as

§ MSMQ Active Directory Domain Service Integration


§ Directory Service Integration
§ Active Directory Integration

For details, please see More 1474 section below.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Message Queue You see a list showing the names of all message queues found on
the target device. If there are no message queues available, you will
see a corresponding message. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head. Note: Sub-queues
are not supported by this sensor.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

1470 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
179 Windows MSMQ Queue Length Sensor

Basic Sensor Set t ings

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Message Queue Shows the name of the task monitored by this sensor. The
following settings for this sensor differ in the 'Add Sensor' dialog in
comparison to the sensor's settings page:

Min. Message Age Optionally define an age in minutes the message has to be old. If
set, messages younger than this will not be regarded. If you leave
this field blank, the sensor will not check for the message age.
Please enter an integer value or leave the field empty.

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

28.05.2014 1471
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
179 Windows MSMQ Queue Length Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1472 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
179 Windows MSMQ Queue Length Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

28.05.2014 1473
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
179 Windows MSMQ Queue Length Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How do I activate Message Queuing in my Windows installation?
§ http://kb.paessler.com/en/topic/25963

1474 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
179 Windows MSMQ Queue Length Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1475
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
180 Windows Network Card Sensor

6.8.180 Windows Network Card Sensor

The Windows Network Card sensor monitors bandwidth usage and traffic of a network
interface using Windows Performance Counters or Windows Management Instrumentation
(WMI), as configured in the "Windows Compatibility Options" of the parent device.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

1476 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
180 Windows Network Card Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For devices with multiple network cards multiple sensors are created at once in the Add
Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Network Interface Select the network card(s) you want to add a sensor for. A list of
all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

14.01.2014 1477
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
180 Windows Network Card Sensor

Selected Interface Shows the name of the network card that this sensor is
monitoring. Once a sensor is created this value cannot be changed.
It is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).
§ Show in and out t raffic as posit ive and negat ive area chart :
Show channels for incoming and outgoing traffic as positive and
negative area chart. This will visualize your traffic in a clear way.
Note: This option cannot be used in combination with manual
Vertical Axis Scaling (available in the Sensor Channels Set t ings
1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

1478 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
180 Windows Network Card Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

14.01.2014 1479
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
180 Windows Network Card Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1480 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
180 Windows Network Card Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

14.01.2014 1481
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
180 Windows Network Card Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1482 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
181 Windows Pagefile Sensor

6.8.181 Windows Pagefile Sensor

The Windows Pagefile sensor monitors the Windows pagefile usage via Windows Performance
Counters or Windows Management Instrumentation (WMI), as configured in the "Windows
Compatibility Options" of the parent device. It shows the usage in percent. Note: This sensor
does not work with Windows 2000, because the respective WMI class does not exist on this
operating system!

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

19.07.2013 1483
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
181 Windows Pagefile Sensor

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1484 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
181 Windows Pagefile Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

19.07.2013 1485
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
181 Windows Pagefile Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1486 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
181 Windows Pagefile Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

19.07.2013 1487
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
181 Windows Pagefile Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1488 19.07.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
182 Windows Physical Disk Sensor

6.8.182 Windows Phy sical Disk Sensor

The Windows Physical Disk sensor monitors parameters of a physical disk of a Windows device
using Windows Performance Counters or Windows Management Instrumentation (WMI), as
configured in the "Windows Compatibility Options" of the parent device. It shows accumulated
disk read/write time and bytes, queue, split IO, etc. on physical disks.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

12.05.2014 1489
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
182 Windows Physical Disk Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Windows Phy sical Disk Specific

Physical Disks You see a list showing the Name of the counters you can monitor
as well as the Inst ance, i.e. the respective logical disk (or '_Total'). If
there are no logical disks available, you will see a corresponding
message. From the list, choose all Name/Inst ance combinations
you want to monitor by adding a check mark in front of the
respective line (for example, choose '% Disk Read Time for C:').
A list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

1490 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
182 Windows Physical Disk Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Readings Accessible Using WMI

Display Name These fields show the parameters that are used to query data for
this sensor from the target device.Once a sensor is created this
value cannot be changed. It is shown for reference purposes only.
Instance
If you need to change this, please add the sensor anew.

WMI Class

Counter

Time Stamp

Time Frequency

Counter Type

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (System)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

12.05.2014 1491
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
182 Windows Physical Disk Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1492 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
182 Windows Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

12.05.2014 1493
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
182 Windows Physical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1494 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
182 Windows Physical Disk Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1495
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
183 Windows Print Queue Sensor

6.8.183 Windows Print Queue Sensor

The Windows Print Queue sensor reads the print queue on its parent device and gives back
the number of jobs in the print queue. It can monitor queues for all printers that are installed
locally. For example, you can use this sensor to monitor all print queues on your Windows
print server. Additionally, this sensor can change to a Warning status if there is a printer
problem, such as out of paper, etc.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Requirement: Print Spooler Service

In order for this sensor to work, the Spooler "Print Spooler" service must be started on the
target computer.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

1496 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
183 Windows Print Queue Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Print Queue You see a list showing the names of all print queues found on the
target device. If there are no print queues available, you will see a
corresponding message. Select the desired items by adding check
marks in front of the respective lines. One sensor will be created
for each selection. You can also select and deselect all items by
using the check box in the table head. Note: If a printer name
changes after you created a sensor for its queue, please add the
sensor anew.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

13.06.2013 1497
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
183 Windows Print Queue Sensor

Sensor Set t ings

Print Queue Name Shows the name of the task monitored by this sensor. The
following settings for this sensor differ in the 'Add Sensor' dialog in
comparison to the sensor's settings page:

Min. Print Job Age Optionally define the age in sedonds. If set, jobs younger than this
(sec.) will not be regarded. If you leave this field blank, the sensor will not
check for the print job age. Please enter an integer value or leave
the field empty.

Set to Warning on Define if the sensor will change to a Warning status in case a
Problem Reported printer reports a problem. Choose between:
§ No
§ Yes

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1498 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
183 Windows Print Queue Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

13.06.2013 1499
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
183 Windows Print Queue Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1500 13.06.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
183 Windows Print Queue Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

13.06.2013 1501
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

6.8.184 Windows Registry Sensor

The Windows Registry sensor reads a string value from the Windows registry and can process
the result using a keyword search. The value is shown in the sensor's last message field. Note:
Only REG_SZ values can be processed with this sensor.

Requirement: Remote Registry Service

In order for this sensor to work, please make sure the RemoteRegistry "Remote Registry"
Windows service is running on both the computer running the PRTG probe and the target
machine.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Please make sure that the Windows user account running the PRTGProbeService "PRTG Probe
Service" on the computer running the PRTG probe has access to the registry of the remote
computer (by default, this is the probe computer's local Windows "system" account).

Additionally, the computer running the PRTG probe and the target computer must be member
of the same Windows local domain.

Note: You cannot perform a remote registry call with a Windows user account for which no
password is defined.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

1502 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Regist ry Set t ings

Root Select the root key of the registry entry you want to monitor.
Choose between:
§ HKEY_CLASSES_ROOT
§ HKEY_CURRENT_USER
§ HKEY_LOCAL_MACHINE
§ HKEY_USERS
§ HKEY_PERFORMANCE_DATA
§ HKEY_CURRENT_CONFIG
§ HKEY_DYN_DATA

Key Name Enter the path of the key you want to monitor. Enter the full path
after the root, each subkey divided by a backslash. For example,
enter Software\Microsoft\Windows\CurrentVersion

Value Name Enter the name of the value you want to monitor. For example,
enter ProductId to read the product ID of the target computer's
Windows installation.

64-Bit Selection Define how the provided key name will be looked up. This is
relevant for some registry keys only, for example those containing
the Wow6432Node subkey. Choose between:
§ Use 32-bit regist ry view: The key provided above is copied
from the 32-bit registry editor.

28.05.2014 1503
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

Regist ry Set t ings

§ Use 64-bit regist ry view: The key provided above is copied


from the 64-bit registry editor.
For more information, see the More 1508 section below.

Value Select if the returned result will be further processed. Choose


between:
§ Ignore Value: Do not perform any more keyword checks. The
registry value is shown in the sensor last message field only.
§ Process Text : Use the returned value to perform keyword
checks. Select below.

Check For Existing This setting is only visible if text processing is activated above.
Keywords (Positive) Check if a certain keyword is part of the received value. If there is
no match, the sensor will show a "Down" status.
§ Disable: Do not check for positive keywords.
§ Enable key word check (posit ive): Check if a certain keyword
exists in the received value. Define below.

Text Must Include This setting is only visible if keyword check is activated above.
Enter a search string that must be contained in the returned value.

For Keyword Search Define the method you want to provide the search string with.
Use Choose between:
§ Plain Text : Search for a simple string.
§ Regular Expression: Search using a regular expression. For
more details, see Regular Expressions 2048 section.

Check For Existing This setting is only visible if text processing is activated above.
Keywords (Negative) Check if a certain keyword is not part of the received value. If
there is a match, the sensor will show a "Down" status.

§ Disable: Do not check for negative keywords.

§ Enable key word check (negat ive): Check if a certain keyword


does not exist in the received value. Define below.

Text Must Not Include This setting is only visible if keyword check is activated above.
Enter a search string that must not be contained in the returned
value.

For Keyword Search Define the method you want to provide the search string with.
Use Choose between:

1504 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

Check For Existing This setting is only visible if text processing is activated above.
Keywords (Positive) Check if a certain keyword is part of the received value. If there is
no match, the sensor will show a "Down" status.
§ Disable: Do not check for positive keywords.
§ Enable key word check (posit ive): Check if a certain keyword
exists in the received value. Define below.

§ Plain Text : Search for a simple string.


§ Regular Expression: Search using a regular expression. For
more details, see Regular Expressions 2048 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

28.05.2014 1505
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

1506 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 1507
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
How do I discern 32-bit registry values vs. 64-bit registry values?
§ http://kb.paessler.com/en/topic/25513

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

1508 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
184 Windows Registry Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1509
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
185 Windows Scheduled Task Sensor

6.8.185 Windows Scheduled Task Sensor

The Windows Scheduled Task sensor returns the number of minutes since the last run of the
specified task as well as the corresponding exit code. If a task was never run, the sensor
shows an error. You can define limits (in minutes) in the channel settings 1709 for Last Run in
order to set the sensor into a warning or error status if the last run of the task was too long
ago.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Requirement: Remote Registry Service

In order for this sensor to work, please make sure the RemoteRegistry "Remote Registry"
Windows service is running on both the computer running the PRTG probe and the target
machine.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

1510 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
185 Windows Scheduled Task Sensor

Requirement: Monitored Systems

Note: We recommend running the PRTG probe on Windows 2008 R2 or later.

Microsoft implemented two versions of scheduled task, V1 and V2. Windows 2000, Windows
XP, and Windows Server 2003 create scheduled tasks V1 by default. Later Windows versions
can create and read both versions.

§ If the system running the PRTG probe (either on the core server or a remote probe) runs on
one of these early Windows versions, you will not be able to monitor scheduled tasks of V2.
In this case, please create the tasks on the monitored machines compatible with "Windows
Server 2003, Windows XP, or Windows 2000" if there is a newer Windows version installed.
Note: These Windows versions are not officially supported by PRTG; see section Sy st em
Requirement s 21 .

§ If the system running the PRTG probe (either on the core server or a remote probe) runs on
Windows Vista or later, you will be able to monitor scheduled tasks of both V1 and V2 (i.e.
from all Windows versions).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor scheduled tasks, PRTG will create one sensor for each task you choose.
The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Sensor Set t ings

Task Name You see a list showing the names of all tasks found in the Windows
Task Scheduler on the target device. If there are no scheduled
tasks, you will see a corresponding message. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head. Note: If
a task name changes after you created a sensor for it, please add
the sensor anew.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

28.05.2014 1511
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
185 Windows Scheduled Task Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

Ignore Status Codes Define exit codes of the monitored task which will not be
processed by the sensor. If the external program returns one of
these values, they will be converted into the code 0. Enter a
comma separated list of exit codes or leave this field empty.

Name Shows the name of the task monitored by this sensor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

If Value Changes Define what will be done if the value which the external program
returns changes. You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

1512 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
185 Windows Scheduled Task Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

28.05.2014 1513
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
185 Windows Scheduled Task Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1514 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
185 Windows Scheduled Task Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

28.05.2014 1515
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
185 Windows Scheduled Task Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1516 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
186 Windows System Uptime Sensor

6.8.186 Windows Sy stem Uptime Sensor

The Windows System Uptime sensor monitors uptime of a Windows system using Windows
Performance Counters or Windows Management Instrumentation (WMI), as configured in the
"Windows Compatibility Options" of the parent device. It returns the total uptime.

Note: By default, this sensor type uses a hybrid approach, first trying to query data via
Windows Performance Counters (which needs less system resources), and using Windows
Management Instrumentation (WMI) as a fallback in case Performance Counters are not
available. When running in fallback mode, the sensor will re-try to connect via Performance
Counters after 24 hours. The default behavior can be changed in the Windows Compat ibilit y
Opt ions of the parent device's settings 280 this sensor is created on.

Sensors using the Windows Management Instrumentation (WMI) protocol have high impact on
the system performance! Try to stay below 200 WMI sensors per probe 77 . Above this number,
please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. If you fail to do so, a connection via Performance Counters will not be
possible. However, WMI connections may still work.

Requirement: Windows Version

In order for this sensor to work with Windows Performance Counters, please make sure a
Windows version 2008 or later is installed on the computer running the PRTG probe: This is
either on the local system (on every node, if on a cluster probe), or on the system running a
remote probe 2050 . Note: The target system may well run on Windows 2003 or later.

Requirement: Remote Registry Service

In order for this sensor to work with Windows Performance Counters, please make sure the
Remote Registry Windows service is running on the target computer. If you fail to do so, a
connection via Performance Counters will not be possible. However, WMI connections may still
work.

To enable the service, please log in to the respective computer and open the services
manager (e.g. via services.msc). In the list, find the respective service and set its Start Type to
Automatic.

27.11.2012 1517
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
186 Windows System Uptime Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1518 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
186 Windows System Uptime Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

27.11.2012 1519
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
186 Windows System Uptime Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1520 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
186 Windows System Uptime Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

27.11.2012 1521
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
186 Windows System Uptime Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1522 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
187 Windows Updates Status (Powershell) Sensor

6.8.187 Windows Updates Status (Powershell) Sensor

The Windows Updates Status (Powershell) sensor monitors the status of Windows updates on
a computer and counts the available and installed Windows updates—either from Microsoft or
from the local Windows Server Update Services (WSUS) server. This sensor can show the time
elapsed since the last update, as well as the following numbers:

§ Installed Windows updates


§ Missing Windows updates
§ Installed security updates with low, moderate, important, and critical priority
§ Missing security updates with low, moderate, important, and critical priority

You can find the considered updates in Server Manager (WSUS) under Roles | Windows Server
Updat e Services | Updat e Services | Comput ers | Report s.

Note: If the sensor cannot determine the Time since last update (for example, because the list
of updates is empty), it will show the value -1s and turn into a Warning status.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Note: We recommend setting the scanning interval 1525 of this sensor to at least 12 hours to limit
the load on the server being monitored.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Requirement: Remote PowerShell

The Windows Updates Status (Powershell) sensor uses PowerShell commands. In order to
monitor devices with this sensor, Remot e PowerShell access has to be enabled on the target
computer. For detailed information, please see More 589 section below.

03.04.2014 1523
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
187 Windows Updates Status (Powershell) Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1524 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
187 Windows Updates Status (Powershell) Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

03.04.2014 1525
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
187 Windows Updates Status (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1526 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
187 Windows Updates Status (Powershell) Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: How do I enable and use remote commands in Windows PowerShell?
§ http://kb.paessler.com/en/topic/44453

Knowledge Base: My Powershell sensor returns an error message. What can I do?

03.04.2014 1527
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
187 Windows Updates Status (Powershell) Sensor

§ http://kb.paessler.com/en/topic/59473

Knowledge Base: "No Logon Servers Available" when Using PowerShell Sensors
§ http://kb.paessler.com/en/topic/59745

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1528 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
188 WMI Custom Sensor

6.8.188 WM I Custom Sensor

The WMI Custom Sensor performs a custom query via Windows Management Instrumentation
(WMI).

Note: Your Windows Management Instrumentation Query Language (WQL) query code must be
stored in a file on the system of the probe the sensor is created on: If used on a remote
probe, the file must be stored on the system running the remote probe. In a cluster setup,
please copy the file to every cluster node.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Cust om Query Specific

Channel Name Enter a name for the channel in which the received data will be
presented. The name will be displayed in graphs and tables. Please
enter a string. You can change the name later in the sensor's
channel settings 1709 .

WQL File Select a file that will be used for this sensor from the drop down
menu. It will be executed with every scanning interval. The menu
contains WQL scripts from the \Cust om Sensors\WMI WQL
script s sub folder of your PRTG installation. Please store your
script there. If used on a remote probe, the file must be stored on
the system running the remote probe. If used on a cluster probe,
you must store the file on all servers running a cluster node! For
more information on how to find this path, please see Dat a
St orage 2074 section. Note: Your query must return an integer or
float value. Strings are not supported!

28.05.2014 1529
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
188 WMI Custom Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Cust om Query Specific

Namespace Enter the namespace for the query.

WQL File Shows the WQL file that is executed by the sensor with every
scanning interval. Once a sensor is created this value cannot be
changed. It is shown for reference purposes only. If you need to
change this, please add the sensor anew.

Placeholder <#PH1> In your WQL script, you can use up to three placeholders that you
can assign a value to using this field. Please enter a string for
variable <#PH1> or leave the field empty.

Placeholder <#PH2> In your WQL script, you can use up to three placeholders that you
can assign a value to using this field. Please enter a string for
variable <#PH2> or leave the field empty.

Placeholder <#PH3> In your WQL script, you can use up to three placeholders that you
can assign a value to using this field. Please enter a string for
variable <#PH3> or leave the field empty.

1530 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
188 WMI Custom Sensor

Cust om Query Specific

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'On Change' not ificat ion: The sensor will send an
internal message indicating that its value has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the sensor value changes.

Channel Name Enter a name for the channel in which the received data will be
presented. The name will be displayed in graphs and tables. Please
enter a string.

Unit String Enter a unit for the data that will be received by your script. This is
for displaying purposes only. The unit will be displayed in graphs
and tables. Please enter a string.

Multiplication Define with which value the received values will be multiplied by. By
default, this is set to 1 in order to not change the received values.
Please enter an integer, a decimal value, or leave the field empty.

Division Define with which value the received values will be divided by. By
default, this is set to 1 in order to not change the received values.
Please enter an integer, a decimal value, or leave the field empty.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

28.05.2014 1531
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
188 WMI Custom Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1532 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
188 WMI Custom Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 1533
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
188 WMI Custom Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1534 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
188 WMI Custom Sensor

More

§ Addit ional Sensor Ty pes (Cust om Sensors) 1706

Knowledge Base: How do I properly configure a WMI custom sensor?


§ http://kb.paessler.com/en/topic/163

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

28.05.2014 1535
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

6.8.189 WM I Custom String Sensor

The WMI Custom String sensor performs a custom string query via Windows Management
Instrumentation (WMI).

Note: Your Windows Management Instrumentation Query Language (WQL) query code must be
stored in a file on the system of the probe the sensor is created on: If used on a remote
probe, the file must be stored on the system running the remote probe. In a cluster setup,
please copy the file to every cluster node.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Cust om Query Specific

Channel Name Enter a name for the channel in which the received data will be
presented. The name will be displayed in graphs and tables. Please
enter a string. You can change the name later in the sensor's
channel settings 1709 .

WQL File Select a file that will be used for this sensor from the drop down
menu. It will be executed with every scanning interval. The menu
contains WQL scripts from the \Cust om Sensors\WMI WQL
script s sub folder of your PRTG installation. Please store your
script there. If used on a remote probe, the file must be stored on
the system running the remote probe. If used on a cluster probe,
you must store the file on all servers running a cluster node! For
more information on how to find this path, please see Dat a
St orage 2074 section.

1536 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Cust om Query Specific

Namespace Enter the namespace for the query.

WQL File Shows the name of the file that this sensor is using. Once a sensor
is created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Placeholder <#PH1> In your WQL script, you can use up to three placeholders that you
can assign a value to using this field. Please enter a string for
variable <#PH1> or leave the field empty.

Placeholder <#PH2> In your WQL script, you can use up to three placeholders that you
can assign a value to using this field. Please enter a string for
variable <#PH2> or leave the field empty.

Placeholder <#PH3> In your WQL script, you can use up to three placeholders that you
can assign a value to using this field. Please enter a string for
variable <#PH3> or leave the field empty.

14.01.2014 1537
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

Cust om Query Specific

If Value Changes Define what shall be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'On Change' not ificat ion: The sensor will send an
internal message indicating that its value has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the sensor value changes.

Channel Name Enter a name for the channel in which the received data will be
presented. The name will be displayed in graphs and tables. Please
enter a string.

Unit String Enter a unit for the data that will be received by your script. This is
for displaying purposes only. The unit will be displayed in graphs
and tables. Please enter a string.

Multiplication Define with which value the received values will be multiplied by. By
default, this is set to 1 in order to not change the received values.
Please enter an integer, a decimal value, or leave the field empty.

Division Define with which value the received values will be divided by. By
default, this is set to 1 in order to not change the received values.
Please enter an integer, a decimal value, or leave the field empty.

Response Must Include Define which string must be part of the data that is received form
the WMI object. You can either enter plain text or a Regular
Expression 2048 . If the data does not include the search pattern, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

Response Must Not Define which string must not be part of the data that is received
Include form the WMI object. You can either enter plain text or a Regular
Expression 2048 . If the data does include the search pattern, the
sensor will be set to an error state. Please enter a string or leave
the field empty.

For Keyword Search Define in which format you have entered the search expression in
Use the field above.
§ Plain Text : Search for the string as plain text. The characters *
and ? work here as placeholder, whereas * stands for no or any
number of characters and ? stands for exactly one character (as
known from Windows search). This behavior cannot be disabled,
so the literal search for these characters is not possible with
plain text search.

1538 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

Cust om Query Specific

§ Regular Expression: Treat the search pattern as a Regular


Expression 2048 .

Maximum Length of Define the maximum allowed length of the string that will be
String received from the WMI object. If it is longer than this value, the
sensor will be set to an error status. Please enter an integer value
or leave the field empty.

Extract Number Using Define if you want to filter out a numeric value from the string
Regular Expression received from the WMI object. You can convert this into a float
value, in order to use it with channel limits (see Sensor Channels
Set t ings 1709 ).
§ No ext ract ion: Do not extract a float value. Use the result as a
string value.
§ Ext ract a numeric value using a regular expression: Use a
regular expression to identify a numeric value in the string and
convert it to a float value. Define below. See also the example 1543

below.

Regular Expression This setting is only visible if number extraction is enabled above.
Enter a Regular Expression 2048 to identify the numeric value you
want to extract from the string returned by the WMI object. You
can use capturing groups here. Make sure the expression returns
numbers only (including decimal and thousands separators). The
result will be further refined by the settings below.

Index of Capturing This setting is only visible if number extraction is enabled above. If
Group your regular expression uses capturing groups, please specify
which one will be used to capture the number. Please enter an
integer value or leave the field empty.

Decimal Separator This setting is only visible if number extraction is enabled above.
Define which character is used as decimal separator for the number
extracted above. Please enter a string or leave the field empty.

Thousands Separator This setting is only visible if number extraction is enabled above.
Define which character is used as thousands separator for the
number extracted above. Please enter a string or leave the field
empty.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.

14.01.2014 1539
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

Cust om Query Specific

§ Writ e sensor result t o disk (Filename: "Result of Sensor


(ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

1540 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

14.01.2014 1541
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1542 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Example: Number Extraction with Regular Expression

If you want to extract a number in the response string using a regular expression, please note
that the index for captures in this sensor is based on 1 (not on 0). Furthermore, capturing
groups are not created automatically. The example below will illustrate this issue.

Consider the following string as returned by a request for CPU usage:


5 Sec (3.49%), 1 Min (3.555%), 5 Min (3.90%)

Assuming you would like to filter for the number 3.555, i.e., the percentage in the second
parentheses. Then enter the following regex in the Regular Expression field:
(\d+\.\d+).*(\d+\.\d+).*(\d+\.\d+)

As Index of Capt uring Group enter 3. This will extract the desired number 3.555.

14.01.2014 1543
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
189 WMI Custom String Sensor

The index has to be 3 in this case because the capturing groups here are the following:

§ Group 1 contains "3.49%), 1 Min (3.555), 5 Min (3.90"


§ Group 2 contains "3.49"
§ Group 3 contains "3.555"
§ Group 4 contains "3.90"

Please keep in mind this note about index and capturing groups when using number
extraction.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1544 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

6.8.190 WM I Event Log Sensor

The WMI Event Log sensor monitors a specific Windows log file using Windows Management
Instrumentation (WMI). It shows the number of new records (volume), the number of new
records per second (speed), and it returns the last message in the sensor status.

You can set the sensor to a desired status individually according to a new event log entry. For
details and how to find out the correct filter, see section More 1551 .

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one log file, multiple sensors are created at once in the Add Sensor
dialog. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Event Log Monit or

Log File The Windows event log provides several different log files. A list of
all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

28.05.2014 1545
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Event Log Monit or

Log file Shows the Windows log file that this sensor will monitor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Filt er Event Log Ent ries

Event Type Specify the type of event that will be considered by this sensor.
Other event type will not be processed. Choose between the
following event types:
§ Any
§ Error
§ Warning
§ Informat ion
§ Securit y Audit Success
§ Securit y Audit Failure

Filter by Source Filter all received events for a certain event source. If enabled, only
messages matching the defined value will be considered by the
sensor. Choose between:

1546 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

Filt er Event Log Ent ries

· Off: Do not filter by event source.


· On: Enable filtering by event source.

Match String (Event This field is only visible if filtering is enabled above. Enter a source
Source) from which the events are to come from. Only events from a
source matching this string will be regarded, others ignored. Please
enter a string.

Filter by ID Filter all received events for a certain event ID. If enabled, only
messages matching the defined value(s) will be considered by the
sensor. Choose between:
· Off: Do not filter by event ID.
· On: Enable filtering by event ID.

Match Value (Event ID) This field is only visible if filtering is enabled above. Enter one or
more event IDs (comma separated) from which the events are to
come from. Only events with an ID matching one of the values will
be regarded. Please enter one integer value or more comma
separated integer values.

Filter by Category Filter all received events for a certain event category. If enabled,
only messages matching the defined value will be considered by
the sensor. Choose between:
· Off: Do not filter by event category.
· On: Enable filtering by event category.

Match String (Event This field is only visible if filtering is enabled above. Enter a category
Category) which the events are to have. Only events with a category
matching this string will be regarded. Please enter a string.

Filter by Event User Filter all received events for a certain event user. If enabled, only
messages matching the defined value will be considered by the
sensor. Choose between:
· Off: Do not filter by event user.
· On: Enable filtering by event user.

Match String (Event This field is only visible if filtering is enabled above. Enter a user
User) name which the event are to be assigned to. Only events with a
user name matching this string will be regarded. Please enter a
string.

28.05.2014 1547
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

Filt er Event Log Ent ries

Filter by Event Filter all received events for a certain event computer. If enabled,
Computer only messages matching the defined value will be considered by
the sensor. Choose between:
· Off: Do not filter by event computer.
· On: Enable filtering by event computer.

Match String (Event This field is only visible if filtering is enabled above. Enter a
Computer) computer name which the events are to be assigned to. Only
events with a computer name matching this string will be regarded.
Please enter a string.

Filter by Event Filter all received events for a certain event message. If enabled,
Message only messages matching the defined value will be considered by
the sensor. Choose between:
· Off: Do not filter by event message.
· On: Enable filtering by event message.

Match String (Event This field is only visible if filtering is enabled above. Enter a message
Message) which the event must contain. Only events with a message
matching this string will be regarded. Please enter a string.

Note: For the WMI Event Log Sensor, you can use the percent sign (%) as placeholder for any
or no character (as known from the asterisk sign (*) in Windows search) in combination with a
substring. For example, you can enter %RAS% for any event source containing the string RAS.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1548 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

28.05.2014 1549
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1550 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

More
Knowledge Base: Event Log Sensors: Setting Correct Status and Source Filter
§ http://kb.paessler.com/en/topic/59803

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

28.05.2014 1551
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
190 WMI Event Log Sensor

Others

For more general information about settings, please see Object Set t ings 142 section.

1552 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
191 WMI Exchange Server Sensor

6.8.191 WM I Exchange Server Sensor

The WMI Exchange Server sensor monitors a Microsoft Exchange Server 2003, 2007, 2010, or
2013 using Windows Management Instrumentation (WMI). It can show information about the
queue, delivery time, latency, users, etc.

Note: Existing former "WMI Exchange Server 2003/2007 Sensors" from previous PRTG versions
will continue to monitor your Exchange server in PRTG 9, but newly added Exchange server
sensors will be of the "WMI Exchange Server Sensor" type which is able to monitor Exchange
servers regardless of their version.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor an Exchange Server, PRTG will create one sensor for each performance
counter you choose. The settings you make in this dialog are valid for all of the sensors that
are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Exchange Server Dat a Readings Accessible Using WMI

Performance Counter You see a list of data values the sensor can monitor on your
Exchange server. The available options depend on your Exchange
server configuration. PRTG shows all possible performance
counters with name and instance description (if available). Select
the desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.
You might be able to select aspects regarding:
§ SMTP Server: Queue Lengths

12.05.2014 1553
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
191 WMI Exchange Server Sensor

Exchange Server Dat a Readings Accessible Using WMI

§ MSExchangeIS Mailbox: Queue Sizes, Delivery Times,


Operations, Messages
§ MSExchangeIS Public: Queue Sizes, Delivery Times, Operations,
Messages
§ MSExchangeIS: Packets, Operations, Clients, Latency, Requests,
Users
§ MS Exchange RPC Client Access: Active User Count, User
Count, Connection Count
§ MS Exchange OWA: Current Unique Users, Average Response
Time

Note: Depending on your Exchange server version, not all counters


might be available.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

1554 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
191 WMI Exchange Server Sensor

Readings Accessible Using WMI

Display Name These fields show the parameters that are used to query data for
this sensor from the target device.Once a sensor is created this
Instance value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

WMI Class

Counter

Time Stamp

Time Frequency

Counter Type

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (System)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

12.05.2014 1555
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
191 WMI Exchange Server Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

1556 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
191 WMI Exchange Server Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

12.05.2014 1557
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
191 WMI Exchange Server Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1558 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
191 WMI Exchange Server Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1559
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
192 WMI Exchange Transport Queue Sensor

6.8.192 WM I Exchange Transport Queue Sensor

The WMI Exchange Server sensor monitors the length of transport queues of a Microsoft
Exchange Server 2003, 2007, 2010, or 2013 using Windows Management Instrumentation
(WMI). It shows the same information as shown in Windows System Monitor ('perfmon'). See
section More 1565 below for an explanation of the transport queue types.

Possible values that can be monitored: Active Mailbox Delivery Queue Length, Active Non-Smtp
Delivery Queue Length, Active Remote Delivery Queue Length, Aggregate Delivery Queue
Length (All Queues), Aggregate Shadow Queue Length, Categorizer Job Availability, Items
Completed Delivery Per Second, Items Completed Delivery Total, Items Deleted By Admin Total,
Items Queued For Delivery Expired Total, Items Queued for Delivery Per Second, Items Queued
For Delivery Total, Items Resubmitted Total, Largest Delivery Queue Length, Messages
Completed Delivery Per Second, Messages Completed Delivery Total, Messages Completing
Categorization, Messages Deferred Due To Local Loop, Messages Deferred during
Categorization, Messages Queued For Delivery, Messages Queued for Delivery Per Second,
Messages Queued For Delivery Total, Messages Submitted Per Second, Messages Submitted
Total, Poison Queue Length, Retry Mailbox Delivery Queue Length, Retry Non-Smtp Delivery
Queue Length, Retry Remote Delivery Queue Length, Shadow Queue Auto Discards Total,
Submission Queue Items Expired Total, Submission Queue Length, Unreachable Queue Length.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one queue, multiple sensors are created at once in the Add Sensor
dialog. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

1560 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
192 WMI Exchange Transport Queue Sensor

WMI Exchange Transport Queue Specific

MSExchangeTransport You see a list of transport queues that can be monitored on your
Queues Exchange server. The available options depend on your Exchange
server configuration. PRTG shows all possible queues with name
and instance description (if available). Select the desired items by
adding check marks in front of the respective lines. One sensor will
be created for each selection. You can also select and deselect all
items by using the check box in the table head. Note: For
performance reasons, we recommend to only select necessary
items!

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Readings Accessible Using WMI

Display Name These fields show the parameters that are used to query data for
this sensor from the target device.Once a sensor is created this
Instance value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

WMI Class

28.05.2014 1561
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
192 WMI Exchange Transport Queue Sensor

Readings Accessible Using WMI

Counter

Time Stamp

Time Frequency

Counter Type

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (System)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1562 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
192 WMI Exchange Transport Queue Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

28.05.2014 1563
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
192 WMI Exchange Transport Queue Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1564 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
192 WMI Exchange Transport Queue Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

More
Knowledge Base: Types of Transport Queues in Microsoft Exchange

28.05.2014 1565
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
192 WMI Exchange Transport Queue Sensor

§ http://kb.paessler.com/en/topic/55413

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1566 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
193 WMI File Sensor

6.8.193 WM I File Sensor

The WMI File monitors a file using Windows Management Instrumentation (WMI). It shows the
file size and the last modified date.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

27.11.2012 1567
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
193 WMI File Sensor

WMI File Monit or

File name Enter the name of the file that this sensor will check. Please enter a
full local path. The file must exist on the computer your local or
remote probe is running on; UNC paths are not allowed here. For
example, when creating this sensor on a device under the local
probe, the file be accessible on the local system.

If timestamp changes Define what shall be done in case the timestamp of the file
changes. You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'On Change' not ificat ion: The sensor will send an
internal message indicating that its value has changed. In
combination with a Change Trigger, you can use this mechanism
to trigger a notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1568 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
193 WMI File Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

27.11.2012 1569
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
193 WMI File Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1570 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
193 WMI File Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

27.11.2012 1571
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
193 WMI File Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1572 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

6.8.194 WM I Free Disk Space (M ulti Drive) Sensor

The WMI Free Disk Space (Multi Drive) sensor monitors the free disk space of one or multiple
drive(s) using Windows Management Instrumentation (WMI). It shows the space in percent and
total. One single sensor is used for all drives; the data is presented in different channels.

This sensor monitors logical partitions of a hard or fixed disk drive. PRTG identifies logical disks
by their drive letter, such as C.

Note: This sensor is also supported on Windows XP and earlier.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Volume Specific

Drive From the drop down menu, select the drive(s) you want to monitor.
We recommend using the default value. You can choose All to
monitor all available drives or you can choose one specific drive
letter to monitor this single drive only. The data in the drop down
menu may also contain drive letters that do not exist on your
device. The drive setting cannot be changed once the sensor is
created.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

14.01.2014 1573
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Disk Free Configurat ion

Drive Shows the drive(s) that this sensor is monitoring; either All or a
specific drive letter. Once a sensor is created this value cannot be
changed. It is shown for reference purposes only. If you need to
change this, please add the sensor anew.

Set limit s checked against ALL disks

In this section you can set limits that are valid for all channels and all drives. By entering
limits, you can define when the sensor will enter a Warning or Down status; depending on
the data provided by all drives that this sensor monitors. If you want to define limits for
separate channels individually please use the limit settings in the sensor's Channels settings.
Note: All limits defined here are valid additionally to the limits defined in the particular
Channels settings!

Percentage Limit Check Enable or disable a limit check for the free space in percentage
channels of all drives. By default percentage limits are enabled with
lower warning and lower error limit. Choose between:
· Disable Percent age Limit s: Do not use the drives' data to
control the sensor's status.
· Enable Percent age Limit s: Define limits. Additional fields appear
below. The sensor will enter a warning or down state when free
space limits are undercut or overrun.

1574 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

Set limit s checked against ALL disks

Upper Error Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Down status. If the free disk
space of one of your drives overruns this percent value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if percentage limit check is enabled above.
Specify an upper limit in percent for a Warning status. If the free
disk space of one of your drives overruns this percent value, the
sensor will be set to Warning. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for a warning state. If the free disk
space of one of your drives undercuts this percent value, the
sensor will be set to warning. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Lower Error Limit This field is only visible if percentage limit check is enabled above.
Specify a lower limit in percent for entering a Down status. If the
free disk space of one of your drives undercuts this percent value,
the sensor will be set to Down. Please enter an integer value or
leave the field empty. Note: The limits set here are valid for all
channels of this sensor. You can additionally set individual limits for
each sensor channel in the Sensor Channels Set t ings 1709 . The
limits set here and in the channel settings are valid simultaneously!

Byte Limit Check Enable or disable a limit check for the free bytes channels of all
drives. Choose between:
· Disable By t e Limit s: Do not use the drives' data to control the
sensor's status.
· Enable By t e Limit s: Define limits. Additional fields appear below.
The sensor will enter a warning or down state when free space
limits are undercut or overrun.

14.01.2014 1575
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

Set limit s checked against ALL disks

Upper Error Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives overruns this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Upper Warning Limit This field is only visible if byte limit check is enabled above. Specify
an upper limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives overruns this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

Lower Warning Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives undercuts this bytes value, the sensor
will be set to Warning. Please enter an integer value or leave the
field empty. Note: The limits set here are valid for all channels of
this sensor. You can additionally set individual limits for each
sensor channel in the Sensor Channels Set t ings 1709 . The limits set
here and in the channel settings are valid simultaneously!

Lower Error Limit This field is only visible if byte limit check is enabled above. Specify
a lower limit. Use the same unit as shown by the free bytes
channels of this sensor (by default this is MByte). If the free disk
space of one of your drives undercuts this bytes value, the sensor
will be set to Down. Please enter an integer value or leave the field
empty. Note: The limits set here are valid for all channels of this
sensor. You can additionally set individual limits for each sensor
channel in the Sensor Channels Set t ings 1709 . The limits set here
and in the channel settings are valid simultaneously!

Alarm on Missing/ If a monitored disk is removed or not found, values are set to zero.
Removed Disk Select the alarming approach in this case. Choose between:
§ Deact ivat e alarm (default ): Select this option if you do not
want an alarm for a removed disk.
§ Act ivat e Alarm: Select this option if you want to be alerted if a
monitored disk is removed.

1576 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

14.01.2014 1577
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1578 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

14.01.2014 1579
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
194 WMI Free Disk Space (Multi Drive) Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1580 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
195 WMI HDD Health Sensor

6.8.195 WM I HDD Health Sensor

This sensor type connects to the parent device via Windows Management Instrumentation
(WMI) and monitors the health of IDE disk drives on the target system, using Self-Monitoring,
Analysis and Reporting Technology (S.M.A.R.T.). This is built into most modern IDE hard disk
drives.

Note: This sensor officially requires Windows Vista or later running on the target machine
which holds the hard disk drives you want to monitor. The sensor may not work reliably when
the target machine runs on Windows 2003 or Windows XP; due to a known bug in those
systems, the sensor may not be able to detect available hard disk drives.

Available sensor channels may vary, depending on the hardware used on the target system.
Available measurements may include: Read Error Rate, Spin-Up Time, Start/Stop Count,
Reallocated Sectors Count, Seek Error Rate, Power-On Hours, Spin Retry Count, Calibration
Retry Count, Power Cycle Count, Power-off Retract Count, Load Cycle Count, Temperature
Celsius, Reallocation Event Count, Current Pending Sector Count, Uncorrectable Sector Count,
UltraDMA CRC Error Count, Write Error Rate, Transfer Error Rate, Total LBAs Written, and Total
LBAs Read.

The channel names indicate the ID of the channel, followed by a colon, and the typical meaning
of the channel. Note: Some vendors define meanings other than the common one.

Every attribute of a disk assumes a value. PRTG shows these attributes as channels with their
last, minimum, and maximum value. These channel values change over time and indicate the
disk health—higher values correspond to a better health. The disk's attributes come with a
threshold, defined by the manufacturer of the drive. If a channel value is lower than this
threshold, the sensor is automatically set to a Warning status. This indicates that the Self-
Monitoring, Analysis and Reporting Technology (S.M.A.R.T.) status of the HDD might break
soon. Note: For some attributes are no thresholds defined and thus cannot be judged for a
status other than Up.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor the health of a disk, PRTG will create one sensor for each IDE device you
choose. The settings you make in this dialog are valid for all of the sensors that are created.

14.01.2014 1581
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
195 WMI HDD Health Sensor

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SMART Specific

IDE Devices Please select one or more hard disks you want to add a sensor for.
A list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head. . The items shown in the list are specific to the parent device
you create the sensor on.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SMART Specific

Serial No. Shows the serial number of the monitored disk. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

1582 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
195 WMI HDD Health Sensor

SMART Specific

Size (GB) Shows the size in Gigabyte of the monitored disk. Once a sensor is
created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Name Shows the name of the monitored disk. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Timeout (sec) Enter a timeout in seconds for the request. If the reply takes longer
than this value the request is aborted and an error message is
triggered.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

14.01.2014 1583
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
195 WMI HDD Health Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

1584 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
195 WMI HDD Health Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

14.01.2014 1585
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
195 WMI HDD Health Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1586 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
196 WMI Logical Disk Sensor

6.8.196 WM I Logical Disk Sensor

The WMI Logical Disk sensor monitors parameters of a logical disk of a Windows device using
Windows Management Instrumentation (WMI). It shows disk read/write time, queue, free space,
etc. on logical partitions of a disk drive.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Logical Disk Specific

Logical Disks You see a list showing the Name of the counters you can monitor
as well as the Inst ance, i.e. the respective logical disk (or '_Total'). If
there are no logical disks available, you will see a corresponding
message. From the list, choose all Name/Inst ance combinations
you want to monitor by adding a check mark in front of the
respective line (for example, choose '% Disk Read Time for C:'). For
each selection one sensor will be created using the defined
settings.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

12.05.2014 1587
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
196 WMI Logical Disk Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Readings Accessible Using WMI

Display Name These fields show the parameters that are used to query data for
this sensor from the target device.Once a sensor is created this
Instance value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

WMI Class

Counter

Time Stamp

Time Frequency

Counter Type

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (System)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

1588 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
196 WMI Logical Disk Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

12.05.2014 1589
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
196 WMI Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

1590 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
196 WMI Logical Disk Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

12.05.2014 1591
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
196 WMI Logical Disk Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1592 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
197 WMI Memory Sensor

6.8.197 WM I M emory Sensor

The WMI Memory sensor monitors available (free) system memory on Windows systems using
Windows Management Instrumentation (WMI).

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

27.11.2012 1593
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
197 WMI Memory Sensor

WMI Alt ernat ive Query

Errors and invalid data This is an extended help field only. PRTG's WMI sensors are
equipped with the most efficient and accurate WMI queries.
However, Microsoft has changed (and will continue to do that in
the future) some WMI classes over the various Windows/
ServicePack/patchlevel versions, resulting in errors like "class not
valid" or "invalid data". Wherever possible PRTG features an
alternative query that might work in your specific circumstances.
When you keep getting errors for this sensor please try enabling
the alternative query method below.

Alternative query Choose the method PRTG uses to query via WMI. For compatibility
reasons, an alternative query method can be enabled. We
recommend using the default value. You can choose between:
· use default : Use PRTG's standard method to query WMI. This is
the best setting in most cases.
· use alt ernat ive: Use an alternative method to query WMI. If you
keep getting errors, please try this setting.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1594 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
197 WMI Memory Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

27.11.2012 1595
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
197 WMI Memory Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1596 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
197 WMI Memory Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 1597
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

6.8.198 WM I M icrosoft SQL Server 2005 Sensor (Deprecated)

Import ant Not ice

This sensor type is deprecated.


Monitoring of Microsoft SQL Server 2005 using PRTG is discontinued. It cannot be monitored
with PRTG any more with the latest updates of SQL Server 2005. The reason for this is a
software update delivered by Microsoft in August 2012. The following updates cause this
issue:
§ Securit y Updat e for SQL Server 2005 Service Pack 4 (KB2716429)
§ Securit y Updat e for SQL Server 2005 Service Pack 4 (KB2716427)

We have made reasonable effort to fix this from our side but we were unable to. We do not
have instructions to circumvent this issue at this time. Please ask the vendor to fix this.

More
Knowledge Base: Why does my WMI Microsoft SQL Server 2005 Sensor not work anymore?
§ http://kb.paessler.com/en/topic/44713

The WMI Microsoft SQL Server sensor monitors the performance of a Microsoft SQL server via
Windows Management Instrumentation (WMI). This sensor can monitor SQL General
St at ist ics, Access Met hods, the Buffer Manager, the Memory Manager, the Locks
Manager, and SQL St at ist ics. The channels actually available for a sensor depend on which
performance counters you choose during setup.

Channel Overview

User Connections Number of user connections. Because each user connection


consumes some memory, configuring overly high numbers of user
connections could affect throughput. Set user connections to the
maximum expected number of concurrent users.

Logins Total number of logins started per second.

Logouts Total number of logout operations started per second.

Full Scans Number of unrestricted full scans per second. These can be either
base-table or full-index scans.

1598 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

Channel Overview

Page Splits Number of page splits per second that occur as the result of
overflowing index pages.

Table Lock Escalations Number of times locks on a table were escalated.

Buffer Cache Hit Ratio Percentage of pages found in the buffer cache without having to
read from disk. The ratio is the total number of cache hits divided
by the total number of cache lookups since an instance of SQL
Server was started. 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.

Database Pages Number of pages in the buffer pool with database content.

Stolen Pages Number of pages used for miscellaneous server purposes


(including procedure cache).

Page Life Expectancy Number of seconds a page will stay in the buffer pool without
references.

Connection Memory Total amount of dynamic memory the server is using for maintaining
(KB) connections.

Optimizer Memory (KB) Total amount of dynamic memory the server is using for query
optimization.

Total Server Memory Total amount of dynamic memory (in kilobytes) that the server is
(KB) using currently.

Target Server Memory Total amount of dynamic memory the server can consume.
(KB)

SQL Cache Memory Total amount of dynamic memory the server is using for the
(KB) dynamic SQL cache.

Lock Requests Number of new locks and lock conversions per second requested
from the lock manager.

Deadlocks Number of lock requests per second that resulted in a deadlock.

Average Wait Time Average amount of wait time (in milliseconds) for each lock request
that resulted in a wait.

28.05.2014 1599
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

Channel Overview

Batch Requests Number of Transact-SQL command batches received per second.


This statistic is affected by all constraints (such as I/O, number of
users, cache size, complexity of requests, and so on). High batch
requests mean good throughput.

SQL Compilations Number of SQL compilations per second. Indicates the number of
times the compile code path is entered. Includes compiles due to
recompiles. After SQL Server user activity is stable, this value
reaches a steady state.

SQL Re-Compilations Number of SQL recompiles per second. Counts the number of
times recompiles are triggered. In general, you want the recompiles
to be low.

Note: This sensor can only be added to a device (computer) running a Microsoft SQL database.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SQL Server Set t ings

MS SQL Server You see a list of all server instances available on the device. Display
Instance name and service name are provided as returned by the SQL
server. Please choose one or more instances by adding a check
mark in front of the respective line. For each instance one sensor
will be created.

1600 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

SQL Server Set t ings

SQL Server Version Enter the version of the SQL server. Usually, you can keep the
default value.

SQL Count er Specific

SQL Performance You see a list of different performance counters which can be
Counters monitored for the instance(s) selected above. The sensors created
for the server instances will all monitor the performance counter
you select here. Choose from:
§ General St at ist ics: Read general performance counters. This will
show the number of user connections, and the number of logins
and logouts per second.
§ Access Met hods: Read access method counters. This will show
the number of full scans, page splits, and table lock escalations,
per second.
§ Buffer Manager: Read buffer manager counters. This will show
the buffer cache hit ratio in percent, and the number of database
pages and stolen pages.
§ Memory Manager: Read memory manager counters. This will
show the connection memory, optimizer memory, total server
memory, target server memory, and SQL cache memory, in KB.
§ Locks: Read locks counters. This will show the number of lock
requests and deadlocks, per second, and the average wait time.
§ SQL St at ist ics: Read SQL statistics. This will show the number of
batch requests, SQL compilations, and SQL re-compilations, per
second.
Depending on your selection, a sensor with the specified channels
will be created. Note: In order to monitor several performance
counters for an instance, please add the sensor several times.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

28.05.2014 1601
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SQL Server Set t ings

Service Shows the service monitored by this sensor. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Name Shows the name of the server instance monitored by this sensor.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

WMI Class Name Select whether PRTG will select the name of the WMI class used for
monitoring automatically. Choose between:
§ Aut omat ic: Choose WMI class automatically. This is the
recommended setting.
§ Manual: Manually enter a WMI class name. Use this if your server
instance returns an error code in automatic mode.

WMI Class This field is only shown if manual WMI class selection is enabled
above. This setting is intended for experienced users only. Enter
the WMI class name that will be used for monitoring your server
instance.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.

1602 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

SQL Server Set t ings

§ Writ e sensor result t o disk (Filename: "Result of Sensor


(ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

28.05.2014 1603
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

1604 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

28.05.2014 1605
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
198 WMI Microsoft SQL Server 2005 Sensor (Deprecated)

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1606 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

6.8.199 WM I M icrosoft SQL Server 2008 Sensor

The WMI Microsoft SQL Server sensor monitors the performance of a Microsoft SQL server via
Windows Management Instrumentation (WMI). This sensor can monitor SQL General
St at ist ics, Access Met hods, the Buffer Manager, the Memory Manager, the Locks
Manager, and SQL St at ist ics. The channels actually available for a sensor depend on which
performance counters you choose during setup.

Channel Overview

User Connections Number of user connections. Because each user connection


consumes some memory, configuring overly high numbers of user
connections could affect throughput. Set user connections to the
maximum expected number of concurrent users.

Logins Total number of logins started per second.

Logouts Total number of logout operations started per second.

Full Scans Number of unrestricted full scans per second. These can be either
base-table or full-index scans.

Page Splits Number of page splits per second that occur as the result of
overflowing index pages.

Table Lock Escalations Number of times locks on a table were escalated.

Buffer Cache Hit Ratio Percentage of pages found in the buffer cache without having to
read from disk. The ratio is the total number of cache hits divided
by the total number of cache lookups since an instance of SQL
Server was started. 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.

Database Pages Number of pages in the buffer pool with database content.

Stolen Pages Number of pages used for miscellaneous server purposes


(including procedure cache).

Page Life Expectancy Number of seconds a page will stay in the buffer pool without
references.

Connection Memory Total amount of dynamic memory the server is using for maintaining
(KB) connections.

27.11.2012 1607
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

Channel Overview

Optimizer Memory (KB) Total amount of dynamic memory the server is using for query
optimization.

Total Server Memory Total amount of dynamic memory (in kilobytes) that the server is
(KB) using currently.

Target Server Memory Total amount of dynamic memory the server can consume.
(KB)

SQL Cache Memory Total amount of dynamic memory the server is using for the
(KB) dynamic SQL cache.

Lock Requests Number of new locks and lock conversions per second requested
from the lock manager.

Deadlocks Number of lock requests per second that resulted in a deadlock.

Average Wait Time Average amount of wait time (in milliseconds) for each lock request
that resulted in a wait.

Batch Requests Number of Transact-SQL command batches received per second.


This statistic is affected by all constraints (such as I/O, number of
users, cache size, complexity of requests, and so on). High batch
requests mean good throughput.

SQL Compilations Number of SQL compilations per second. Indicates the number of
times the compile code path is entered. Includes compiles due to
recompiles. After SQL Server user activity is stable, this value
reaches a steady state.

SQL Re-Compilations Number of SQL recompiles per second. Counts the number of
times recompiles are triggered. In general, you want the recompiles
to be low.

Note: This sensor can only be added to a device (computer) running a Microsoft SQL database.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

1608 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SQL Server Set t ings

MS SQL Server You see a list of all server instances available on the device. Display
Instance name and service name are provided as returned by the SQL
server. Please choose one or more instances by adding a check
mark in front of the respective line. For each instance one sensor
will be created.

SQL Server Version Enter the version of the SQL server. Usually, you can keep the
default value.

SQL Count er Specific

SQL Performance You see a list of different performance counters which can be
Counters monitored for the instance(s) selected above. The sensors created
for the server instances will all monitor the performance counter
you select here. Choose from:
§ General St at ist ics: Read general performance counters. This will
show the number of user connections, and the number of logins
and logouts per second.
§ Access Met hods: Read access method counters. This will show
the number of full scans, page splits, and table lock escalations,
per second.
§ Buffer Manager: Read buffer manager counters. This will show
the buffer cache hit ratio in percent, and the number of database
pages and stolen pages.
§ Memory Manager: Read memory manager counters. This will
show the connection memory, optimizer memory, total server
memory, target server memory, and SQL cache memory, in KB.
§ Locks: Read locks counters. This will show the number of lock
requests and deadlocks, per second, and the average wait time.
§ SQL St at ist ics: Read SQL statistics. This will show the number of
batch requests, SQL compilations, and SQL re-compilations, per
second.

27.11.2012 1609
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

SQL Count er Specific

Depending on your selection, a sensor with the specified channels


will be created. Note: In order to monitor several performance
counters for an instance, please add the sensor several times.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SQL Server Set t ings

Service Shows the service monitored by this sensor. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Name Shows the name of the server instance monitored by this sensor.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

WMI Class Name Select whether PRTG will select the name of the WMI class used for
monitoring automatically. Choose between:

1610 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

SQL Server Set t ings

§ Aut omat ic: Choose WMI class automatically. This is the


recommended setting.
§ Manual: Manually enter a WMI class name. Use this if your server
instance returns an error code in automatic mode.

WMI Class This field is only shown if manual WMI class selection is enabled
above. This setting is intended for experienced users only. Enter
the WMI class name that will be used for monitoring your server
instance.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
(ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

27.11.2012 1611
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1612 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

27.11.2012 1613
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
199 WMI Microsoft SQL Server 2008 Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1614 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

6.8.200 WM I M icrosoft SQL Server 2012 Sensor

The WMI Microsoft SQL Server sensor monitors the performance of a Microsoft SQL server via
Windows Management Instrumentation (WMI). This sensor can monitor SQL General
St at ist ics, Access Met hods, the Buffer Manager, the Memory Manager, the Locks
Manager, and SQL St at ist ics. The channels actually available for a sensor depend on which
performance counters you choose during setup.

Channel Overview

User Connections Number of user connections. Because each user connection


consumes some memory, configuring overly high numbers of user
connections could affect throughput. Set user connections to the
maximum expected number of concurrent users.

Logins Total number of logins started per second.

Logouts Total number of logout operations started per second.

Full Scans Number of unrestricted full scans per second. These can be either
base-table or full-index scans.

Page Splits Number of page splits per second that occur as the result of
overflowing index pages.

Table Lock Escalations Number of times locks on a table were escalated.

Buffer Cache Hit Ratio Percentage of pages found in the buffer cache without having to
read from disk. The ratio is the total number of cache hits divided
by the total number of cache lookups since an instance of SQL
Server was started. 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.

Database Pages Number of pages in the buffer pool with database content.

Stolen Pages Number of pages used for miscellaneous server purposes


(including procedure cache).

Page Life Expectancy Number of seconds a page will stay in the buffer pool without
references.

Connection Memory Total amount of dynamic memory the server is using for maintaining
(KB) connections.

21.12.2012 1615
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

Channel Overview

Optimizer Memory (KB) Total amount of dynamic memory the server is using for query
optimization.

Total Server Memory Total amount of dynamic memory (in kilobytes) that the server is
(KB) using currently.

Target Server Memory Total amount of dynamic memory the server can consume.
(KB)

SQL Cache Memory Total amount of dynamic memory the server is using for the
(KB) dynamic SQL cache.

Lock Requests Number of new locks and lock conversions per second requested
from the lock manager.

Deadlocks Number of lock requests per second that resulted in a deadlock.

Average Wait Time Average amount of wait time (in milliseconds) for each lock request
that resulted in a wait.

Batch Requests Number of Transact-SQL command batches received per second.


This statistic is affected by all constraints (such as I/O, number of
users, cache size, complexity of requests, and so on). High batch
requests mean good throughput.

SQL Compilations Number of SQL compilations per second. Indicates the number of
times the compile code path is entered. Includes compiles due to
recompiles. After SQL Server user activity is stable, this value
reaches a steady state.

SQL Re-Compilations Number of SQL recompiles per second. Counts the number of
times recompiles are triggered. In general, you want the recompiles
to be low.

Note: This sensor can only be added to a device (computer) running a Microsoft SQL database.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

1616 21.12.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

SQL Server Set t ings

MS SQL Server You see a list of all server instances available on the device. Display
Instance name and service name are provided as returned by the SQL
server. Please choose one or more instances by adding a check
mark in front of the respective line. For each instance one sensor
will be created.

SQL Server Version Enter the version of the SQL server. Usually, you can keep the
default value.

SQL Count er Specific

SQL Performance You see a list of different performance counters which can be
Counters monitored for the instance(s) selected above. The sensors created
for the server instances will all monitor the performance counter
you select here. Choose from:
§ General St at ist ics: Read general performance counters. This will
show the number of user connections, and the number of logins
and logouts per second.
§ Access Met hods: Read access method counters. This will show
the number of full scans, page splits, and table lock escalations,
per second.
§ Buffer Manager: Read buffer manager counters. This will show
the buffer cache hit ratio in percent, and the number of database
pages and stolen pages.
§ Memory Manager: Read memory manager counters. This will
show the connection memory, optimizer memory, total server
memory, target server memory, and SQL cache memory, in KB.
§ Locks: Read locks counters. This will show the number of lock
requests and deadlocks, per second, and the average wait time.
§ SQL St at ist ics: Read SQL statistics. This will show the number of
batch requests, SQL compilations, and SQL re-compilations, per
second.

21.12.2012 1617
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

SQL Count er Specific

Depending on your selection, a sensor with the specified channels


will be created. Note: In order to monitor several performance
counters for an instance, please add the sensor several times.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

SQL Server Set t ings

Service Shows the service monitored by this sensor. Once a sensor is


created this value cannot be changed. It is shown for reference
purposes only. If you need to change this, please add the sensor
anew.

Name Shows the name of the server instance monitored by this sensor.
Once a sensor is created this value cannot be changed. It is shown
for reference purposes only. If you need to change this, please add
the sensor anew.

WMI Class Name Select whether PRTG will select the name of the WMI class used for
monitoring automatically. Choose between:

1618 21.12.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

SQL Server Set t ings

§ Aut omat ic: Choose WMI class automatically. This is the


recommended setting.
§ Manual: Manually enter a WMI class name. Use this if your server
instance returns an error code in automatic mode.

WMI Class This field is only shown if manual WMI class selection is enabled
above. This setting is intended for experienced users only. Enter
the WMI class name that will be used for monitoring your server
instance.

Sensor Result Define what will be done with the results the sensor receives.
Choose between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
(ID].t xt "): Store the last result received to the "Logs (Sensors)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

21.12.2012 1619
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

1620 21.12.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

21.12.2012 1621
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
200 WMI Microsoft SQL Server 2012 Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1622 21.12.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
201 WMI Process Sensor

6.8.201 WM I Process Sensor

The WMI Process sensor monitors a Windows process using Windows Management
Instrumentation (WMI). It shows the absolute working set and commit size, the number of
threads and handles, as well as the average CPU usage (if there are multiple instances running)
and the total CPU usage of the process.

For the "total CPU usage" value of a process, all CPU usage values are summed up. The total is
divided by the number of all CPUs; the maximum value is 100%. This corresponds to the CPU
usage of all instances of this specific process. Regarding the "per instance" value, the summed
up CPU usage value is divided by the number of all instances. It shows the average CPU usage
of a single instance of the process on one CPU.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

04.12.2012 1623
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
201 WMI Process Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Process Monit or

Executable Enter the name of the process that will be monitored. Please enter
the name of an executable file without the .exe extension. The
sensor will be set to an error state if the process is not active on
the device.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1624 04.12.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
201 WMI Process Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

04.12.2012 1625
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
201 WMI Process Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1626 04.12.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
201 WMI Process Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

04.12.2012 1627
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
201 WMI Process Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1628 04.12.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
202 WMI Remote Ping Sensor

6.8.202 WM I Remote Ping Sensor

The WMI Remote Ping sensor connects remotely to a Windows system using Windows
Management Instrumentation (WMI), then performs an Internet Control Message Protocol
(ICMP) echo request ("Ping") from this device to a specified target. The sensor shows the Ping
time from the remote device to the target device that is being pinged.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

27.11.2012 1629
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
202 WMI Remote Ping Sensor

WMI Remot e Ping Configurat ion

Target Enter the DNS name or IP address of the target device the Ping is
sent to. The sensor will remotely connect to the parent device it is
created on via WMI, then perform a Ping request from this remote
device to the target device/server. Please enter a string.

Timeout (Seconds) Enter a timeout in seconds for the Ping. If the reply takes longer
than this value the request is aborted and an error message is
triggered. Please enter an integer value. The maximum is 300.

Packet Size (Bytes) Enter the packet size in bytes for the Ping. You can choose any
value between 1 and 10000. Please enter an integer value. We
recommend using the default value.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

1630 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
202 WMI Remote Ping Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

27.11.2012 1631
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
202 WMI Remote Ping Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1632 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
202 WMI Remote Ping Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 1633
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
203 WMI Security Center Sensor

6.8.203 WM I Security Center Sensor

The WMI Security Center sensor monitors the security status of a Windows computer using
Windows Management Instrumentation (WMI). It can monitor all security products that are
controlled by Windows Security Center / Windows Action Center. It returns a status code of
the monitored product and sets the sensor status to Warning if a product status is unknown,
if it is reported as out of date, or if the access scan is disabled. A sensor status showing Up
indicates that the product is up to date and the access scan is running.

Possible return values for status codes are:

St at us Code Meaning: St at us of Monit ored Will Result in Sensor St at us


Securit y Product Is ...

0 Unknown Warning

1 Not running, Out of date Warning

2 Running, Out of date Warning

3 Not running, Up to date Warning

4 Running, Up to date OK

Note: This sensor requires Windows XP SP2 or later on the target computer. The Windows
Security Center / Windows Action Center is only available on client Windows versions.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

1634 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
203 WMI Security Center Sensor

WMI Securit y Cent er Specific

Security Center You see a list showing the Name and Ty pe of all security products
Products found in the Windows Security Center on the target device. If there
are no products, you will see a corresponding message. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Securit y Cent er Specific

Display Name Shows the name of the product monitored by this sensor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Type Shows the type of the product monitored by this sensor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

14.01.2014 1635
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
203 WMI Security Center Sensor

WMI Securit y Cent er Specific

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
· Ignore changes: No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

1636 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
203 WMI Security Center Sensor

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.

14.01.2014 1637
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
203 WMI Security Center Sensor

Schedules, Dependencies, and Maint enance Window

§ Select object : Pause the current sensor if the device it is


created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1638 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
203 WMI Security Center Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

14.01.2014 1639
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
204 WMI Service Sensor

6.8.204 WM I Service Sensor

The WMI Service sensor monitors a Windows service using Windows Management
Instrumentation (WMI). It shows the execution time of the monitoring request. Additionally, it
can show CPU and pagefile usage, the number of handles and threads, and the working set of
the monitored service. You can monitor these channels if you enable Monit or ext ended
values in the sensor settings.

Note: The "Running (msec)" channel of this sensor shows the execution time of the monitoring
request. It does not refer to the time the Windows service has been running! As of PRTG
version 13, the name of this sensor channel is Sensor Execut ion Time.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one service multiple sensors are created at once in the Add Sensor
dialog.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Service Monit or

Service A list of all available items is shown with their name. Select the
desired items by adding check marks in front of the respective
lines. One sensor will be created for each selection. You can also
select and deselect all items by using the check box in the table
head. Name and description are provided in the language of the
device's Windows installation. Later on, a sensor's status will be set
to Down if the service is not running.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

1640 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
204 WMI Service Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Service Monit or

If Service is Not Select whether the service will be (re-)started if it is stopped or


Running paused. Choose between:
§ St art /Rest art service (default ): PRTG will try to start the
service if it is not running when scanning the device.
§ Do not hing: PRTG will not start any service on the device
automatically.

Monitoring Select whether you want to monitor CPU usage and other useful
performance counters. This may cause a "Class not found" error on
some Windows systems. If you do not monitor these counters, the
value '0' is returned for these channels. Choose between:
§ Just check if services is running: PRTG will only monitor the
channel "Sensor Execution Time".
§ Monit or ext ended values: PRTG will monitor also other useful
performance counters.

Service Shows the Windows service this sensor will monitor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

24.10.2013 1641
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
204 WMI Service Sensor

WMI Service Monit or

Description Shows the description for the service. Once a sensor is created
this value cannot be changed. It is shown for reference purposes
only. If you need to change this, please add the sensor anew.

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the sensor result.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received from the sensor to the
"Logs (Sensor)" directory (on the Master node, if in a cluster). File
name: Result of Sensor [ID].txt. This is for debugging purposes.
The file will be overridden with each scanning interval. For
information on how to find the folder used for storage, please
see Dat a St orage 2074 section.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

1642 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
204 WMI Service Sensor

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

24.10.2013 1643
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
204 WMI Service Sensor

Schedules, Dependencies, and Maint enance Window

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1644 24.10.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
204 WMI Service Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

24.10.2013 1645
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
205 WMI Share Sensor

6.8.205 WM I Share Sensor

The WMI Share sensor monitors a shared resource on a Windows system using Windows
Management Instrumentation (WMI). It shows the availability; you can set a sensor to Down
status for different share status messages.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one share multiple sensors are created at once in the Add Sensor
dialog. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Shared Recource

Share Select the shares you want to add a sensor for. A list of all available
items is shown with their name. Select the desired items by adding
check marks in front of the respective lines. One sensor will be
created for each selection. You can also select and deselect all
items by using the check box in the table head. Note: In order to
provide any shares, the LanmanServer "Server" Windows service
must be running on the target computer. If it is not, there are no
shares and you will see a No Share available message here.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

1646 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
205 WMI Share Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Shared Recource

Shared Recource
Shows information about the shared resource monitored by this
Description sensor. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
Type please add the sensor anew.

TypeID

Trigger Errorst at e on following condit ions

Select under which conditions the sensor will change to a Down status from the list below.
As long as the share returns OK, the sensor status will be Up. Choose a Down condition by
adding a check mark symbol in front of the according line. Please choose none, one, or
several from the following conditions. Note: While in Down status, a sensor does not record
any data in all of its channels.

Error Set sensor to Down status if the share returns an error status. A
share in this status is not operational.

Degraded Set sensor to Down status if the share returns a degraded status.
A share in this status is still operational.

Unknown Set sensor to Down status if the share returns an unknown status.

14.01.2014 1647
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
205 WMI Share Sensor

Trigger Errorst at e on following condit ions

Pred Fail Set sensor to Down status if the share returns a "predicted fail"
status. This indicates that an element is functioning properly but is
predicting a failure (for example, a SMART-enabled hard drive). A
share in this status is still operational.

Starting Set sensor to Down status if the share returns a starting status. A
share in this status is not operational.

Stopping Set sensor to Down status if the share returns a stopping status. A
share in this status is not operational.

Service Set sensor to Down status if the share returns a service status.
This can apply during disk mirror-resilvering, reloading a user
permissions list, or other administrative work on the monitored
device. Not all such work is online, but the managed element is
neither OK nor in one of the other states. A share in this status is
not operational.

Stressed Set sensor to Down status if the share returns a stressed status.

Nonrecover Set sensor to Down status if the share returns a "non recover"
status.

NoContact Set sensor to Down status if the share returns a "no contact"
status.

LostComm Set sensor to Down status if the share returns "lost


communication" status.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.

1648 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
205 WMI Share Sensor

Sensor Display

§ St ack channels on t op of each ot her: Stack channels on top of


each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

14.01.2014 1649
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
205 WMI Share Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

1650 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
205 WMI Share Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

14.01.2014 1651
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
205 WMI Share Sensor

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1652 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
206 WMI SharePoint Process Sensor

6.8.206 WM I SharePoint Process Sensor

The WMI SharePoint Process sensor monitors a Microsoft SharePoint server using Windows
Management Instrumentation (WMI). It shows the number of current page requests, active
threads, and SQL queries currently executed, as well as global heap size, object cache always
live size, template cache size, and CPU utilization.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

If you select more than one SharePoint process, multiple sensors are created at once in the
Add Sensor dialog. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Process Monit or

SharePoint Processes You see a list of all SharePoint processes running on this device.
There is also a "_Total" process available. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

07.02.2013 1653
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
206 WMI SharePoint Process Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Process Monit or

SharePoint Process The name of the SharePoint process that is monitored by this
sensor. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1654 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
206 WMI SharePoint Process Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

07.02.2013 1655
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
206 WMI SharePoint Process Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1656 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
206 WMI SharePoint Process Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

07.02.2013 1657
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
206 WMI SharePoint Process Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1658 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
207 WMI Terminal Services (Windows 2008) Sensor

6.8.207 WM I Terminal Services (Windows 2008) Sensor

The WMI Terminal Services sensor monitors the number of sessions on a Windows Terminal
Services (Remote Desktop Services) server using Windows Management Instrumentation
(WMI). It shows the number of active and total sessions. Active sessions are sessions with a
currently logged in user; inactive sessions (included in total) can be sessions with a
disconnected user that has not logged out, or system services using a session. Note: As "Total
Sessions", this sensor type will return the number of the active sessions, plus two additional
sessions: one for the console, and another for the services. So, the number of total sessions
may actually be higher than expected.

Note: Depending on the OS that will be monitored, please select either the sensor for
Windows XP/Vista/2003 or the one for Windows 2008.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

27.11.2012 1659
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
207 WMI Terminal Services (Windows 2008) Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

1660 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
207 WMI Terminal Services (Windows 2008) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

27.11.2012 1661
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
207 WMI Terminal Services (Windows 2008) Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1662 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
207 WMI Terminal Services (Windows 2008) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 1663
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
208 WMI Terminal Services (Windows XP/Vista/2003) Sensor

6.8.208 WM I Terminal Services (Windows XP/Vista/2003) Sensor

The WMI Terminal Services sensor monitors the number of sessions on a Windows Terminal
Services (Remote Desktop Services) server using Windows Management Instrumentation
(WMI). It shows the number of active and total sessions. Active sessions are sessions with a
currently logged in user; inactive sessions (included in total) can be sessions with a
disconnected user that has not logged out, or system services using a session. Note: As "Total
Sessions", this sensor type will return the number of the active sessions, plus two additional
sessions: one for the console, and another for the services. So, the number of total sessions
may actually be higher than expected.

Note: Depending on the OS that will be monitored, please select either the sensor for
Windows XP/Vista/2003 or the one for Windows 2008.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

1664 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
208 WMI Terminal Services (Windows XP/Vista/2003) Sensor

Basic Sensor Set t ings

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

27.11.2012 1665
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
208 WMI Terminal Services (Windows XP/Vista/2003) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

1666 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
208 WMI Terminal Services (Windows XP/Vista/2003) Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

27.11.2012 1667
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
208 WMI Terminal Services (Windows XP/Vista/2003) Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1668 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
209 WMI UTC Time Sensor

6.8.209 WM I UTC Time Sensor

The WMI UTC Time sensor monitors the UTC time of a target device using Windows
Management Instrumentation (WMI). It shows the UTC time of the target device, and the time
difference between the PRTG system time and the target device, in seconds.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

27.11.2012 1669
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
209 WMI UTC Time Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1670 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
209 WMI UTC Time Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

27.11.2012 1671
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
209 WMI UTC Time Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1672 27.11.2012
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
209 WMI UTC Time Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

27.11.2012 1673
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
210 WMI Vital System Data (V2) Sensor

6.8.210 WM I Vital Sy stem Data (V2) Sensor

The WMI Vital System Data sensor monitors vital system parameters (CPU, system, memory,
disk, network, pagefile, etc.) using Windows Management Instrumentation (WMI).

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

Vit al Sy st em Dat a Readings Accessible Using WMI

Performance Counter You see a list of available vital system data values the sensor can
monitor on the target device. The available options depend on
your configuration. PRTG shows all possible performance counters
with name and instance description (if available). Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.
You can choose between the following counters:
§ CPU
§ Thread
§ Memory
§ Net work
§ Pagefile

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

1674 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
210 WMI Vital System Data (V2) Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Readings Accessible Using WMI

Display Name These fields show the parameters that are used to query data for
this sensor from the target device.Once a sensor is created this
Instance value cannot be changed. It is shown for reference purposes only.
If you need to change this, please add the sensor anew.

WMI Class

Counter

Time Stamp

Time Frequency

Counter Type

Sensor Result Define what will be done with the result of the sensor. Choose
between:
§ Discard sensor result : Do not store the results.
§ Writ e sensor result t o disk (Filename: "Result of Sensor
[ID].t xt "): Store the last result received to the "Logs (System)"
directory (on the Master node, if in a cluster). This is for
debugging purposes. The file will be overridden with each
scanning interval. For information on how to find the folder used
for storage, please see Dat a St orage 2074 section.

12.05.2014 1675
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
210 WMI Vital System Data (V2) Sensor

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

1676 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
210 WMI Vital System Data (V2) Sensor

Schedules, Dependencies, and Maint enance Window

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.

12.05.2014 1677
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
210 WMI Vital System Data (V2) Sensor

Schedules, Dependencies, and Maint enance Window

Note: Testing your dependencies is easy! Simply choose Simulat e


Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1678 12.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
210 WMI Vital System Data (V2) Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

12.05.2014 1679
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
211 WMI Volume Sensor

6.8.211 WM I Volume Sensor

The WMI Volume sensor monitors the free disk space on one drive or one logical volume using
Windows Management Instrumentation (WMI). It shows the space in percent and total. For each
drive or logical volume, one sensor is used.

This sensor monitors an area of storage on a hard disk. It can monitor local volumes that are
formatted, unformatted, mounted, or offline. A volume is formatted by using a file system, such
as File Allocation Table (FAT) or New Technology File System (NFTS), and might have a drive
letter assigned to it. One hard disk can have multiple volumes, and volumes can span multiple
physical disks. The sensor does not support disk drive management.

Note: This sensor is not supported on Windows XP and earlier.

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

For devices with multiple volumes multiple sensors are created at once in the Add Sensor
dialog. The settings you make in this dialog are valid for all of the sensors that are created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

WMI Volume Specific

Volumes Select the volume(s) you want to add a sensor for. A list of all
available items is shown with their name. Select the desired items
by adding check marks in front of the respective lines. One sensor
will be created for each selection. You can also select and deselect
all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

1680 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
211 WMI Volume Sensor

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

WMI Volume Specific

DeviceID Shows the id of the volume that this sensor is monitoring. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Drive Type Shows the type of the drive the sensor is monitoring. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

Timeout (sec) Enter a timeout in seconds for the WMI request. If the reply takes
longer than this value the request is aborted and an error message
is triggered.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.

07.02.2013 1681
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
211 WMI Volume Sensor

Sensor Display

§ Show channels independent ly (default ): Show an own graph


for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

1682 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
211 WMI Volume Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

07.02.2013 1683
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
211 WMI Volume Sensor

Schedules, Dependencies, and Maint enance Window

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

1684 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
211 WMI Volume Sensor

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1685
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
212 WMI Volume Fragmentation Sensor

6.8.212 WM I Volume Fragmentation Sensor

The WMI Volume Fragmentation sensor monitors the fragmentation of a logical volume via
Windows Management Instrumentation (WMI). It can show if a defragmentation is recommended
on the volume, the number of average fragments per file, the number of excess fragments in
total, the number of fragmented files in total, and file fragmentation in percent.

Note: This sensor is not supported on Windows XP and earlier.

This sensor type uses lookups to determine the status values of some sensor channels. For
details, please see section Define Lookups 2039 .

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on.

Note: Sensors using the Windows Management Instrumentation (WMI) protocol have high
impact on the system performance! Try to stay below 200 WMI sensors per probe 77 . Above
this number, please consider using multiple Remot e Probes 2050 for load balancing.

For a general introduction to the technology behind WMI, please see Monit oring via WMI 1959

section.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 4.0 (with latest update).

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

In order to monitor fragmentation on volumes, PRTG will create one sensor for each volume
you choose. The settings you make in this dialog are valid for all of the sensors that are
created.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the
sensor's settings page:

1686 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
212 WMI Volume Fragmentation Sensor

WMI Volume Specific

Volume Select one or more volumes you want to add a sensor for. A list of
all available items is shown with their name. Select the desired
items by adding check marks in front of the respective lines. One
sensor will be created for each selection. You can also select and
deselect all items by using the check box in the table head.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

14.01.2014 1687
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
212 WMI Volume Fragmentation Sensor

WMI Volume Specific

DeviceID Shows the unique identifier of the volume monitored by this


sensor. Once a sensor is created this value cannot be changed. It
is shown for reference purposes only. If you need to change this,
please add the sensor anew.

Drive Type Shows the type of the disk drive monitored by this sensor. Once a
sensor is created this value cannot be changed. It is shown for
reference purposes only. If you need to change this, please add
the sensor anew.

ID Selection Specify the way the volume is identified. Choose between:


§ Use sy st em device ID (recommended): This is usually the best
option for this sensor type, because the device ID will not
change when the volume is renamed.
§ Use drive let t er: In a Microsoft cluster environment, the device
ID will change when the cluster is switched to another node. In
this case, use the drive letter option to avoid issues regarding
this.

Drive Letter This field is only visible when the drive letter option is selected
above. Enter the letter of the drive you want to monitor followed
by a trailing colon, for example, C:.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1688 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
212 WMI Volume Fragmentation Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

14.01.2014 1689
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
212 WMI Volume Fragmentation Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1690 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
212 WMI Volume Fragmentation Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

14.01.2014 1691
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
212 WMI Volume Fragmentation Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1692 14.01.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
213 WMI Windows Version Sensor

6.8.213 WM I Windows Version Sensor

The WMI Windows Version sensor reads the Windows version of the parent device via
Windows Management Instrumentation (WMI). It returns the version number (in a channel) as
well as the according version name (in the sensor message).

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

07.02.2013 1693
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
213 WMI Windows Version Sensor

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
· Ignore changes (default ): No action will be taken on change.
· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

1694 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
213 WMI Windows Version Sensor

Sensor Display

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

07.02.2013 1695
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
213 WMI Windows Version Sensor

Schedules, Dependencies, and Maint enance Window

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.
§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

1696 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
213 WMI Windows Version Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

07.02.2013 1697
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
213 WMI Windows Version Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

1698 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
214 WSUS Statistics Sensor

6.8.214 WSUS Statistics Sensor

The WSUS Statistics sensor monitors various statistics on a Windows Server Update Services
(WSUS) server using Windows Management Instrumentation (WMI).

It can show the number of: Approved updates, computers having update errors, computers
needing updates, computers not synchronized for 7 days, computers registered, computers up
to date, declined updates, expired updates, not approved critical or security updates, not
approved updates, total updates, unapproved needed updates, updates needed by computers,
updates needing files, updates up to date, updates with client errors, updates with server
errors, updates with stale update approvals, and the number of WSUS infrastructure updates
not approved for installation.

Note: This sensor type can have a high impact on the performance of your monitoring system.
Please use it with care! We recommend using not more than 50 sensors, on each probe, of this
type of sensor.

Requirement: .NET Framework

This sensor type requires the Microsoft .NET Framework to be installed on the computer
running the PRTG probe: Either on the local system (on every node, if on a cluster probe), or
on the system running the remote probe 2050 . If the framework is missing, you cannot create
this sensor. Note: You need to install the exact version required (a higher version will usually
not work; an exception applies to .NET 3.5 which comprises .NET 2.0 and .NET 3.0). Generally, it
is possible to run several .NET Framework versions on the same machine side-by-side. Please
install the latest update available for the required version.

Required .NET version: 2.0.

Requirement: Windows Credentials

For this sensor type credentials for Windows systems must be defined for the device you want
to use the sensor on. In the parent device's 276 Credent ials for Windows Sy st ems settings,
please prefer using Windows domain credentials.

Note: If you use local credentials, please make sure the same Windows user accounts (with
same username and password) exist on both the system running the PRTG probe and the
target computer. Otherwise the sensor cannot connect correctly.

Note: Your Windows credentials may not contain any double quotation marks ("). If they do,
this sensor will not work!

Requirement: WSUS 3.0 Administration Console

In order for this sensor to work, Microsoft's WSUS 3.0 Administration Console must be
installed on the computer running the PRTG probe: Either on the local system (on every node,
if on a cluster probe), or on the system running the remote probe.

07.02.2013 1699
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
214 WSUS Statistics Sensor

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually 220 . It only
shows the setting fields that are imperative for creating the sensor. Therefore, you will not see
all setting fields in this dialog. You can change all settings in the sensor's Set t ings tab later.

Sensor Settings

On the sensor's details page, click on the Set t ings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name
defined in the settings of the parent device the sensor is created on.

Basic Sensor Set t ings

Sensor Name Enter a meaningful name to identify the sensor. The name will be
shown by default in the device tree and in all alarms.

Tags Enter one or more tags, separated by space or comma. You can
use tags to group sensors and use tag-filtered views later on. Tags
are not case sensitive. We recommend using the default value. You
can add additional tags to it, if you like. Other tags are
automatically inherited 89 from objects further up in the device
tree. Those are not visible here.

Priority Select a priority for the sensor. This setting determines where the
sensor will be placed in sensor lists. Top priority will be at the top
of a list. You can choose from one star (low priority) to five stars
(top priority).

Sensor Set t ings

WSUS Server Port Define the port where the WSUS server service is running on.
Default value is 80. Please enter an integer value.

Use SSL Define if SSL-encryption will be used for the connection to the
WSUS server. Choose between:
§ Yes
§ No

If Value Changes Define what will be done in case the value of this sensor changes.
You can choose between:
· Ignore changes: No action will be taken on change.

1700 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
214 WSUS Statistics Sensor

Sensor Set t ings

· Trigger 'change' not ificat ion: The sensor will send an internal
message indicating that its value has changed. In combination
with a Change Trigger, you can use this mechanism to trigger a
notification 1716 whenever the sensor value changes.

Sensor Display

Primary Channel Select a channel from the list to define it as the primary channel. In
the device tree, the last value of the primary channel will always be
displayed underneath the sensor's name. The available options
depend on what channels are available for this sensor. Note: You
can set another primary channel later by clicking on the pin symbol
of a channel in the sensor's overview tab.

Chart Type Define how different channels will be shown for this sensor.
§ Show channels independent ly (default ): Show an own graph
for each channel.
§ St ack channels on t op of each ot her: Stack channels on top of
each other to create a multi-channel graph. This will generate an
easy-to-read graph which visualizes the different components of
your total traffic. Note: This option cannot be used in
combination with manual Vertical Axis Scaling (available in the
Sensor Channels Set t ings 1709 settings).

Stack Unit This setting is only available if stacked graphs are selected above.
Choose a unit from the list. All channels with this unit will be
stacked on top of each other. By default, you cannot exclude
single channels from stacking, if they use the selected unit.
However, there is an advanced procedure to do so.

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should
be changed there, if necessary. Often, best practice is to change them centrally in the Root 224
group's settings. To change a setting for this object, disable inheritance by clicking on the
check mark symbol in front of the respective setting name. You will then see the options
described below.

Scanning Int erval

Scanning Interval The scanning interval determines the time the sensor waits
between two scans. Select a scanning interval (seconds, minutes,
or hours) from the list. You can change the available intervals in
the system administration 1839 .

07.02.2013 1701
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
214 WSUS Statistics Sensor

Schedules, Dependencies, and Maint enance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be


interrupted; the according settings from the parent objects will always be active. However,
you can define additional settings here. They will be active in parallel to the parent objects'
settings.

Schedule Select a schedule from the list. Schedules can be used to monitor
for a certain time span (days, hours) throughout the week. With the
period list option it is also possible to pause monitoring for a
specific time span. You can create new schedules and edit existing
ones in the account settings 1817 . Note: Schedules are generally
inherited. New schedules will be added to existing ones, so all
schedules are active.

Maintenance Window Specify if you want to set-up a one-time maintenance window.


During a maintenance window this object and all child objects will
not be monitored. They will enter a paused state then. Choose
between:
§ Not set (monit or cont inuously ): No maintenance window will
be set.
§ Set up a one-t ime maint enance window: Pause monitoring
within a maintenance window.

Maintenance Begins At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the start date and time of the
maintenance window.

Maintenance End At This field is only visible if maintenance window is enabled above.
Use the date time picker to enter the end date and time of the
maintenance window.

Dependency Type Define a dependency type. Dependencies can be used to pause


monitoring for an object depending on the status of another. You
can choose between:
§ Use parent : Pause the current sensor if the device it is created
on is in a Down status, or if it is paused by another dependency.
§ Select object : Pause the current sensor if the device it is
created on is in an Down status, or if it is paused by another
dependency. Additionally, pause the current sensor if a specific
other object in the device tree is in a Down status, or if it is
paused by another dependency. Select below.

1702 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
214 WSUS Statistics Sensor

Schedules, Dependencies, and Maint enance Window

§ Mast er object for parent : Make this sensor the master object
for its parent device. The sensor will influence the behavior of
the device it is created on: If the sensor is in a Down status, the
device will be paused. For example, it is a good idea to make a
Ping sensor the master object for its parent device to pause
monitoring for all other sensors on the device in case the device
cannot even be pinged. Additionally, the sensor will be paused if
the parent group of its parent device is in a Down status, or if it
is paused by another dependency.
Note: Testing your dependencies is easy! Simply choose Simulat e
Error St at us from the context menu of an object that other
objects depend on. A few seconds later all dependent objects
should be paused.

Dependency This field is only visible if the select object option is enabled above.
Click on the reading-glass symbol and use the object selector 159
to choose an object on which the current sensor will be
dependent on.

Delay (Seconds) Define a time span. After the master object for this dependency
comes back to an Up status, monitoring of the depending objects
will be additionally delayed by the defined time span. This can help
avoid false alarms, for example, after a server restart, by giving
systems more time for all services to start up. Please enter an
integer value in seconds. Note: This setting is not available if you
choose this sensor to be the Mast er object for parent . In this
case, please define delays in the parent Device Set t ings 272 or the
superior Group Set t ings 253 .

07.02.2013 1703
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
214 WSUS Statistics Sensor

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Channel Unit Configurat ion

Channel Unit Types For each type of sensor channel, define the unit in which data is
displayed. If defined on probe, group, or device level, these
settings can be inherited to all sensors underneath. You can set
units for the following channel types (if available):
§ Bandwidt h
§ Memory
§ Disk
§ File
§ Cust om
Note: Custom channel types can be set on sensor level only.

1704 07.02.2013
Part 6: Ajax Web Interface—Device and Sensor Setup | 8 Sensor Settings
214 WSUS Statistics Sensor

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's
Overview tab and click on the gear icon of a specific channel. For detailed information, please
see Sensor Channels Set t ings 1709 section.

Notifications

Click on the Not ificat ions tab to change notification triggers. For detailed information, please
see Sensor Not ificat ions Set t ings 1716 section.

Others

For more general information about settings, please see Object Set t ings 142 section.

07.02.2013 1705
Part 6: Ajax Web Interface—Device and Sensor Setup | 9 Additional Sensor Types (Custom Sensors)

6.9 Additional Sensor Types (Custom Sensors)


Users can create and use their own, self-written custom sensors in PRTG Network Monitor to
go far beyond PRTG's standard sensor set. You can create your own sensors using Windows
Management Instrumentation Query Language (WQL), visual basic scripting, PowerShell, batch
scripting, and by compiling an EXE or DLL file (using any Windows software development tool).

Basics

For a general introduction, please see the sections about EXE/Script sensors and the API
documentation which contains details about the necessary return format for those sensors.
WMI Custom sensors allow executing WQL requests.

§ EX E/Script Sensor 431

§ EX E/Script Advanced Sensor 440

§ SSH Script Sensor 1341

§ Applicat ion Programming Int erface (API) Definit ion 2031

§ WMI Cust om Sensor 1529

Custom Sensors Included in PRTG

After installing PRTG Network Monitor you will already find a selection of custom EXE/Script
and WMI WQL script sensors in the PRTG program directory 2074 . Many of these are sample
projects that you can edit and improve for your needs.

Custom Sensors Included in PRTG—Folder: \Custom Sensors\EXE


§ Demo Batchfile - Returns 200.bat
§ Demo Batchfile - Set sensorstate to error.bat
§ Demo Batchfile - Set sensorstate to warning.bat
§ Demo Cmd - Returns 200.cmd
§ Demo Dll - Returns a random integer.dll
§ Demo EXE - Returns a random integer.exe
§ Demo EXE - Returns number of files in folder (parameter).exe
§ Demo EXE - Returns user of process.exe
§ Demo Powershell Script - Available MB via WMI.ps1
§ Demo Powershell Script - InterruptsPerSec via WMI.ps1
§ Demo Powershell Script - Returns a fixed integer value.ps1
§ Demo Powershell Script - Returns a random integer value.ps1
§ Demo Powershell Script - Returns Random Integer and Warnings.ps1

1706 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 9 Additional Sensor Types (Custom Sensors)

§ Demo VBScript - InterruptsPerSec via WMI.vbs


§ Demo VBScript - Multiplies two integers(2 parameters).vbs
§ Demo VBScript - Returns a fixed float value.vbs
§ Demo VBScript - Returns a fixed integer value.vbs
§ Demo VBScript - Returns a random value.vbs
§ Demo VBScript - Returns number of svchost processes.vbs
§ Demo VBScript - Returns user of process.vbs
§ Demo VBScript - Returns warning depending on number of svchost processes.vbs
§ Demo VBScript - Timezone via WMI.vbs
§ Demo VBScript - UTCTime via WMI.vbs
§ Load_Test_CPU_1_Mio_Primes.exe
§ Load_Test_CPU_10_Mio_Primes.exe
§ Load_Test_Disk_Write_Read_1000_files.exe
§ Load_Test_Disk_Write_Read_10000_files.exe
§ Load_Test_Memory_Allocate_And_Free_400MB.exe

To create a new sensor based on one of these files, create a new EX E/Script Sensor 431 and
choose the respective file from the drop down list.

Custom Sensors Included in PRTG—Folder: \Custom Sensors\EXEXML


§ Demo Batchfile - Returns static values in four channels.bat

To create a new sensor based on one of these files, create a new EX E/Script Advanced
Sensor 440 and choose the respective file from the drop down list.

Custom Sensors Included in PRTG—Folder: \Custom Sensors\WMI WQL scripts


§ Demo WQL Script - Get Win32LogicalDiscFreeMB.wql
§ Demo WQL Script - Get Win32OsBuildnumber.wql
§ Demo WQL Script - Get Win32PercentProcessorIdleTime.wql
§ Demo WQL Script - Get Win32PercentProcessorTime.wql

To create a new sensor based on one of these files, create a new WMI Cust om Sensor 1529 and
choose the respective file from the drop down list.

Downloading Pre-Build Custom Sensors

A good resource is the PRTG Add-Ons website on the open source platform Google Code.
There are also additional tools available.

28.05.2014 1707
Part 6: Ajax Web Interface—Device and Sensor Setup | 9 Additional Sensor Types (Custom Sensors)

Open Source Add-Ons for PRTG Network Monitor


§ http://code.google.com/p/prtg-addons/

More
For the other sensor types that work out-of-the-box, please see
§ List of Available Sensor Ty pes 291

Knowledge Base: How can I test if parameters are correctly transmitted to my script when
using an EXE/Script sensor?
§ http://kb.paessler.com/en/topic/11283

1708 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 10 Sensor Channels Settings

6.10 Sensor Channels Settings


A sensor has one or more channels in which it handles the actual monitoring data. In the
channel settings you can define how the data from the sensor's different channels will be
displayed in graphs, gauges, and tables. Additionally, the channel data can determine the
sensor's status. Use the limit settings to achieve this.

On the sensor's Overview page, click on the gear icon of a specific channel gauge to change
its settings. A click on the pin symbol on the left of the gear icon in a gauge will make this
channel the primary channel of the selected sensor.

You can alternatively call the settings of a channel by clicking on the respective gear icon in
the channels data table underneath the gauges.

Note: For lookup 2039 channels, we recommend staying below 120 lookup values to get
expressive gauges. For non-primary lookup channels, the upper limit is around 40 lookup
values.

The Gear Ic on of an SNMP Traffic Total Channel to


Open Channel Settings

The available options are nearly the same for all sensor types. An exception applies to the
"Downtime" channel which is automatically calculated and does not offer all settings. Channels
with "absolute" values additionally have an option for defining the Value Mode. You can quickly
choose another channel of the selected sensor via the dropdown list on the top of the
settings dialog.

28.05.2014 1709
Part 6: Ajax Web Interface—Device and Sensor Setup | 10 Sensor Channels Settings

Channel Settings for an SNMP Traffic Sensor

Available Channel Settings

Edit Channel "[Name]"

Name Enter a meaningful name to identify the channel (not editable for
script sensors after sensor creation). The name will be shown in
graphs and tables. You can automatically add the sensor's ID to the
name by using the placeholder [#id].

Unit This field is only visible for script sensors, the SNMP Custom
sensor, and the SNMP Library sensor. Enter a string describing the
unit of the returned values. This is for display purposes only. Please
enter a string.

1710 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 10 Sensor Channels Settings

Edit Channel "[Name]"

Value Lookup This field is only visible for script sensors, the SNMP Custom
sensor, and the SNMP Library sensor. Select the lookup list to be
applied to this channel's settings.

ID The ID of the channel cannot be changed; it is used for unique


definition. For example, you need the ID when using Sensor
Fact ory 856 sensors.

Display Define where the channel will be displayed. Choose from:


§ Show in Chart s: The data of this channel will be shown in sensor
graphs. Note: If you hide a channel here, it will also be hidden if
this graph is used in a Report 1775 .
§ Show in Tables: The data of this channel will be shown in sensor
data tables. Note: If you hide a channel here, it will not be
considered for the calculation of the "sum" (total) channel of this
sensor!
To change this setting, remove or add the check mark symbol in
front of it.

Line Color Define in what color the channel will be displayed in graphs. You
can choose between
§ Aut omat ic
§ Manual
When you set this option to manual color definition please enter a
color below.

Color (#rrggbb) This option is only available if Manual is selected in the Line Color
setting above. Please either enter a color in hexadecimal RGB
notation (as in HTML/CSS), or choose a color from the visual color
selector. The field containing the hexadecimal color value will
change to the resulting color immediately in both cases.

Data This setting is available for most channels. Define how data will be
displayed. Choose between:
§ Display act ual values in [unit]: Display the values in the unit
shown.
§ Display in percent of maximum: Calculate and show percent
values based on a maximum value. Provide a maximum below.

Maximum ([unit]) This field is only visible if the percent of maximum setting is
selected above. Enter a value that will be regarded as maximum.
Please pay attention to the given unit. All percent values will be
calculated based on this value. Please enter an integer value.

28.05.2014 1711
Part 6: Ajax Web Interface—Device and Sensor Setup | 10 Sensor Channels Settings

Edit Channel "[Name]"

Line Width Define in what color the channel will be displayed in graphs. Enter
an integer value in pixels. Although the line width is not limited, we
recommend using values between 1 and 7 only in order to achieve
optimal results.

Value Mode This setting is only available for sensor channels which return
absolute values. It is not available for sensors showing difference
values, such as traffic sensors. Depending on this setting, the
channel can not only show averages, but also minimum or
maximum values in the graphs for the respective time spans.
Choose between:
§ Average: The channel shows average values.
§ Minimum: The channel shows minimum values.
§ Maximum: The channel shows maximum values.
See section More for more information.

Decimal Places Define how many decimal places of the channel's data will be
displayed in graphs and tables. Choose between:
§ Aut omat ic: Let PRTG choose how many decimal places will be
used for optimal viewing results.
§ All: Force display of all available decimal places.
§ Cust om: Manually define the number of decimal places. If you
choose this option, an additional field will appear. Please enter an
integer value there.

Spike Filter A spike filter can be used to correct obviously faulty monitoring
data. Sometimes, sensors report enormously high or far too low
values; due to an error in data transmission, or due to
incompatibilities of the physical device you are monitoring. This can
make graphs unreadable. A spike filter can compensate for these
flaws. When enabled values above and below a certain limit are
disregarded in the monitoring data for graphs and tables. Note: The
monitoring data itself will not be changed (but only the
presentation of the data) and this setting is valid for all data of this
channel (also the historic data). Choose between:
§ Disable Filt ering: Display all data as it is; do not filter out spikes.
§ Enable Filt ering: Enable a filter to remove spike values.
Additional fields appear below.
Note: The spike filter option is not available for the channel
Downt ime.

1712 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 10 Sensor Channels Settings

Edit Channel "[Name]"

Spike Filter Max. Value This field is only visible if spike filter is enabled above. Specify the
[unit] maximum value allowed in the channel's data. All values above this
value will be disregarded in graphs and tables. Please enter an
integer value or leave the field empty.

Spike Filter Min. Value This field is only visible if spike filter is enabled above. Specify the
[unit] minimum value allowed in the channel's data. All values below this
value will be disregarded in graphs and tables. Please enter an
integer value or leave the field empty.

Vertical Axis Scaling Define how the vertical axis for the channel is displayed in graphs.
Choose between:
§ Aut omat ic Scaling: Let PRTG decide on the optimum scaling;
usually ranging from the minimum to the maximum value. PRTG
will use one single scale for each unit label only.
§ Manual Scaling: Define the scaling manually. Additional fields
appear below. Defining manual axis scaling can make low values
better visible in your graph; but it may result in a chart with
multiple vertical axis for the same unit label.
Note: Settings for this option are ignored if Chart Type St ack
channels on t op of each ot her or Show in and out t raffic as
posit ive and negat ive area chart (available for traffic sensors) is
enabled in the sensor's Set t ings tab.

Vertical Axis Maximum This field is only visible if vertical axis scaling is enabled above.
[unit] Specify the maximum value that will be used on the vertical axis for
the channel. Enter an integer value.

Vertical Axis Minimum This field is only visible if vertical axis scaling is enabled above.
[unit] Specify the minimum value that will be used on the vertical axis for
the channel. Enter an integer value.

Limits The channel can affect the status of the sensor it is part of. By
entering limits, you can define when the sensor will enter a
Warning or Down status; depending on the channel's data. Using
this function, you can e.g. set a traffic sensor (which is usually
never in a down state) to error when certain limits that you
consider critical are reached.
Choose between:
§ Disable Limit s: Do not use the channel's data to control the
sensor's status.
§ Enable Limit s: Define limits. Additional fields appear below. The
sensor belonging to the channel will enter a Warning or Down
status when limits are undercut or overrun.

28.05.2014 1713
Part 6: Ajax Web Interface—Device and Sensor Setup | 10 Sensor Channels Settings

Edit Channel "[Name]"

Note: The limits option is not available for the channel "Downtime".
Note: If a channel uses lookups 2039 , we strongly recommend you to
control the sensor status only via the lookup definition. If you
define limits in addition here, the sensor will use both the channel
limits and the status as defined in the lookup file. In this case,
channel limits will determine the overall status of the sensor and
overwrite the sensor message while the channel gauge still shows
the status as defined in the lookups.

Upper Error Limit [unit] This field is only visible if limits are enabled above. Specify an upper
limit for an error state. If the channel's values overrun this value,
the sensor will be set to Down. Note: While a sensor shows a
Down 121 status triggered by a limit, it will still receive data in its
channels. Please enter a decimal value or leave the field empty.

Upper Warning Limit This field is only visible if limits are enabled above. Specify an upper
[unit] limit for a warning state. If the channel's values overrun this value,
the sensor will be set to Warning. Please enter a decimal value or
leave the field empty.

Lower Warning Limit This field is only visible if limits are enabled above. Specify a lower
[unit] limit for a warning state. If the channel's values undercut this value,
the sensor will be set to Warning. Please enter a decimal value or
leave the field empty.

Lower Error Limit [unit] This field is only visible if limits are enabled above. Specify a lower
limit for an error state. If the channel's values undercut this value,
the sensor will be set to Down. Note: While a sensor shows a
Down 121 status triggered by a limit, it will still receive data in its
channels. Please enter a decimal value or leave the field empty.

Error Limit Message This field is only visible if limits are enabled above. Enter an
additional message. It will be added to the sensor's message when
entering a Down status. Please enter a string or leave the field
empty.

Warning Limit Message This field is only visible if limits are enabled above. Enter an
additional message. It will be added to the sensor's message when
entering a Warning status. Please enter a string or leave the field
empty.

Click on Save to store your settings or Cancel your changes.

More
Knowledge Base: What is the Value Mode in channel settings?

1714 28.05.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 10 Sensor Channels Settings

§ http://kb.paessler.com/en/topic/60238

Sensor Settings Overview

For information about sensor settings, please see the following sections:

· Sensor Set t ings 290

· List of Available Sensor Ty pes 291

· Addit ional Sensor Ty pes (Cust om Sensors) 1706

· Sensor Channels Set t ings 1709

· Sensor Not ificat ions Set t ings 1716

28.05.2014 1715
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

6.11 Sensor Notifications Settings


The status or the data of a sensor can trigger notifications. Using this mechanism, you can
configure external alerting tailored to you needs.

Example of Notific ation Trigger Settings

Note: Although the sensors activate a trigger, you can set notification triggers higher in the
hierarchy (for example for groups or devices), thus defining triggers for multiple sensors using
the inheritance mechanism 87 .

Note

This section describes one of three steps to set up the notification system in PRTG. A
complete notification setup involves:

1. Check and set up the Not ificat ion Delivery settings. This will tell PRTG how to send
messages.
For detailed information, see Sy st em Administ rat ion—Not ificat ion Delivery 1843 .
2. Check and set up several Not ificat ions. This will define the kind of message and its
content.
For detailed information, see Account Set t ings—Not ificat ions 1817 .
3. Check and set up Not ificat ion Triggers for objects. These will provoke the defined
notifications.
For detailed information, see Sensor Not ificat ions Set t ings 1716 .

For background information, please see Not ificat ions 1749 section.

1716 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

Available Notification Triggers Settings

On an object's detail page, click on the Not ificat ions tab to change sensor notification
triggers. The available options are the same for all objects. When defining triggers for probes,
groups, or devices, they can be inherited down to sensor level.

Triggers t hat can be inherit ed from parent object (s)

You see a list of all notification triggers that are defined higher in the hierarchy. The list is
empty when there are no triggers defined in groups or devices above the current object.
You can see the type and the notifications that are executed once this trigger is activated.

Trigger Inheritance Define whether the triggers shown above will be handed on to the
current object. Choose between:
§ Inherit t rigger(s) from parent object (s): Use the triggers
shown above.
§ Only use t riggers defined for t his object : Do not use the
triggers shown above; for this object only use the triggers
defined below.
This setting is valid for all triggers shown above. It is not possible
to only select some of them.

You can set up one or more of the following triggers, each with different setting options.
Which trigger types will be visible depends on the kind of object you're editing:

· Add State Trigger 1717

· Add Speed Trigger 1719

· Add Volume Trigger 1721

· Add Threshold Trigger 1722

· Add Change Trigger 1724

All notification triggers can be created in a very easy way, forming natural sentences. There are
different options for every type.

Add State Trigger

Define a trigger that is activated when a sensor changes its current status. This is the most
common reason to send out notifications. Click on the Add St at e Trigger button to add a
new trigger, or click on the Edit button next to an existing notification to change it. Then
define settings as described below. Every trigger will provoke one or more notification(s) 1817 to
be executed.

03.04.2014 1717
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

St at e Trigger

When sensor is... Select the condition that will trigger the notification. The trigger will
be activated when a sensor enters the selected status. Choose
from the drop down menu:
§ Down: The trigger will be prompted if a sensor changes to a
Down status.
§ Warning: The trigger will be prompted if a sensor changes to a
Warning status.
§ Unusual: The trigger will be prompted if a sensor changes to an
Unusual status.
§ Part ial Down: The trigger will be prompted if a sensor changes
to a Down (Part ial) status (available in a cluster 81 configuration).

...for at least ... Define how many seconds will be waited before a notification is
seconds provoked. This can avoid false alarms in case a sensor 'flickers' and,
for example, changes to a down status for just a few seconds. If
the selected condition (i.e. the sensor status) persists after the
defined time in seconds, the notification will be triggered. Please
enter an integer value.

...perform... Select a notification that will be triggered if the condition (i.e. the
sensor status) selected is true and the latency time defined has
elapsed. Choose a notification from the drop down menu. The
menu shows all notifications defined in the Account Set t ings—
Not ificat ions 1817 setttings. You can also choose no not ificat ion
in order to only use other conditions for this trigger.

When condition Define an escalation latency in seconds. A second notification can


continues for at least be triggered if this number of seconds has passed since the sensor
... seconds status has entered the defined condition. Use this to automatically
escalate a notification in case a problem persists for a longer time.
Please enter an integer value.

...perform... Select a (second) notification that will be triggered if the condition


(i.e. the sensor status) selected is true and the escalation latency
time defined has elapsed. Choose a notification from the drop
down menu. The menu shows all notifications defined in the
Account Set t ings—Not ificat ions 1817 settings. You can also
choose no not ificat ion in order to only use other conditions for
this trigger.

...and repeat every ... Define an interval in minutes in which the escalation notification
minutes (defined above) will be sent repeatedly. The second (escalation)
notification defined will be resent every x minutes. Please enter an
integer value.

1718 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

St at e Trigger

When condition clears Select a notification that will be triggered if the condition (i.e. the
perform... sensor status) selected is not true any more because the sensor's
status has changed again. Choose a notification from the drop
down menu. The menu shows all notifications defined in the
Account Set t ings—Not ificat ions 1817 setttings. You can also
choose no not ificat ion in order to only use other conditions for
this trigger.

Save Click on the Save button to save your settings.

Delete Click on the Delet e button next to an existing notification trigger


to delete it.

Add Speed Trigger

Define a trigger that is activated when a sensor (for example, a traffic sensor) changes its
current speed. Click on the Add Speed Trigger button to add a new trigger, or click on the
Edit button next to an existing notification to change it. Then define settings as described
below. Every trigger will provoke one or more notification(s) 1817 to be executed.

Speed Trigger

When ... channel From the drop down menu, select the channel which's data will be
regarded for this comparison. Select Primary to generally use a
sensor's primary channel (this can be defined in the sensor's
settings 290 ) or choose a specific channel name from the list (there
are different channels for every sensor type). All following settings
for this trigger will be based on the chosen channel.

...is... Select the condition that will trigger the notification. Choose from
the drop down menu:
§ Above: The trigger will be prompted if the value of the selected
channel overruns a defined value.
§ Below: The trigger will be prompted if the value of the selected
channel undercuts a defined value.
§ Equal To: The trigger will be prompted if the value of the
selected channel is the same as a defined value.
§ Not Equal To: The trigger will be prompted if the value of the
selected channel is different than a defined value.

[value] Define the value the channel's data will be compared with. Please
enter an integer value.

03.04.2014 1719
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

Speed Trigger

[scale] From the drop down menu, select the unit in which you entered
the [value] above. [scale] and [t ime] together define the unit for
the given value. If the channel's data is shown in a different unit
PRTG will automatically convert values internally. Choose between:
§ bit
§ kbit
§ mbit
§ gbit
§ t bit
§ By t e
§ KBy t e
§ MBy t e
§ GBy t e
§ TBy t e

[time] Select the time for the scale (so you create a scale per time
designation). Choose from the drop down menu:
§ second
§ minut e
§ hour
§ day
[scale] and [t ime] together define the unit for the given value. If
the channel's data is shown in a different unit PRTG will
automatically convert values internally.

..for at least ... Define how many seconds will be waited before a notification is
seconds provoked. This can avoid false alarms in case a channel reaches a
limit for just a few moments. If the combined channel condition of
[value], [scale], and [t ime] persists after the defined time span, the
notification will be triggered. Please enter an integer value.

...perform... Select a notification that will be triggered if the combined channel


condition of [value], [scale], and [t ime] is true and the latency
time defined has elapsed. Choose a notification from the drop
down menu. The menu shows all notifications defined in the
Account Set t ings—Not ificat ions 1817 settings. You can also
choose no not ificat ion in order to only use other conditions for
this trigger.

1720 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

Speed Trigger

When condition clears Select a notification that will be triggered if the combined channel
perform... condition of [value], [scale], and [t ime] is not true any more
because the channel's value has changed again. Choose a
notification from the drop down menu. The menu shows all
notifications defined in the Account Set t ings—Not ificat ions 1817
settings. You can also choose no not ificat ion in order to only use
other conditions for this trigger.

Save Click on the Save button to save your settings.

Delete Click on the Delet e button next to an existing notification trigger


to delete it.

Note: No escalation notification and no repeat are available for this trigger type.

Add Volume Trigger

Define a trigger that is activated when a sensor (for example, a traffic sensor) reaches a certain
volume limit in a specified time. Click on the Add Volume Trigger button to add a new trigger,
or click on the Edit button next to an existing notification to change it. Then define settings
as described below. Every trigger will provoke one or more notification(s) 1817 to be executed.

Volume Trigger

When ... channel From the drop down menu, select the channel which's data will be
regarded for this comparison. Select Primary to generally use a
sensor's primary channel (this can be defined in the sensor's
settings 290 ) or choose a specific channel name from the list (there
are different channels for every sensor type). All following settings
for this trigger will be based on the chosen channel.

...has reached... [value] Define the value the channel's data will be compared with. If the
channel's data overruns this value, a notification will be triggered.
Please enter an integer value.

[scale] From the drop down menu, select the unit in which you entered
the [value] above. [scale] and [t ime] together define the unit for
the given value. If the channel's data is shown in a different unit
PRTG will automatically convert values internally. Choose between:
§ By t e
§ KBy t e
§ MBy t e
§ GBy t e

03.04.2014 1721
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

Volume Trigger

§ TBy t e

per [time] Select the time for the scale (so you create a scale per time
designation). Choose from the drop down menu:
§ Hour
§ Day
§ Week
§ Mont h
[scale] and [t ime] together define the unit for the given value. If
the channel's data is shown in a different unit PRTG will
automatically convert values internally.

...perform... Select a notification that will be triggered if the [value] in the


combined unit of [scale] and [t ime] is overrun. Choose a
notification from the drop down menu. The menu shows all
notifications defined in the Account Set t ings—Not ificat ions 1817
settings. You can also choose no not ificat ion in order to only use
other conditions for this trigger.

Save Click on the Save button to save your settings.

Delete Click on the Delet e button next to an existing notification trigger


to delete it.

Note: No escalation notification, no repeat, and no notification when condition clears are
available for this trigger type.

Add Threshold Trigger

Define a trigger that is activated when a sensor reaches specific values. Click on the Add
Threshold Trigger button to add a new trigger, or click on the Edit button next to an existing
notification to change it. Then define settings as described below. Every trigger will provoke
one or more notification(s) 1817 to be executed.

Threshold Trigger

When ... channel From the drop down menu, select the channel which's data will be
regarded for this comparison. Select Primary to generally use a
sensor's primary channel (this can be defined in the sensor's
settings 290 ) or choose a specific channel name from the list (there
are different channels for every sensor type). All following settings
for this trigger will be based on the chosen channel.

1722 03.04.2014
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

Threshold Trigger

...is... Select the condition that will trigger the notification. Choose from
the drop down menu:
§ Above: The trigger will be prompted if the value of the selected
channel overruns a defined value.
§ Below: The trigger will be prompted if the value of the selected
channel undercuts a defined value.
§ Equal To: The trigger will be prompted if the value of the
selected channel is the same as a defined value.
§ Not Equal To: The trigger will be prompted if the value of the
selected channel is different than a defined value.

[value] Define the value the channel's data will be compared with. It will be
directly compared to the channel's data. Please enter values in the
smallest possible (base) unit, for example, in bytes or seconds.
Please enter an integer value.

..for at least ... Define how many seconds will be waited before a notification is
seconds provoked. This can avoid false alarms in case a channel reaches a
limit for just a few moments. If the defined channel condition
persists after the defined time span, the notification will be
triggered. Please enter an integer value.

...perform... Select a notification that will be triggered if the defined channel


condition is true and the latency time defined has elapsed. Choose
a notification from the drop down menu. The menu shows all
notifications defined in the Account Set t ings—Not ificat ions 1817
settings. You can also choose no not ificat ion in order to only use
other conditions for this trigger.

When condition clears Select a notification that will be triggered if the defined channel
perform... condition is not true any more because the channel's value has
changed again. Choose a notification from the drop down menu.
The menu shows all notifications defined in the Account Set t ings
—Not ificat ions 1817 settings. You can also choose no not ificat ion
in order to only use other conditions for this trigger.

Save Click on the Save button to save your settings.

Delete Click on the Delet e button next to an existing notification trigger


to delete it.

Note: No escalation notification and no repeat are available for this trigger type.

03.04.2014 1723
Part 6: Ajax Web Interface—Device and Sensor Setup | 11 Sensor Notifications Settings

Add Change Trigger

Define a trigger that is activated by an 'on change' trigger. Some sensors offer the option to
send such a trigger whenever sensor values have changed. Click on the Add Change Trigger
button to add a new trigger, or click on the Edit button next to an existing notification to
change it. Then define settings as described below. Every trigger will provoke one or more
notification(s) 1817 to be executed.

Change Trigger

When sensor changes Select a notification that will be triggered whenever a compatible
perform... sensor sends a 'change notification'. You can enable this option in
the settings 290 of some sensors. The notification trigger will be
activated immediately whenever a sensor sends an 'on change'
trigger. Choose a notification from the drop down menu. The menu
shows all notifications defined in the Account Set t ings—
Not ificat ions 1817 settings.

Note: There are no other options available for this trigger type.

Sensor Settings Overview

For information about sensor settings, please see the following sections:

· Sensor Set t ings 290

· List of Available Sensor Ty pes 291

· Addit ional Sensor Ty pes (Cust om Sensors) 1706

· Sensor Channels Set t ings 1709

· Sensor Not ificat ions Set t ings 1716

Object Settings Overview

For more general information about object settings, please see section Object Set t ings 142 .

1724 03.04.2014
Part 7
Ajax Web Interface—Advanced Procedures

03.04.2014 1725
Part 7: Ajax Web Interface—Advanced Procedures |

7 Ajax Web Interface—Advanced


Procedures
The Ajax-based web interface is your access to PRTG. It is used to configure devices and
sensors, and to set up notifications, as well as to review monitoring results and to create
reports. This web interface is highly interactive, uses Asynchronous Java Script and XML (AJAX)
to deliver a powerful and easy-to-use user experience. While the user is logged in 102 , the data
on the screen is permanently refreshed (via Ajax calls) so it always shows the current
monitoring results (refresh interval and method can be set 1856 by the user).

Because the web interface works as a Single Page Application (SPA), you will rarely see a full
page refresh to avoid this performance impact due to redundant processing. Only single page
elements will be refreshed when necessary. All object setting dialogs are shown as pop-up
layers, so you will never lose the current context. This speeds up the user experience
appreciably and makes the configuration of objects in PRTG comprehensible.

The following sections introduce more advanced procedures in the Ajax Graphical User
Interface (GUI).

1726 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures |

Ajax Web Interface—Advanced Procedures—Topics


§ Toplist s 1728

§ Arrange Object s 1733

§ Clone Object 1734

§ Mult i-Edit 1736

§ Creat e Device Templat e 1741

§ Geo Maps 1744

§ Not ificat ions 1749

§ Libraries 1759

§ Report s 1775

§ Maps 1794

§ Set up 1810

Other Ajax Web Interface Sections


§ Ajax Web Int erface—Basic Procedures 100

§ Ajax Web Int erface—Device and Sensor Set up 188

Related Topics
§ Ent erprise Console 1894

§ Ot her User Int erfaces 1946

03.04.2014 1727
Part 7: Ajax Web Interface—Advanced Procedures | 1 Toplists

7.1 Toplists
Packet Sniffer and xFlow (NetFlow, jFlow, sFlow, IPFIX) sensor types can not only measure the
total bandwidth usage, they can also break down the traffic by IP address, port, protocol, and
other parameters. The results are shown in so-called Toplist s. This way PRTG is able to tell
which IP address, connection, or protocol uses the most bandwidth. PRTG looks at all network
packets (or streams) and collects the bandwidth information for all IPs, ports, and protocols. At
the end of the toplist period, PRTG stores only the top entries of each list in its database.

Only Top Entries are Stored

Storing all available analysis data in a database during the analysis process would create a huge
amount of data which would be very slow to transfer between probe and core and also
retrieving data would be too slow. By storing only the top 100 entries for short periods of
time it is possible to reduce the amount of data to a minimum while still being able to identify
devices with huge bandwidth usage.

Toplists Overview

Toplist s are available for xFlow, IPFIX, and Packet Sniffer sensors 291 only. Toplist graphs are
displayed right on the sensor overview page. By default, there are three different toplists
predefined for each sensor:

§ Top Connect ions: Shows bandwidth usage by connection.


§ Top Prot ocols: Shows bandwidth usage by protocol.
§ Top Talkers: Shows bandwidth usage by IP address.

1728 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 1 Toplists

Toplist Top Protoc ols for a Pac ket Sniffer Sensor

Click on one of these items to view a distribution chart and a list of source and destination IP
and port, protocols, kind of traffic in different channels, etc. It depends on the selected list
which information is available. Click on an entry in the Toplist Periods lists on the left side to
view data for a certain time span. By default, a time span of 15 minutes is set. Additionally,
several table list options 156 are available.

In order to print a toplist, click on the Print t his t oplist button to view a printer-friendly
version and then use the print option of your browser to send it to your printer. With Sensor
Overview you will return to the current sensor's overview tab. For a quick selection of other
toplists of the current sensor, click on one of the toplist icons at the top of the page.

In the sensor overview, you can add or delete new toplists, or edit existing ones.

03.04.2014 1729
Part 7: Ajax Web Interface—Advanced Procedures | 1 Toplists

Add

Click on the Add Toplist item in the sensor overview to create a new toplist. The available
options are the same as for editing 1730 a list.

Edit

Click on the small gear icon of a toplist item in the sensor overview to modify it.

Toplist Set t ings

Name Enter a meaningful name to identify the toplist.

Type § Top Talkers (Which IPs use t he most bandwidt h?): Shows
bandwidth usage by IP address.
§ Top Connect ions (Which connect ions use most bandwidt h?):
Shows bandwidth usage by connection.
§ Top Prot ocols (Which prot ocols use t he most bandwidt h?):
Shows bandwidth usage by protocol.
§ Cust om (Creat e y our own t oplist ): Create your own list by
selecting criteria below.

Toplist is based on This setting is only available if a custom type is selected above.
Select the fields you want to add to the toplist by adding a check
mark in front of the respective field name. The available options
depend on the type of sensor used. They're different for Packet
Sniffer, NetFlow v5, v9 (and IPFIX), and sFlow. Note: For
performance reasons, only select the field you really want to
monitor. Please see Performance Considerat ions 1731 section
below.

Period (Minutes) Define the interval for the toplist in minutes. Please enter an
integer value. Toplists always cover a certain time span. Once a
time span has passed, the top results are stored and a new toplist
is started. Note: In order to avoid load problems on your probe
system, please do not set this interval too long. Default setting is
15 minutes. Please see Performance Considerat ions 1731 section
below.

Top Count Define the length of your toplist. Only this number of entries will be
stored for each period. Please enter an integer value. Note: In
order to avoid load problems on your probe system, please do not
set this value as low as possible. Default setting is 100, in order to
store the top 100 entries for each period. Please see Performance
Considerat ions 1731 section below.

1730 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 1 Toplists

Toplist Set t ings

Probe/Core Data Define how the probe sends the toplist dataset to the core server.
Transfer Choose between:
§ According t o sensor int erval (default ): Send data in the
interval defined in the settings of the sensor this toplist is
created for. This can create a lot of bandwidth and CPU load with
many sniffer sensors, complex traffic, or long toplists.
§ Wait unt il t oplist period ends (less cpu&bandwidt h usage):
Send data once a toplist period has finished. This will create less
bandwidth usage and CPU load, but you cannot see the current
toplist in the web interface, but only toplists with finished
periods.
For more information, please see Performance Considerat ions 1731

section below.

Memory Limit (MB) Define the maximal amount of memory in MB the probe will use for
collecting the different connection information. Every toplist adds
its amount to the probe's memory consumption. Increase this value
if the number of captured connections is not sufficient. Please
enter an integer value.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Delete

Click on the small trashcan icon of a toplist item in the sensor overview to delete it. Confirm
with Delet e to delete the list.

Details

Click on the windows symbol to show details of a toplist.

Performance Considerations

If you create toplists for data lines with considerable usage (for example, steady bandwidth
over 10 Mbit/s) or if the traffic is very diverse (for example, many IPs/ports with only little traffic
each) please consider the following aspects:

§ The probe gathers all information needed for the toplist in RAM memory during each period.
Only the top 100 entries are transferred to the core. Depending on the toplist type and
traffic patterns the required memory can grow into many megabytes.
§ Choose periods as short as desirable (especially important when traffic has a high level of
diversity) to minimize memory usage.

03.04.2014 1731
Part 7: Ajax Web Interface—Advanced Procedures | 1 Toplists

§ Memory requirements can grow almost exponentially with each field used in the toplists
definition (depending on traffic pattern). Avoid complex toplists for high and diverse traffic.
For example, Top Connect ions (5 fields) needs a lot more memory than Top Talkers (1
field).
§ If you experience high bandwidth usage between core and probe try to choose the Wait
unt il t oplist period ends option in the toplist settings 1730 .
§ If you experience Data incomplete, memory limit was exceeded messages try to increase the
memory limit in the toplist settings but keep an eye on the probe process' memory usage.

Notes
§ When working with toplists be aware that privacy issues can come up for certain
configurations of this feature. Using toplists you can track all single connections of an
individual PC to the outside world and you, as the administrator, must make sure that it is
legal for you to configure PRTG like this.
§ Keep in mind that toplists can be viewed through the web interface. You may not want to
show lists of domains used in your network to others. So you should restrict access to
sensor types having toplists.
§ Note that diagrams, for example, for top connections are not meant to be used for detailed
analysis. Rather they should indicate if there is an uncommon bigger change in this toplist.

More
§ Monit oring Bandwidt h via Flows 1966

§ Monit oring Bandwidt h via Packet Sniffing 1964

1732 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 2 Arrange Objects

7.2 Arrange Objects


There are several possibilities to move objects within the device tree, or to move objects from
one probe or group to another.

Manage Tab in Device Tree

While viewing the device tree (or parts of it), click on the Manage tab to switch to a tree view
in which you can move monitoring objects using drag&drop in your browser window. For
more information, see section Manage Device Tree 222 .

Device Details View: Arrange Sensors

When viewing the Overview tab of a device, you will see a list of all sensors on this device.

Arrange Sensors on a Dev ic e

Click on the column headers Pos, Sensors, St at us, or Priorit y to re-sort the sensor list. To
change a sensor's position, simply click on the small grip at the beginning of the row, drag it to
the position you like, and drop it. Changes take effect immediately.

Context Menu: Move

You can also right-click on any object to show the Context Menu 163 . Select the Move entry to
move sensors, devices, or groups up and down, or to move groups or devices into other
groups or on other probes.

14.01.2014 1733
Part 7: Ajax Web Interface—Advanced Procedures | 3 Clone Object

7.3 Clone Object


If you want to duplicate an object with the same settings, you can clone it. Cloning is available
for groups, devices, and sensors. Unlike the results when using the Creat e Device Templat e
1741 option, a cloned device will contain all objects of the original device, regardless of whether

they bring about working sensors or not (which often depends on the settings of the cloned
device).

Note: You cannot clone 'fixed' objects, such as the root group or a probe device. You cannot
clone the sensor types QoS (Qualit y of Service) One Way Sensor 820 and QoS (Qualit y of
Service) Round Trip Sensor 826 .

Note: If you want to clone a sensor, a faster way will be to use the Manage Device Tree 222

function.

To start, right click on an object in your device tree, and from the context menu 163 , select
Clone.... An assistant will appear.

Clone Dialog for a Sensor

1734 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 3 Clone Object

Clone Object Settings

Object To Be Cloned

Object Several fields show information about the object that is to be


cloned. The available information varies depending on whether you
are about to clone a group, device, or sensor.

New Object Name

New Object Name Enter a name for the cloned object. By default, the old name is filled
in, proceeded by Clone of.

New IP Address/DNS This field is only available when cloning a device. Enter the IP
Name address or DNS name for the new device.

Please choose a group/device t o add t he new object t o

From the device tree shown, choose an object you want to add the cloned object to. When
cloning a group or device, select a group. When cloning a sensor, select the device you
want to add it to.

Click on the Cont inue button to store your settings. If you change tabs or use the main menu,
all changes to the settings will be lost!

You will be redirected to the newly cloned object's overview 124 page. By default, all sensors
are initially paused to give you the chance to change settings before monitoring starts. Please
check the settings 142 and resume 162 monitoring.

Related Topics
§ Creat e Device Templat e 1741

§ Manage Device Tree 222

03.04.2014 1735
Part 7: Ajax Web Interface—Advanced Procedures | 4 Multi-Edit

7.4 Multi-Edit
Device and sensor table lists, as well as some other lists, offer multi-edit functionality. With this,
you can bulk edit the properties of many objects at a time. Multi-edit is also available in the
Management tab if you select multiple objects by holding down the Ctrl key (see Manage
Device Tree 223 ).

Note: Using multi-edit, not all settings can be changed. PRTG will offer only settings which all
selected objects have in common.

Note: The multi-edit option is not available for the standard user groups 1861 PRTG
Administrators and PRTG Users Group.

Example of a Table List

Start Multi-Edit in Lists

Start with viewing a table list. For example, choose Sensors | By Ty pe | ... or Devices | Device
List | ... from the main menu. Table lists are also available in the Overview tab of Libraries 1759 ,
Maps 1794 , Report s 1775 , Not ificat ions 1749 , and Schedules 1827 .

In a table list, start multi-edit by selecting objects using the check boxes on the right. You can
also select all objects of the current page at once by clicking the check box in the table
header. Use the It em Count option to view more items per page. As soon as you select one
or more objects, the multi-edit menu will appear at the top of the table and chosen objects are
shaded in green.

1736 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 4 Multi-Edit

Multi Edit Menu

Depending on the object type, different functions are available. For example, for sensor lists,
some frequently used functions are available as quick buttons, such as Delet e, Pause, Resume,
Check Now, and Set t ings. If you click on one of those buttons, the respective function will be
applied to all selected objects.

Other options are available in the drop down menu. Hover the arrow symbol to show it.

Example of Multi Edit Drop


Down Menu

The options in this menu vary depending on the kind of objects selected. If you choose an
entry, the respective function will be applied to all selected objects.

Once you have selected the objects you want to change settings for, click on the screwdriver
symbol to enter the edit settings mode. For available settings, please see below.

Start Multi-Edit in Management Tab

In the device tree, start by clicking the Management tab.

You can use Multi-Edit for object settings:

§ Hold down the Ctrl key and select multiple groups, devices, or sensors (one of a kind).
§ In the appearing dialog, select the settings you would like to edit, change the according
values and click on Save. The changes will be applied to all selected objects.

03.04.2014 1737
Part 7: Ajax Web Interface—Advanced Procedures | 4 Multi-Edit

For available settings, please see below.

Edit Settings—Settings

In the multi-selected sensors' Set t ings tab within the Edit Mult iple Object s popup, you can
edit most of the sensors' properties which they have in common, respectively in the Edit
Mult iple Object s popup for devices. For example, for devices or sensors, edit the name, tags,
priority, scanning interval, access rights, etc.

Example of Dev ic e Settings in Multi-Edit Mode

The available options depend on the selected objects and will vary according to your
selection. When editing multiple sensors, it may be useful to only choose one certain sensor
type from the list, so that there are as much settings as possible available for multi-edit.

In order to change a property, add a check mark in front of the respective line and then
change the settings. The new setting(s) will be applied to all objects you selected for multi-
edit. All properties that are not activated with a check mark will remain unchanged.

Click on the OK button to store your settings. If you close the popup via the X or Cancel
button, all changes to the settings will be lost!

1738 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 4 Multi-Edit

Edit Settings—Channel Settings

The Channel Set t ings tab in the Edit Mult iple Object s popup is only available when editing
sensors. You can edit settings of all channels which the selected sensors have in common.
Select a channel name from the Channel list. You can then edit, for example, channel name, ID,
display settings, colors, scaling, limits, etc.

Example of Sensor Channel Settings in Multi-Edit Mode

The available options depend on the selected sensors and will vary according to your
selection. It may be useful to only choose one certain sensor type from the list, so that there
are as much channel settings as possible available for multi-edit.

In order to change a property, add a check mark in front of the respective line and then
change the channel settings. The new setting(s) will be applied to all sensors you selected for
multi-edit. All properties that are not activated with a check mark will remain unchanged.

Click on the OK button to store your settings. If you close the popup via the X or Cancel
button, all changes to the settings will be lost!

Related Topics
§ Working wit h Table List s 156

03.04.2014 1739
Part 7: Ajax Web Interface—Advanced Procedures | 4 Multi-Edit

§ Manage Device Tree 222

1740 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 5 Create Device Template

7.5 Create Device Template


If you want to add a certain device several times, you can create a device template from an
existing device in your device tree. When creating a device template, information for nearly all
sensors on this device will be saved to a template file which you can later use in combination
with Aut o-Discovery 190 (restrictions apply for a few sensor types). From the sensors, all
relevant settings will be saved, except those that refer to other objects, such as schedules,
triggers, access rights, etc. They will automatically be reverted to Inherit .

To start, right click on a device in your device tree, and from the context menu 163 , select
Creat e Device Templat e.... An assistant will appear.

Create Dev ic e Template Assistant

Device Template Settings

File name for t he t emplat e

File Name Enter a name under which the file will be stored. It will be stored
with the extension .odt in the \PRTG Network Monitor
\devicetemplates sub-directory of your PRTG core installation (of
the Master node, if in a cluster). The file may not exist in this
directory, otherwise you will see an error message.

Template Name Enter a meaningful display name for the template, as it will appear in
the web interface.

28.05.2014 1741
Part 7: Ajax Web Interface—Advanced Procedures | 5 Create Device Template

Click on the Cont inue button to store your settings. If you change tabs or use the main menu,
all changes to the settings will be lost!

You should see a success message indicating that your template file was saved. Finished! The
device template is now stored in the program path of your PRTG core installation. Your device
template file contains all sensors, including their settings, of the original device.

During your next auto-discovery, choose the Aut omat ic sensor creat ion using specific
device t emplat e(s) option and select the name of your newly created device template from
the list. PRTG will then try to discover the stored sensor types on the new (or existing) device.
If the physical device answers to a sensor request, the sensor is added to the PRTG device.
Note: Numbers will be added to the original sensor names. For detailed information, please
see Aut o-Discovery 190 section.

Settings That Are Not Saved

There are a few settings which cannot be saved into a device template, and will therefore be
set to default, such as the Dependency Type setting Mast er object for parent (in Schedules
and Dependencies section), and Result Handling settings Writ e result do disk (as this is
intended for debugging purposes only). Also, settings in the Access Right s section are not
saved to avoid security flaws.

Furthermore, due to internal restrictions, the following sensor types will not be saved into a
device template:

§ Amazon CloudWat ch
§ Core/Probe/Clust er Healt h
§ DHCP
§ Ent erprise Virt ual Array
§ IPFIX
§ IPFIX (Cust om)
§ IPMI Sy st em Healt h
§ jFlow V5
§ jFlow V5 (Cust om)
§ Net Flow V5
§ Net Flow V5 (Cust om)
§ Net Flow V9
§ Net Flow V9 (Cust om)
§ Packet Sniffer
§ Packet Sniffer (Cust om)
§ Passive Applicat ion Performance
§ QoS (Qualit y of Service)

1742 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 5 Create Device Template

§ QoS (Qualit y of Service) Roundt rip


§ Sensor Fact ory
§ sFlow
§ sFlow (Cust om)
§ SNMP Trap Receiver
§ Sy slog Receiver
§ WMI Securit y Cent er
§ WMI Volume (use WMI Free Disk Space (Mult i Drive) Sensor 1573 instead)

No Update of Device Templates

Once a device template is created, it is not possible to add additional sensors to it. If you want
to create a template with an extended set of sensors, please create a new one. Note: When
saving a new device template, all internal IDs of the sensors contained in this template are
updated. Therefore, when applying a new template to an existing device, all sensors contained
in this template will be newly created on this device, even if those sensors were previously
created using (another) device template!

Related Topics
§ Clone Object 1734

§ Manage Device Tree 222

28.05.2014 1743
Part 7: Ajax Web Interface—Advanced Procedures | 6 Geo Maps

7.6 Geo Maps


With the PRTG Geo Maps feature you can visualize geographical information about your
monitored objects. You can display the location of probes, groups, and devices in a graphical
map on an object's details page, or on PRTG Maps 1794 . This feature is especially useful when
you monitor networks which are spread over different locations, for example, in various cities
of a country or all over the globe.

For each probe, group, or device, you can enter Locat ion information. PRTG will use the first
line of this information to query a geographical map which shows your objects. Your location
specification will be resolved to global geographical coordinates by the PRTG core server with
the help of an external map service provider.

PRTG will connect to the specified maps provider to get map tiles. These are used to set up
the graphical map. Then the defined locations will be marked with the corresponding object
icons and their status 1747 on the map. You can select your favorite map tiles provider in
Sy st em Administ rat ion—User Int erface 1832 (setting Geo Maps).

Geographical maps can be displayed on the device tree. PRTG will adjust the zoom of a map
automatically such that all locations of a selected object can be displayed. You can also add
geographical maps to PRTG Maps 1794 . For this concern, go to the PRTG Maps Designer 1800
(either in an existing map or creating a new one) and choose the entry Geo Maps from the
properties menu on the right.

1744 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 6 Geo Maps

The Global Status of a Network in a Geo Map

Using Geo Maps

In order to use geographical maps within the PRTG web interface 100 or Ent erprise Console 1894

, please make sure the following:

1. In the system administration (within the web interface), select the maps provider and type
you want to view. There, you will also find an option to disable geo maps integration if you
do not want to use it. See section Sy st em Administ rat ion—User Int erface 1832 (setting
Geo Maps) for detailed information.

2. In your objects' settings 142 , add a city name, or address, or coordinates in the first line of
the Locat ion field. As soon as you view the details of such an object, a geographical map
will be shown. The Locat ion information will also be used when viewing objects in the
Ent erprise Console 1894 or when adding Geo Maps objects to PRTG Maps 1794 .

3. Make sure your PRTG core server has access to the internet in order to obtain map tiles. If a
proxy is mandatory in your network, please configure proxy settings accordingly. For
details, please see Sy st em Administ rat ion—Core & Probes 1849 . For details about tile server
domains, please see More 1748 section below.

28.05.2014 1745
Part 7: Ajax Web Interface—Advanced Procedures | 6 Geo Maps

Labeling Locations

You can define your own labels for locations of objects. For this concern, enter the desired
label in the first line of the Locat ion settings and provide the geo coordinates of the location
in the second line. In PRTG's geo map, this object will be displayed with the defined label.

Defining Loc ation New York City with Geo Coordinates and Label
Big Apple

The location New York City will appear with the label Big Apple then:

Loc ation New York City with Label Big Apple

It is also possible to define the same label for different locations. For example, imagine your
company's headquarter is spread over several different locations. For each object representing
a dedicated headquarter in the PRTG device tree, enter its coordinates in the second line of
the respective Locat ion settings and the label "Headquarter" in the first line. All corresponding
objects will be displayed as "Headquarter". This way, you can easily find your desired objects
on the map.

1746 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 6 Geo Maps

Map Icon Colors

On the geographical maps the different location icons will show the overall status at this
location by using a color code. Following, all possible location states are listed ordered by
their hierarchy:

Flag Flag Color Locat ion St at us Meaning

Red Down At least one sensor at this location shows a red


Down status. Hover the circle with the letter
symbol in the legend to view the total number of
alarms at this location.

Bright-Red Down At least one sensor at this location is Down and


(Acknowledged) the status was acknowledged by a PRTG user,
applying the Acknowledge Alarm function. The
Down states of all sensors at this location have
to be acknowledged—if at least one sensor is
unacknowledged down, this location will be
displayed as Down.

Yellow Warning At least one sensor at this location shows a


yellow Warning status. There is no sensor in a
Down or Down (Acknowledged) status at this
location.

Orange Unusual At least one sensor at this location shows an


orange Unusual status. There is no sensor in a
Down, Down (Acknowledged), or Warning
status at this location.

Green Up All sensors at this location are in a green Up


status. There is no sensor in a Down, Down
(Acknowledged), Warning, Paused, or Unusual
status at this location.

Blue Paused All sensors at this location show a blue Paused


status. There is no sensor in a Down, Down
(Acknowledged), Warning, Unusual, or Up
status at this location.

Black (Grey) Unknown All sensors at this location have an Unknown


status. There is no sensor in a Down, Down
(Acknowledged), Warning, Unusual, Paused, or
Up status at this location.

Note: For detailed information about sensor states, please see Sensor St at es 121 section.

28.05.2014 1747
Part 7: Ajax Web Interface—Advanced Procedures | 6 Geo Maps

Geo Tracking of Your Mobile Device

It is possible to show the location of an Android device and track its movements on PRTG Geo
Maps. PRTG can draw the route a device has taken directly into geo maps. For this feature, you
need the PRTG Mobile Probe for Android. See section More 1748 for details.

More

Knowledge Base: Which provider should I use for PRTG's "Geo Maps" feature?
§ http://kb.paessler.com/en/topic/34603

Knowledge Base: Which domains and ports does the GeoMaps feature use?
§ http://kb.paessler.com/en/topic/35823

Knowledge Base: Why does my street not appear on the Geo Map shown in PRTG?
§ http://kb.paessler.com/en/topic/35653

Knowledge Base: How do I get a Google Maps API key for use in PRTG?
§ http://kb.paessler.com/en/topic/32363

Knowledge Base: Which limitations apply when using the Google Maps API in PRTG?
§ http://kb.paessler.com/en/topic/7913

Knowledge Base: How can I change the way markers look like in PRTG's geo maps?
§ http://kb.paessler.com/en/topic/43153

Knowledge Base: How can I track geo data of my Mobile Probe device?
§ http://kb.paessler.com/en/topic/59647

1748 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications

7.7 Notifications
Notifications are used to send alerts to the user whenever PRTG discovers a defined status,
such as slow or failing sensors, or when threshold values are breached. You can define an
unlimited number of notifications allowing to use one, or more, of several communication
channels like email, text messaging, and many more. For video instructions, please see the
More 1750 section below.

Overview

Notifications can be triggered by:

§ Sensor st at us changes
For example, when a sensor changes status to Up or Down, if responses are slow, or
sensors show an Unusual status.
§ Sensor value t hreshold breaches
For example, when a sensor shows a request time higher than 1,000 ms for more than 30
minutes.
§ Speed t hreshold breaches
For example, when a traffic sensor shows more than 1 Mbit/s for more than 5 minutes.
§ Volume t hreshold breaches
For example, when a traffic sensor shows more than 1 Gbyte transferred in 24 hours.
§ Sensor value changes
For some sensors you can trigger a notification whenever the value changes, for example,
when monitoring files on a hard disk drive.

A notification can be one of these actions:

§ Send Email
§ Add Ent ry t o Event Log
§ Send Sy slog Message
§ Send SNMP Trap
§ Send SMS/Pager Message
§ Execut e HTTP Act ion
§ Execut e Program
§ Send Amazon Simple Not ificat ion Service (SNS) Message
§ Assign Ticket

For details, see section Account Set t ings—Not ificat ions 1820 .

Note: Usually there are three successive attempts to deliver a notification. If all of these
attempts fail, the notification is lost.

Notifications can contain valuable sensor information, such as:

28.05.2014 1749
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications

§ Last error message


§ Last good/failed request
§ Total downtime
§ Total uptime
§ Recent sensor history
§ A direct link to the web interface

Notifications Setup

There are three steps to take in order to use notifications with PRTG. Please go through all of
them:

1. Check and set up the Not ificat ion Delivery settings. This will tell PRTG how to send
messages.
For detailed information, see Sy st em Administ rat ion—Not ificat ion Delivery 1843 .

2. Check and set up several Not ificat ions. This will define the kind of message and its
content.
For detailed information, see Account Set t ings—Not ificat ions 1817 .

3. Check and set up Not ificat ion Triggers for objects. These will provoke the defined
notifications.
For detailed information, see Sensor Not ificat ions Set t ings 1716 .

See section Set t ing Up Not ificat ions Based on Sensor Limit s: Example 1751 for a step-by-
step guide describing a potential notifications setup.

More

Video Tutorial: There is a video available on the Paessler video tutorials page.
§ http://www.paessler.com/support/video_tutorials

Knowledge Base: Notifications based on priorities


§ http://kb.paessler.com/en/topic/31243

1750 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

7.7.1 Setting Up Notifications Based on Sensor Limits: Example

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

This section will show you exemplarily how to set up a notification for exceeded disk free
limits. The approach for this specific use case is examined step by step. You can easily adapt it
to declare limits for other sensor types.

There are several steps to take in order to set up notifications based on limits:

§ Step 1: 1751 Provide necessary information about the delivery of notifications (SMTP and SMS).
§ Step 2: 1751 Create notifications, specifying the type of notification and its content.
§ Step 3: 1752 Define thresholds that will change a sensor's status (this is not necessary for
every kind of notification).
§ Step 4: 1755 Add suitable triggers to objects which will evoke notifications if something is
going wrong in your network.
§ Step 5: 1756 Test if the created notification will be triggered and delivered correctly.

Note: When you set up your own notifications, you will not necessarily need to go through all
the steps described here. In this section, our main goal is to give you a general idea of the
notifications concept.

Step 1: Setting up the Notification Delivery

Before creating notifications, you first have to define how those notifications actually will be
delivered to your email account, mobile phone, or pager. To do so, choose Set up | Sy st em
Administ rat ion | Not ificat ion Delivery from PRTG's main menu bar. Specify the mechanism of
SMTP delivery, sender email and name, as well as the HELO ident. For SMS delivery, select your
service provider and provide the corresponding credentials. You can find details about
notification delivery in section Sy st em Administ rat ion—Not ificat ion Delivery 1843 .

Step 2: Setting up the Notification's Content

In order to get an informative message when a disk is running out of capacity, create a
corresponding notification. Choose Set up | Account Set t ings | Not ificat ions from PRTG's
main menu bar and click on the button Add New Not ificat ion. Give the notification an
explanatory name; in our case you could use Disk Free Limit Notification. However, if you want
to trigger this notification on a global level (for example, for a probe or group) such that it
would not only apply to breached disk free limits, a general name would be more suitable (like
the predefined notification "Email to Admin"). If you leave the default text of the newly created
notification, it will already contain all necessary information, like:

§ which sensor is affected,


§ since when the sensor is affected,
§ last value of this sensor,

12.05.2014 1751
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

§ etc.

See section More 1757 for the other options you have here.

After providing this basic information, select the delivery method. In our case, we choose Send
Email for this notification by marking the corresponding checkbox. Specify who will receive
the notification, its subject, the format, the content of the email, and its priority. By default, the
email notification will contain several information parameters about the evoking sensor: its
name, status, time, message, location in the device tree, etc. Feel free to adjust email
messages to your needs (see section More 1757 ). You can choose any other notification
method, of course (see Account Set t ings—Not ificat ions 1820 ).

Creating an Email Notific ation

Once the notification is set up completely, click on Save. You will be redirected to the
notifications overview page. You can now use this notification for every trigger on every
object in your device tree.

Step 3: Define Limits

Before creating triggers that evoke notifications, first specify the limits which you want to
apply to your disks. For example, if you want to be notified when a disk has exceeded 80% of
its capacity, force the sensor into a Warning status at this utilization. You have several options
to set limits for disk free sensors:

1752 12.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

§ Set limits checked against all disks in the settings of multi-drive sensors: WMI Free Disk
Space 1573 , SNMP Linux Disk Free 1122 , SSH Disk Free 1286
§ Enable limits in Channel settings of single sensors
§ You can achieve both with Mult i-Edit 1736

Step 3.1: Define Limits in Sensor Settings (Multi-Disk Free Sensors Only)

You can set limits for sensors monitoring multiple disks directly via the Set t ings tab on a
sensor's details page. Mult i-Edit 1738 for existing sensors is also possible. Open the settings of
the selected sensor(s) and go to section Set limit s checked against ALL disks. There, for
example, enable Percent age Limit Check. In the field Lower Warning Limit , enter the
percentage suitable to your needs. In our example, this would be 20. Alternatively, you can
use bytes to define a limit. However, we recommend using percentage values for more
flexibility. This limit will apply to all channels of this sensor representing disks.

Setting Limits for All Disks

Note: This sensor setting is only available for multi-drive sensors. You can omit Step 3.1 for all
sensors that are not from the type "disk free".

12.05.2014 1753
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

Step 3.2: Define Limits for Sensor Channels

In order to set specific limits for single disks, use the sensor's Channel settings. You can open
channel settings via the gear icon in the respective channel gauge or in the channels table.
Enable Limit s at the bottom of the channel settings dialog and specify your desired limits in
the Lower Warning Limit field. This limit will only apply to the respective channel.

Note: If you define channel limits when using the sensor's limit setting in the sensor's Set t ings
tab at the same time, the first limit that applies will be considered. This way, you can individually
define harder limits for single disks in a multi-disk sensor. All defined limits are valid side-by-
side.

You have to take the approach via channel settings for sensor types that monitor only one
(logical) disk, for example, the SNMP Disk Free Sensor 1020 . For these sensor types, you can
use Mult i-Edit 1739 if you want to apply the same limits for each of these sensors automatically.

§ To see all sensors of this type at a glance, just filter for it: From PRTG's main menu bar,
choose Sensors | By Ty pe | SNMP Disk Free.
§ Mark the checkboxes of the sensors you want to add a limit for.
§ Click the screwdriver symbol in the multi-edit bar.
§ Open the Channel Set t ings tab.
§ Select the channel you want to add a limit for; in this case it would be most likely the
channel Free Space.
§ Then Enable Limit s at the bottom of the dialog and enter the number in the correct field as
described above.

Once done, save these settings—the new limit will apply to all channels with this name of the
multi-edited sensors.

1754 12.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

Setting Limits for Channels with Multi-Edit

Step 4: Setting up the Notification Trigger

You have specified limits to define when a sensor will go into a Warning (or Error) status. Now
you can create the according triggers. The trigger we use in this example is the St at e Trigger.
For details about other possible notification triggers, see section More 1757 .

§ You can set up a St at e Trigger on any level in your device tree. For example, open a group
containing the device(s) representing your disks.
§ Go on the Not ificat ions tab.

12.05.2014 1755
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

§ Click Add St at e Trigger.


§ Set the trigger to "When sensor is Warning" and choose the notification you have created
before ("Disk Free Limit Notification" or a more general one) from the drop down list.
§ Adjust the other notification settings to your needs and save this new object trigger.

Now you will be notified immediately when the capacity of one of your disks falls below the
defined limit, in this case 20% free disk space.

Setting a Trigger for Disk Free Limit Notific ation

Step 5: Testing the Notification

Finally, test the notification which you have created. You can trigger this notification for test
purposes immediately:

§ From the main menu bar 175 , choose Set up | Account Set t ings | Not ificat ions.
§ For the respective notification, click on the corresponding Test button.

Then, check if the notification was triggered and delivered correctly, depending on what
delivery method you defined before. If you do not get a notification (or a defined action is not
executed) at all, check the notification logs: From the main menu bar, choose Logs | Sy st em
Event s | Not ificat ions. Look for the triggered notification in the table list (verifying that the
notification delivery is set up correctly in general) and consider the corresponding message.
See section Logs 147 for more information.

1756 12.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

More

This section provides information about additional options you have when working with
notifications.

§ Not ificat ion Set t ings:


You can create schedules to activate notifications only at specific times, for example, only on
weekdays. In section Not ificat ion Summarizat ion you can choose between various
options to avoid message floodings. Furthermore, define which user groups will have access
to edit this notification. For details about notification settings, refer to section Account
Set t ings—Not ificat ions 1817 .

§ Cont ent of Emails:


You can individually adjust the subject, content, header, and footer of emails to your needs.
PRTG allows you to use placeholders here. See section Account Set t ings—Not ificat ions
1820 for details about editing subject and message, and section Sy st em Administ rat ion—

Not ifcat ion Delivery 1843 for details about editing header and footer of emails.

§ Ot her Triggers:
An alternative to the state trigger would be to add a Threshold Trigger; then you would not
need to set up limits explicitly, though, this trigger type would only be suitable for disk free
sensors when using the trigger for single sensors, one by one. Free disk sensors have free
space in percent as primary by default, other sensors have primary channels with the units
bytes or seconds. However, threshold triggers only apply to the primary or total channel.
General notification triggering by threshold might not work as expected for sensors of the
"percentage" type. You can find all available triggers in section Not ificat ions 1749 .

§ Add a Threshold Trigger to a sensor directly:


Go on a sensor's detail page and select the Not ificat ions tab. Click on Add Threshold
Trigger, select the desired channel, and provide the condition when this notification will be
sent. In this example for free disk space, the setting would be "When Free Bytes C: (%)
channel is Below 20 for at least 60 seconds perform Disk Free Limit Notification".

§ Not ificat ions wit h Libraries:


If your disk devices are spread over many groups, we recommend you to use a PRTG library
1759 for your disks. Choose Libraries | All diskspace sensors from the main menu bar, go on

the Not ificat ions tab, and add a state trigger as described above. Note: Not all disk free
sensor types might appear. You can add them to this library in the settings of the library
node. There you can filter by type or tag 1768 and add missing sensors this way. You can also
filter by priority and other sensor properties.

12.05.2014 1757
Part 7: Ajax Web Interface—Advanced Procedures | 7 Notifications
1 Setting Up Notifications Based on Sensor Limits: Example

Settings of a Library with Diskspac e Sensors

1758 12.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries

7.8 Libraries
With PRTG's Libraries feature you can create special views of your device tree with up-to-the-
minute monitoring status information, arranged the way you want it.

Example of a Library

In this section:

§ Int roduct ion 1759

§ St art Libraries 1760

§ Libraries List 1760

§ Working wit h Libraries 1761

Introduction

Libraries is a powerful feature which enables you to create additional views of your device
tree, which are updated with the same scanning interval as your device tree, showing the same
monitoring data, but arranged in a way you want it. This is interesting if you want to show data
in different ways, e.g. depending on target groups or use case. For example, you can create a
library which contains an overview of all your bandwidth monitoring sensors, regardless of
which device they're running on.

Library features include:

§ Create libraries containing nodes with monitoring objects from all over your configuration
§ Show data from different PRTG probes in one library
§ Show different branches of your device tree right next to each other

14.01.2014 1759
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries

§ Arrange sensors in a tree-like view regardless of which device they are running on
§ Filter your entire tree (or parts of it) for sensor type, state, or tag, showing only matching
sensors

You can create libraries easily, using drag&drop right within your browser.

PRTG comes with several pre-configured standard libraries, which you can use right away. You
can also change or delete them, if you like. The following libraries are automatically created
when you install PRTG for the first time (visible for the PRTG Administrator user). Some of them
will be initially empty, but as you add more sensors, they will be filled automatically according
to the filter settings defined for the nodes of the libraries:

§ All bandwidth sensors


§ All CPU load sensors
§ All diskspace sensors
§ All memory sensors
§ All VMware sensors
§ Sensors grouped by priority
§ Sensors grouped by state

Note: Sensors which are added to libraries are not counted against the maximum number of
sensors of your license.

Start Libraries

Click the Libraries entry from the main menu 178 to view or add custom views of your
network's status and monitoring data. Hover to show other menu items. Choose between:

§ All
Calls the Libraries feature where you can view or add custom device tree views of your
network's status and monitoring data.
§ Add Library
Lets you directly add 1762 a new library.
§ Select Library ›
Show existing libraries. Hover to show other menu items. Follow the menu path (it is specific
to your setup) to select a library.

Libraries List

In the All view, you see a list of all existing libraries. Using the links next to a library name, you
can perform the following actions.

§ Click on the name of a library to view it.


§ Delet e: Delete this library.

1760 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries

§ Clone: Create a clone of this library.


§ Used by : Show which other monitoring objects use this library.
§ Click on the Add Library button to add a new library.

Please see also Working wit h Table List s 156 . Additionally, there is multi-edit available. This
enables you to change properties of several objects at a time. For more details, please see
Mult i-Edit List s 1736 section.

Working with Libraries

For detailed information on how to create and edit libraries please see the following sections.

§ Libraries St ep By St ep 1762

§ Management 1766

§ Libraries and Node Set t ings 1768

§ Cont ext Menus 1774

14.01.2014 1761
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
1 Libraries Step By Step

7.8.1 Libraries Step By Step

In order to create a new library, follow the steps in this section. In the web interface, click on
the Libraries entry in the main menu to show the libraries main screen.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

In this section:

§ St ep 1: Add Library 1762

§ St ep 2: Add Library Nodes 1763

§ St ep 3: Set Library Node Display Set t ings 1763

§ St ep 4: View 1764

Step 1: Add Library

Click on the Add Library button. An assistant is shown. Enter a Library Name, and define
Tags and Access Right s, if you like. Click on Cont inue.

For detailed information, see Libraries Set t ings 1768 section.

Add Library Assistant Step 1

1762 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
1 Libraries Step By Step

Step 2: Add Library Nodes

Click to the Management tab. You will see a split screen: On the left side, your library is show
(empty in the beginning), and on the right side, you see a less colorful view of your device tree,
as known from the device tree's Management 222 tab.

Bandwidth Library in Management Mode

From the device tree on the right side, drag objects and drop them on the library on the left
side. Each dropped object will be added immediately as a new Library Node. Repeat this
procedure as often as you wish until you have added all desired items to the library. Note:
When adding single sensors to the library, there can only be one sensor in one library node.

You can also create nested library nodes by adding a new node underneath an existing one.

Drag and drop nodes within the library to change their position. If you want to change the
monitoring object that is associated with a library node, you can change the Linked Object in
the node's settings.

Step 3: Set Library Node Display Settings

You are still in the library Management tab.

14.01.2014 1763
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
1 Libraries Step By Step

Right-click on the name of a Library Node and from the context menu, select Edit | Set t ings...
to change the Node Display Set t ings. In this dialog, you can change the name of the library
and its tags, as well as the linked object, node type, and filters.

These settings are available for each library node. You can choose to either show the Linked
Object as a sub-tree of your device tree, or to view a collection of all sensors underneath the
Linked Object .

When selecting the sub-tree view, the library node will just look like a branch in your device
tree, as shown in the screen shot below for the library node names "My Sub Tree".

Library with one Node Showing a Branc h of the Dev ic e Tree

When selecting a sensor collection view, only the sensors underneath the Linked Object are
shown, omitting probes, groups, and devices. You can additionally filter by certain sensor
Ty pe, St at us, and Tags. Only matching sensors will be shown. The screen shot below shows
the same Linked Object as above, but in sensor collection view, additionally filtered for
sensors with a bandwidt hsensor tag.

Library with one Node Showing a Collec tion of Bandwidth Sensors Only

For detailed information, see Libraries and Node Set t ings 1768 (Overview—Library Node
Display Settings) section.

Step 4: View

Click on the Overview tab to see the final appearance of your library. You have the following
options:

§ Hover an object to view a popup window with recent monitoring and status data.

§ Use the sensor state selection bar to select which sensors you want to see for the library:
Simply remove check marks for sensor states you want to hide. Note: This function is the
same you know from the device tree's Sensor Status Bar 113 . The setting is reset the next
time you open the library.

§ Use the Device Tree View selection in the page header bar 113 to change the size of the
library display. Note: This function is the same you know from the device tree 115 .

1764 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
1 Libraries Step By Step

§ Use the Search box in the page header bar 113 to search the library for a string in object
names. Matching objects will be shown full-colored, all others will be grayed out while the
filter is active. Click on the small x symbol in the search field to reset the filter. Note: This
function is the same you know from the device tree 113 .

It depends on the library's access rights and the currently logged in user account if it will be
visible to other PRTG users. Also, clicking on objects (for example, on sensors) will lead to
more detailed information about the object or to an error message indicating insufficient
access rights—depending on user account and access rights.

In libraries, you can right-click objects to access their Cont ext Menus 1774 .

14.01.2014 1765
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
2 Management

7.8.2 M anagement

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Click to the Management tab. You will see a split screen: On the left side, your library is show
(empty in the beginning), and on the right side, you see a less colorful view of your device tree,
as known from the device tree's Management 222 tab.

Bandwidth Library in Management Mode

Add and Change Library Nodes

From the device tree on the right side, drag objects and drop them on the library on the left
side. Each dropped object will be added immediately as a new Library Node. Repeat this
procedure as often as you wish until you have added all desired items to the library. Note:
When adding single sensors to the library, there can only be one sensor in one library node.

You can also create nested library nodes by adding a new node underneath an existing one.

Drag and drop nodes within the library to change their position. If you want to change the
monitoring object that is associated with a library node, you can change the Linked Object in
the node's settings.

1766 07.02.2013
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
2 Management

Set Library Node Display Settings

Right-click on the name of a Library Node and from the context menu, select Edit | Set t ings...
to change the Node Display Set t ings. In this dialog, you can change the name of the library
and its tags, as well as the linked object, node type, and filters.

These settings are available for each library node. You can choose to either show the Linked
Object as a sub-tree of your device tree, or to view a collection of all sensors underneath the
Linked Object .

When selecting the sub-tree view, the library node will just look like a branch in your device
tree, as shown in the screen shot below for the library node names "My Sub Tree".

Library with one Node Showing a Branc h of the Dev ic e Tree

When selecting a sensor collection view, only the sensors underneath the Linked Object are
shown, omitting probes, groups, and devices. You can additionally filter by certain sensor
Ty pe, St at us, and Tags. Only matching sensors will be shown. The screen shot below shows
the same Linked Object as above, but in sensor collection view, additionally filtered for
sensors with a bandwidt hsensor tag.

Library with one Node Showing a Collec tion of Bandwidth Sensors Only

For detailed information, see Libraries and Node Set t ings 1768 (Overview—Library Node
Display Settings) section.

Context Menus

On right-click, there are different context menus available—in the Management as well as in
the Overview tab.

For detailed information, please see Cont ext Menus 1774 section.

07.02.2013 1767
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
3 Libraries and Node Settings

7.8.3 Libraries and Node Settings

Using the libraries tabs you can access all functionalities and settings for a library.

Library Tabs

Overview

Click on the Overview tab any time to show the current state of your library.

Library Node Display Settings

While in the Overview tab, click on a library node's name to change its settings. Or, while in
the Management tab, right-click a library node's name and select Edit | Set t ings... from the
context menu. In both cases, the following settings are shown. Note: You can only change the
settings of a node if it contains monitoring objects already, e.g. groups, devices, or sensors.

Basic Library Node Set t ings

Library Node Name Enter a meaningful name for the library node.

Tags Enter one or more tags, separated by space or comma. For


example, you can use tags later to search for the library. Tags are
not case sensitive.

Node Display Set t ings

Linked Object Click on the reading-class symbol to change the object which is
linked with this library node. A popup window will appear, showing
the Object Select or 159 .

Node Type Select what you want to view for this library node. Choose
between:
§ Show a subt ree of t he device t ree in t he library : View all
objects underneath the linked object as a device tree.
§ Show a collect ion of (filt ered) sensors in t he library : View all
sensors underneath the linked object (only sensors are shown).
You can combine several filters with each other (see below).

Filter By Type This option is visible only if collection of sensors is enabled above.
Select if you want to filter the sensor list by a certain type. Choose
between:
§ Show all sensor t y pes: Do not filter for a sensor type.

1768 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
3 Libraries and Node Settings

Node Display Set t ings

§ Show specific sensor t y pes only : Filter the sensor list of the
linked object for certain sensor type(s).
Note: This filter is applied in real-time. If the configuration
underneath the linked object changes, the library node will show
matching sensors accordingly.

Select Sensor Types This option is visible only if filtering by type is enabled above. A list
of all sensor types is shown, currently available sensor types are
shown in bold letters for your convenience. Set a check mark in
front of each sensor type you want to include in the library node
view. You can also select and deselect all items by using the check
box in the table head.
Note: This filter is applied in real-time. If the configuration
underneath the linked object changes, the library node will show
matching sensors accordingly.

Filter By Status This option is visible only if collection of sensors is enabled above.
Choose between:
§ Show all sensor st at es: Do not filter for a sensor status.
§ Show sensors wit h a specific st at us only : Filter the sensor list
of the linked object for sensors in certain states.

Select Sensor States This option is visible only if filtering by sensor state is enabled
above. A list of sensor states is shown. Set a check mark in front
of each status you want to include in the library node view.
Choose from:
§ Unknown
§ Up
§ Warning
§ Down
§ Paused
§ Unusual
§ Down (Acknowledged)
§ Down (Part ial)
You can also select and deselect all items by using the check box
in the table head.
Note: This filter is applied in real-time. If the configuration
underneath the linked object changes, the library node will show
matching sensors accordingly.

14.01.2014 1769
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
3 Libraries and Node Settings

Node Display Set t ings

Filter By Tags This option is visible only if collection of sensors is enabled above.
Choose between:
§ Show all sensor t ags: Do not filter for a tag.
§ Show object s wit h a specific t ag only : Filter the sensor list of
the linked object for sensors with a certain tag. Note: The tag of
a sensor can also be inherited 87 by a parent object.

Select Tags This option is visible only if collection of sensors is enabled above.
A list of all available tags is shown. Set a check mark in front of
each tag you want to include in the library node view. You can also
select and deselect all items by using the check box in the table
head.
Note: This filter is applied in real-time. If the configuration
underneath the linked object changes, the library node will show
matching sensors accordingly.

Filter By Priority This option is visible only if collection of sensors is enabled above.
Choose between:
§ Show all priorit ies: Do not filter for the priority setting 160 of a
sensor.
§ Show object s wit h specific priorit y only : Filter the sensor list
of the linked object for sensors with specific priority. Note: The
priority setting of a group, device, or sensor is ignored here; only
the priority setting of the sensor itself is regarded.

Select Priority This option is visible only if collection of sensors is enabled above.
Define which priority setting sensors must have to appear in this
collection. Set a check mark in front of each priority you want to
include in the library node view. Choose from:
§ ***** (highest )
§ ****
§ ***
§ **
§ * (lowest )
Note: This filter is applied in real-time. If the configuration
underneath the linked object changes, the library node will show
matching sensors accordingly.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

1770 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
3 Libraries and Node Settings

Note: After applying filters it might take several seconds for the changes to become visible.
This is due to internal filter processes running in the background.

Management

Click on the Management tab to edit the contents of your library, for example, to add items to
the library using drag&drop. For detailed descriptions, please see Management 1766 section.

Settings

Click on the Set t ings tab to open a library's general settings.

Basic Library Set t ings

Library Name Enter a meaningful name for the library.

Tags Enter one or more tags, separated by space or comma. For


example, you can use tags later to search for the library. Tags
entered here are inherited 87 to all library nodes underneath. Tags
are not case sensitive.

14.01.2014 1771
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
3 Libraries and Node Settings

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists and in the device tree.
Exception: If a child object is visible to the user, the object is
visible in the device tree, though not accessible.
§ Read: Users in this group can see the object and review its
monitoring results.
§ Writ e: Users in this group can see the object, review its
monitoring results, and edit the object's settings. They cannot
edit access rights settings.
§ Full: Users in this group can see the object, review its monitoring
results, edit the object's settings, and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings. To automatically set all objects further
down in the hierarchy to inherit this object's access rights, set a
check mark for the Revert children's access right s t o inherit ed
option.
For more details about access rights, please see section User
Access Right s 94 .

Note: When giving access rights to a user group, all members of this user group will be able to
see the objects in the library just as seen by the user who originally created the library.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Notifications

You can define notification triggers for any kind of object libraries. This is even possible for
dynamic libraries which can change with every scanning interval, for example, when you filter a
library for the sensor status or priority. For details about how to use notifications, please see
section Not ificat ions 1749 .

Comments

In the Comment s tab you can enter free text for each object. This can be used for
documentation purposes or to leave information for other users.

1772 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
3 Libraries and Node Settings

History

In the Hist ory tab all changes in the settings of an object are logged with a timestamp, the
PRTG user which conducted the change, and a message. The history log keeps the last 100
entries.

Delete

You can delete the entire library any time by clicking on the trash symbol on the right.

14.01.2014 1773
Part 7: Ajax Web Interface—Advanced Procedures | 8 Libraries
4 Context Menus

7.8.4 Context M enus

On right-click, there are different context menus available.

Library Node Menu

While in the Overview or the Management tab, right-click on any library node to show its
context menu.

Library Node Menu

Library Node Menu: Edit

Library Node Menu: Mov e

§ Select either Det ails... or Edit | Set t ings... to get to the Libraries and Node Set t ings 1768 .
Note: While in the Overview tab, these settings are also accessible via left-click on the
node's name.
§ Edit | Rename... will give you an option to rename the library node quickly.
§ Remove from Library ... will remove this library node from the current library. Note: This will
not delete any objects in your device tree.
§ The Move | ... options will move the library node up and down within the library.
§ Click on the Send Link by email entry to open a new email using your system's standard
email client. It will contain a direct link to the page you're currently viewing.

Monitoring Objects Menus

In libraries there are the same Cont ext Menus 163 available you already know from the device
tree. With one exception: While accessing these menus within libraries, the Move and Delet e
options are disabled to avoid accidental changes to your device tree.

1774 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports

7.9 Reports
Reports are used to analyze historic monitoring results over a specified time such as one or
more days, one month, or an entire year. You can create reports for all, or only for certain
sensors.

Introduction

PRTG includes a powerful reporting engine for ad-hoc, as well as scheduled report generation
in HTML and PDF format. Thus, reports can be run on demand or on a regular basis (for
example, once a day). You can create reports for one single sensor, or you choose a range of
sensors you want to create a report for. The content and layout of the report is controlled by
the report template of your choice and is the same for all sensors in a report.

Report Sample

The sample report above shows a report data for devices on a local probe. You can see graphs
for the preceding week, plus data tables with numeric results.

Start Reports

Click the Report s entry from the main menu 182 to view or add reports of your monitoring
data. Hover to show other menu items. Choose between:

§ All
Calls the Reports feature where you can view or add reports of your monitoring data.
§ Add Report
Lets you directly add a new report.

03.04.2014 1775
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports

§ Select Report ›
Show existing reports. Hover to show other menu items. Follow the menu path (it is specific
to your setup) to select a report.

Reports Overview

List of Reports

In the All view, you see a list of all existing reports. Every line shows information about one
report:

§ Period: The time span covered by the report.


§ Schedule: Shows if a schedule is set to regularly execute the report automatically.
§ Email: If a schedule and an email address is set in the report settings, this shows the email
address the report is automatically sent to.
§ St at us: Shows the current status of the report.
§ Last Run: If a schedule is set in the report settings, this shows when the report was run the
last time.
§ Next Run: If a schedule is set in the report settings, this shows when the report will be run
the next time.

Using the buttons at the end of a line, you can Edit , Clone, and Delet e the respective report.

1776 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports

Please see also Working wit h Table List s 156 . Additionally, there is multi-edit available. This
enables you to change properties of several objects at a time. For more details, please see
Mult i-Edit List s 1736 section.

Click on the Add Report button to add a new report, or click on the name of an existing
report to view and edit its settings. You can also run a pre-configured report easily by clicking
on its name and then using the options in the Run Now tab. For both options, please see
Report s St ep By St ep 1778 section.

Working With Reports

For detailed information on how to create, edit, and schedule reports, please see the following
sections:

§ Report s St ep By St ep 1778

§ View and Run Report s 1781

§ Report s Set t ings 1784

Automatic Averaging

For performance reasons, PRTG automatically averages monitoring data when calculating data
for large time spans. Data is then averaged regardless of the selected average interval.

Time Span in Report Minimum Level of Det ail (Average Int erval)

Up to 40 days Any

40 to 500 days 60 minutes/1 hour or larger

A report for a time span of more than 500 days is not possible. If you try to set a larger time
span, it will be reduced to 365 days automatically.

Related Topics
§ Review Monit oring Dat a 124

§ Hist oric Dat a Report s 133

03.04.2014 1777
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
1 Reports Step By Step

7.9.1 Reports Step By Step

In order to create a new report, or run an existing one, follow the steps in this section. In the
web interface, click on the Report s entry in the main menu to show the reports main screen.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Quick Start: Run an Existing Report

PRTG is delivered with several pre-configured reports. In order to use one of them, click on a
report's name in the reports main screen, select the Set t ings tab. The other steps are the
same as for new reports. Although some settings are already given, we recommend checking
the settings. For example, check the sensors that will be included in the report. For some
reports that come with PRTG there are no sensors added yet. Continue with St ep 3 1779 in this
section.

Step 1: Add Report

Click on the Add Report button to add a new report. An assistant is shown where you can
define various settings. First, enter a Report Name.

1778 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
1 Reports Step By Step

Add Report Assistant

Step 2: Select a Template

In the Templat e section, select one of the report templates from the list. This will define the
overall look of your report and affect in which detail (interval) monitoring data is included. For a
detailed description on the available options, please see Report s Set t ings 1784 section. If you
are not sure, try a template that appears most suitable to you. You can change all settings
later.

Step 3: Define Additional Settings

Select a Securit y Cont ext (best choose PRTG Sy st em Administ rat or, if available), your
Timezone, and Paper Size for PDF generation. For detailed information, please see Report s
Set t ings 1784 section.

Step 4: Select Nodes and Sensors

Choose the sensors you want to include in the report. First, when running in a cluster 81 ,
define the Clust er Node the monitoring data will be taken from. Select a specific node from
the list. If you select All nodes, a report with data from all of your cluster nodes will be
created, but only the primary channel of every sensor will appear in the report.

03.04.2014 1779
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
1 Reports Step By Step

Every report will show monitoring results from sensor data. There are two ways to include
sensors in a report: You can either add sensors manually, or by tag. In the Add Sensors by
Tag field, enter one or more tags that matches the sensor range you want a report for. For
example, enter the tag bandwidthsensor to include all sensors that measure bandwidth (or
select it from the list of tags which PRTG suggests). PRTG provides this tag as default when
adding bandwidth sensors; so this tag typically gathers all bandwidth sensors, unless you have
configured your system differently. You can enter several tags; hit the enter key, comma, or
space after providing one tag and enter the next one. Use the Filt er Sensors by Tag field to
explicitly filter sensors with certain tags from the bulk of tags or manually selected sensors
defined above.

Tagging is a great tool to group sensors or other objects. For more information, see Tags 89
section. You can also leave the tag fields empty and only choose specific sensors manually
later.

Step 5: Decide on a Schedule and Additional Settings

In the Report Schedule section, choose if you want to run the report on a regular basis or on
demand only. Also choose which time Period will be covered by the report, and if you want to
show percentiles, add report comments, or special access rights. For detailed information,
please see Report s Set t ings 1784 section.

Click on the Cont inue button to store your settings. If you change tabs or use the main menu,
all changes to the settings will be lost!

Step 6: Check and Adjust the Sensors Included

When settings are saved, switch to the Sensors Select ed by Tag tab to see a list of all
sensors that were added by the tag(s) you defined in step 4. To change tags, go back to the
Set t ings tab. You can additionally add sensors manually. To do so, switch to the Select
Sensors Manually tab. See Report s Set t ings 1791 section for detailed information. The final
report will show sensors from both manual and by tag selection.

Step 7: Run Report

Switch to the Run Now tab, select the current or previous period, and in the Processing
Opt ions select View Report as HTML. Click the Run Report button. The report will be
generated in a new browser window or tab immediately. Depending on the number of selected
sensors and the used template, it may take a few minutes until you see the report. If you do
not want to wait, close the newly opened browser window or tab and select a PDF option in
the Processing Opt ions. Click on the Run Report button again. The report will then be
generated in the background and you will get a ToDo t icket or email once it is finished.

Note: For large PDF reports, PRTG will automatically split the output into separate files to avoid
huge PDF files. You can change the number of sensors included into each PDF file by editing
the report templates manually. See More 1793 section of Reports Settings 1784 .

1780 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
2 View and Run Reports

7.9.2 View and Run Reports

In the web interface, click on the Report s entry in the main menu to show the reports main
screen. Click on a report's name to select it. Using the reports tabs you can access all
functionalities and settings for this report. Click on the Go t o all report s button at the
bottom of the page to return to the list of Reports.

Report Tabs

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Run Now

In the Run Now tab you can execute a report immediately with the settings configured.

Run Report "[Name]"

Report for Define the time span covered by the report. Choose between:
§ Current Period: Use monitoring data of the current period. The
actual time span depends on the report period type defined in
the report's settings 1784 . It can be today, this week, this month, or
this year.
§ Previous Period: Use monitoring data of the last period. The
actual time span depends on the report period type defined in
the report's settings 1784 . It can be yesterday, last week, last
month, or last year.
§ Select A Period: Use monitoring data of a period other than
current or previous. Select below.
§ Select Dat e Range Manually : Define a custom time span for the
monitoring data that will be used. Set start and end date below.

Date Range This selection is only visible if the period option is enabled above.
From the list, select a data range for which the report will be
generated. The actual time spans shown depend on the available
monitoring data and on the report period type defined in the
report's settings 1784 . It can be days, weeks, months, or years.

Start Date This selection is only visible if the date range option is enabled
above. Define the begin of the time span for which the report will
be generated. Click in the field and select a date from the calendar.
Make sure you define a valid period.

28.05.2014 1781
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
2 View and Run Reports

Run Report "[Name]"

End Date This selection is only visible if the date range option is enabled
above. Define the end of the time span for which the report will be
generated. Click in the field and select a date from the calendar.
Make sure you define a valid period.

Quick Range This selection is only visible if the date range option is enabled
above. Choose between different pre-defined ranges by simply
clicking on it. With each click the St art and End Dat e fields above
will be changed accordingly.

Processing Opt ions

File Format and Define how you want to view the report. Choose between:
Delivery
§ View Report as HTML: Directly view the report in your web
browser. It will be loaded in a new browser window or tab.
§ Creat e and st ore PDF file: Create a PDF file of the report and
store it. Once finished, you will find it in the St ored Report s tab
and a ToDo ticket 150 will be created. By default, PRTG sends out
a notification mail to the administrator in this case.
§ Creat e PDF file, st ore it and send by email: Create a PDF file of
the report, store it, and send it via email once it is finished.
Note: For large PDF reports, PRTG will automatically split the output
into separate files to avoid huge PDF files. You can change the
number of sensors included into each PDF file by editing the report
templates manually. See More 1783 section below.
Note: In order to create PDF files, ensure that the print spooler
service is running on the system with your PRTG server.

Target Email Address This option is only visible if sending by email is selected above.
Please enter a valid email address the report will be sent to. Note:
Configuration for outgoing email can be changed in the Sy st em
Administ rat ion—Not ificat ion Delivery 1843 settings.

Compression This option is only visible if sending by email is selected above.


Specify if the attached report files will be compressed before
sending. Choose between:
§ Uncompressed: The report files will not be compressed before
they are sent by email.
§ Compressed: The report files will be compressed to a ZIP file
before they are sent by email.

1782 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
2 View and Run Reports

Click on the Run Report button to start report generation. Depending on the number of
selected sensors, this may take a while. If you experience a long waiting time when generating
HTML reports for immediate view, please consider using one of the PDF options. You can then
view the report as soon as it's finished.

Note: Any sensor graphs in your report will only show the channels that are enabled via the
Show in Chart s option in the Sensor Channels Set t ings 1709 of the respective sensor.

Stored Reports

In the St ored Report s tab you can view PDF reports created in the past. Simply click on a
name to open the report. Reports are stored until they are deleted according to the data
purging settings of your PRTG configuration. You can set data purging limits for reports in the
Sy st em Administ rat ion—Core & Probes 1852 settings.

Other Tabs

For all other tabs, please see Report s Set t ings 1784 section.

More
Knowledge Base: Can I change the number of PDFs created by a report?
§ http://kb.paessler.com/en/topic/11863

28.05.2014 1783
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

7.9.3 Reports Settings

In the web interface, click on the Report s entry in the main menu to show the reports main
screen. Click on a report's name to select it. Using the reports tabs you can access all
functionalities and settings for this report. Click on the Go t o all report s button at the
bottom of the page to return to the list of Reports.

Report Tabs

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Run Now

In the Run Now tab you can execute a report immediately with the settings configured. Please
see View and Run Report s 1781 section.

Stored Reports

In the St ored Report s tab you can view reports created in the past. Please see View and Run
Report s 1783 section.

Settings

Click on the Set t ings tab to open a report's settings.

Basic Report Set t ings

Report Name Enter a meaningful name to identify this report.

Template Select a template for the report. This will define the overall look of
your report. There are several report templates delivered with
PRTG. They also define in which detail (interval) monitoring data is
included. You can choose from templates in the following
categories:
§ Dat a Table Only : Create a report with data tables only. Choose
from several intervals.
§ Graph Only : Create a report with graphs only. Choose from
several intervals.
§ Graph wit h Dat a Table: Create a report with graphs and data
table. Choose from several intervals.

1784 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Basic Report Set t ings

§ List of Sensors: Create a report in a compact sensor list style.


This is available with and without graphs.
§ Top 10 Upt ime/Downt ime: Create a report with up to 10
objects with the highest uptime and downtime each. You can
choose between data in percent and hours.
§ Top 100 Highest and Lowest : Create a report with up to 100
objects with the highest and lowest average values. Choose
from different intervals.
§ Top 100 Upt ime/Downt ime: Create a report with up to 100
objects with the highest uptime and downtime each. You can
choose between data in percent and hours.
Monitoring data within an interval is averaged. See also the
comment on data averaging in the Report s 1777 (Automatic
Averaging) section. For information on how to modify templates,
please see More 1793 section below.

Security Context Define the user account that will be used for access to monitoring
data. The report will only contain objects which the selected user
94 is allowed to view. Please choose a user from the list. The
available users depend on your configuration. By default, this is the
user that created the report. PRTG Administrator users can change
this setting.

Timezone Define the time zone that will be used for all date-specific settings
in this report (see below). Select a time zone from the dropdown
list.

Paper Size Define the paper size in which PDF reports will be created. Choose
between:
§ A4: Use German DIN A4 format.
§ Legal: Use US legal paper format.
§ Let t er: Use US letter paper format.

Sensors

Cluster Node This field is only visible when running PRTG in Clust ering 81 mode.
Define the cluster node the report will take monitoring data from.
Choose a cluster node from the list. The available options are
specific to your configuration. Select All nodes to create a report
with data from all of your cluster nodes. Note: A report for all
nodes will include data of the primary sensor channels only, not for
other sensor channels.

28.05.2014 1785
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Sensors

Add Sensors Manually If you want to manually choose the sensors included in this report,
please save settings and switch to the Select Sensors Manually
1791 tab.

Add Sensors by Tag Define the sensors included in this report by tag. Enter one or
more tags; hit enter, space, or comma to confirm a tag. The report
will cover all sensors that have at least one of the tags. Please
enter a string or leave the field empty. Note: Tags are inherited 89
invisibly and automatically. So, for example, if you enter the tag of a
group here, the report will include all sensors within this group. For
detailed information, see Inherit ance of Set t ings 87 section. For
sensors that are added by tag, all sensor channels are included in
the report automatically, except All nodes is selected in the
Clust er Node selection above.

Filter Sensors by Tag Further filter sensors. This is used in combination with sensors that
are added manually, or added implicitly with their manually added
parent objects. From those sensors, only the ones with the tags
entered here will be included. Enter one or more tags to include
sensors in the report; hit enter, space, or comma to confirm a tag.
Please enter a string or leave the field empty.

Schedule

Report Schedule Define when the report will be run. Choose between:
§ No schedule (run int eract ive/on-demand only ): Only use the
options in the Run Now tab to start generation of this report
manually.
§ Every full hour: Run this report every 60 minutes.
§ Every day at a specific hour: Run this report every 24 hours.
§ Every specific day of a week: Run this report every 7 days.
Specify the day below.
§ Every specific day of a mont h: Run this report on a specific
day every month. Specify below.
§ The day aft er a quart er is finished (i.e. at 1. April for t he 1.
January - 31. March Quart er): Run this report for every quarter
of the year.
§ Every specific dat e: Run this report on a specific date every
year. Specify below.

1786 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Schedule

Specify Hour This setting is only visible if specific hour is selected above. From
the list, please select the hour you want to run the report at. PRTG
will automatically choose a suitable time within this hour, usually at
the beginning of it.

Specify Day This setting is only visible if the day of week or day of month
option is selected above. From the list, please select a day of week
or a date of the month you want to run the report. When selecting
Last , the report will always run on the last day of the month,
regardless of how many days the month has. When selecting a date
that does not exist in every month, e.g. the 30th in May, PRTG will
automatically run the report on the last day of this month.

Specify Date This setting is only visible if the specific date option is selected
above. Please enter a valid date in the form DD.MM, e.g. 31.12. The
report will be run annually on this date.

Scheduled Processing This setting is only visible if one of the schedule options is selected
above. Define what will be done when generating a report. Choose
between:
§ Save report t o disk and send it by email: Create a PDF file of
the report, store it, and send it via email. You will find the report
in your emails and in the St ored Report s tab. Define an email
address below.
§ Save report t o disk only : Create a PDF file of the report and
store it. Once finished, you will find it in the St ored Report s tab
and a ToDo ticket will be created. By default, PRTG will send out a
notification mail to the administrator in this case.
§ Send report by email only : Create a PDF file of the report and
send it via email once it is finished. The report is not permanently
stored, but only emailed. Define an email address below.
Note: For large PDF reports, PRTG will automatically split the output
into separate files to avoid huge PDF files. You can change the
number of sensors included into each PDF file by editing the report
templates manually. See More 1793 section below.

Email Address This setting is only visible if a send by email option is selected
above. Please enter a valid email address the report will be sent to.
To enter more addresses, separate them by comma. PRTG will send
a message with all recipients in the "To" field of the email. Note:
Configuration for outgoing email can be changed in the Sy st em
Administ rat ion—Not ificat ion Delivery 1843 settings.

28.05.2014 1787
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Schedule

Send to User Group This setting is only visible if a send by email option is selected
above. From the drop down list, please choose a user group to
send an email with the report to all members of this group (you can
edit user groups under Sy st em Administ rat ion—User Groups 1861
). Note: If you define individual email addresses (see field above)
and a user group, the report will be sent to the individual email
addresses as well as to the members of the selected user group. In
both cases, PRTG will send one message with all recipients in the
"To" field of the email.

Compression This setting is only visible if a send by email option is selected


above. Specify if the attached report files will be compressed
before sending. Choose between:
§ Uncompressed: The report files will not be compressed before
they are sent by email.
§ Compressed: The report files will be compressed to a ZIP file
before they are sent by email.

Period

Reported Period Define the time span covered by the report. Choose between:
§ Current : Use monitoring data of the current period. Define the
period type below.
§ Previous: Use monitoring data of the last period. Define the
period type below.

Report Period Type Define the type of period you want to create a report for. Choose
between:
§ Day
§ Week
§ Mont h
§ Quart er (January -March, April-June, et c.)
§ Year
Depending on your selection, different period selections are
shown below.

Day Period This setting is only visible if day period type is selected above.
Define the hours when a day starts and ends. Choose from the list
of hours. Default setting is 0:00-23:59.

1788 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Period

Week Period This setting is only visible if week period type is selected above.
Define when a week starts and ends. Choose between:
§ Monday -Sunday : A reported week will start on Monday.
§ Sat urday -Friday : A reported week will start on Saturday.
§ Sunday -Sat urday : A reported week will start on Sunday.

Month Period This setting is only visible if month period type is selected above.
Define when a month starts and ends. Choose between:
§ 1.-last day : A reported month will start on the first and end on
last of the month.
§ 15.-14.: A reported month will start von 15th and end on 14th of
the month.

Year Period This setting is only visible if year period type is selected above.
Define when a year starts and ends. Choose between:
§ 1/1-12/31: A reported year will start on January 1st.
§ 7/1-6/30: A reported year will start on July 1st.

Report only for specific Include certain time spans within the defined period only. When a
hours-of-day schedule is selected, only monitoring data for specified hours or
(Schedule) weekdays within the defined period are included in the report.
Select None to include all available monitoring data in the report, or
choose a schedule. For example, select the schedule Weekday s to
exclude all weekends from the report. The available schedules
depend on your configuration. For more information, please see
Account Set t ings—Schedules 1827 section.

Percent ile Set t ings

Show Percentile Define if percentiles 2078 will be included in the report. Choose
between:
§ Off: Do not show percentiles
§ On: Add a column to data tables, showing percentiles for every
sensor channel.
Note: Percentiles are not available for all report templates. If a
template does not support percentiles, they will simply not show
up in the report, even when you enable this setting.

28.05.2014 1789
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Percent ile Set t ings

Show Percentile This setting is only visible when showing percentiles. Enter the
percentile number you want to calculate. If you choose, for
example, to calculate the 95th percentile, enter "95" here and 5 % of
peak values will be discarded.

Percentile Average This setting is only visible when showing percentiles. This is the
(seconds) averaging interval in seconds, which is used for percentile
calculation. Default value is 300 which is equivalent to 5 minutes.

Percentile Mode This setting is only visible when showing percentiles. Choose the
mode for percentile calculation:
§ Discret e: Discrete percentile chooses the next smaller discrete
value.
§ Cont inuous: Continuous percentile interpolates between
discrete values.
For details, see section Calculat ing Percent iles 2078 .

Report Comment s

Introduction Define a custom text that will show up on the first page of the
report. Please enter a string or leave the field empty.

Footer Comments Define a custom text that will show up on the last page of the
report. Please enter a string or leave the field empty.

1790 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists.
§ Read: Users in this group can see the object and review its
settings.
§ Writ e: Users in this group can see the object, as well as review
and edit its settings. However, they cannot edit access rights
settings.
§ Full: Users in this group can see the object, as well as review and
edit its settings and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Select Sensors Manually

Click on the Select Sensors Manually tab to manually choose sensors that will be included in
the report. You will see a split screen: On the left side, your list of objects is show (empty in
the beginning), and on the right side, you see a less colorful view of your device tree, as
known from the device tree's Management 222 tab. Adding objects to the report is very easy.

28.05.2014 1791
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Manual Selec tion for Reports

§ Add It ems
From the device tree on the right side, drag objects and drop them on the list on the left
side. This can be entire probes, groups, devices, or single sensors. Each dropped object will
be added immediately as a new list item. Repeat this procedure as often as you wish until
you have added all desired items to the library. Note: Objects that already exist in the list on
the left side will be grayed out in the device tree on the right side.

§ Select Sensor Channels


If in the report settings one specific cluster node is selected and if you are adding a sensor
to the selection, you can specify the sensor channels that will be included in the report. By
default, all channels are selected. To exclude a channel from the report, simply remove the
check mark in front of a channel's name. Note: If All nodes is selected in the report's Clust er
Node selection, the channel selection is not available, but only the primary channel of every
sensor is included automatically.

§ Remove
To remove any objects from the report, click on the trash can symbol next the respective list
item, or select several list items while holding down the Ctrl key and click on the green trash
symbol appearing at the top of the list.

Your selection is saved automatically, and there is no undo function. Note: The final report will
include both sensors selected manually and those selected by tag.

1792 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 9 Reports
3 Reports Settings

Sensors Selected by Tag

Click on the Sensors Select ed by Tag tab to view all sensors that are added to the report
depending on the report's Add Sensors by Tag setting. In the table list 156 , you will see all
sensors that are added by tag. This is for your information only, you cannot change sensors
here. However, you can switch to the report's Set t ings tab and change the tabs that are used
to add sensors. Additionally, you can also exclude sensors with certain tabs there. The final
report will include both sensors selected manually and those selected by tag.

For sensors that are added by tag, all sensor channels are included in the report automatically,
except All nodes is selected in the report's Clust er Node selection. In this case, only the
primary channel of every sensor is included. Note: The final report will include both sensors
selected manually and those selected by tag.

Comments

In the Comment s tab you can enter free text for each object. This can be used for
documentation purposes or to leave information for other users.

More
Knowledge Base: Can I change the number of PDFs created by a report?
§ http://kb.paessler.com/en/topic/11863

Knowledge Base: How do I modify PRTG's report templates?


§ http://kb.paessler.com/en/topic/263

Knowledge Base: How can I show full channel names below report graphs?
§ http://kb.paessler.com/en/topic/58913

§ Calculat ing Percent iles 2078

28.05.2014 1793
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps

7.10 Maps
With PRTG's Maps feature (some people might call this 'dashboards') you can create web pages
with up-to-the-minute monitoring status information in a customizable layout. Using this unique
concept, you can also make your overview pages of live data publicly available, if you like.

Example of a PRTG Map

In this section:

§ Int roduct ion 1794

§ St art Maps 1795

§ Maps Overview 1795

§ Maps Rot at ion 1796

§ Working wit h Maps 1796

Introduction

There are countless possibilities for the implementation of maps. For example, this feature can
be used to:

§ Create network maps with status icons for each device on the map.

1794 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps

§ Create quick views of your network that can be shown on network operations center
screens.
§ Create a quick network overview for publishing on the Intranet, allowing at-a-glance
information for management of other employees.
§ Create a custom view of the most important sensors in your monitoring setup.
§ Create Top 10 lists of the sensors of a specific group or device.

Technically, a map is a usual HTML web page. You can build a schema of your network by
choosing from hundreds of device icons and connect them with lines. A map can consist of
the following elements:

§ A set of map items, which can include device icons, sensor status icons, graphs, data tables,
lists of sensors, connection lines, geographical maps, or custom HTML code.
§ An optional background image (a JPG, PNG, or GIF file, for example, your company logo or a
graphical view of your network).

You can also specify the size of the map. Using the AJAX-based map editor, you can place the
items anywhere on the map and you can also change their size. Each map has a unique URL
which can be used to link to the map. Users who want to access the map either need an
account in your PRTG installation, or can access a public URL of the map if you allow the Public
Access feature. Public maps contain a unique Map ID access key in the URL to block
unwanted visitors.

Start Maps

Click the Maps entry from the main menu 182 to view or add custom views of your network's
status and monitoring data. Hover to show other menu items. Choose between:

§ All
Calls the Maps feature where you can view or add custom views of your network's status
and monitoring data.
§ Add Map
Lets you directly add 1797 a new map.
§ Select Map ›
Show existing maps. Hover to show other menu items. Follow the menu path (it is specific
to your setup) to select a map.

Maps Overview

In the All view, you see a list of all existing maps. Using the links next to a map name, you can
perform the following actions.

§ Click on the name of a map to view it.


§ Click on the Edit button to adjust the settings of this map.
§ Click on the Clone button to create an exact copy of this map. As soon as you click, the
map is cloned and the cloned map's settings are shown.

03.04.2014 1795
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps

§ Click on the Delet e button to remove this map.


§ Click on the Add Map button to add a new map.

Please see also Working wit h Table List s 156 . Additionally, there is multi-edit available. This
enables you to change properties of several objects at a time. For more details, please see
Mult i-Edit List s 1736 section.

Map Rotation

To show several maps in a rotation, mark the desired maps using multi-edit 1736 and then select
Map Rot at ion from the multi-edit menu. You will be redirected to a page where the rotation is
shown. This requires login credentials for PRTG.

It is also possible to set up a public map rot at ion without login: Allow public access in the
settings 1806 of the desired maps. Use the corresponding map IDs with its secret keys to build a
URL that calls a public map rotation. The URL must have this format: the address of your PRTG
server, followed by /public/mapshow.htm?ids=. Then list the IDs of the desired maps, each
separated by a comma. Each map ID has to be connected with its secret key using a colon:
ht t p://yourprtgserver/public/mapshow.ht m?
ids=mapid1:secretkey1,mapid2:secretkey2,mapid3:secretkey3

While a map rotation is shown, you can change the refresh interval any time when hovering the
arrows symbol in the lower right corner. Choose between 10, 30, or 60 seconds, 10 minutes
or Refresh now.

Working with Maps

For detailed information on how to create and edit maps, and to learn how to make them
accessible to others, please see the following sections.

§ Maps St ep By St ep 1797

§ Maps Designer 1800

§ Maps Ot her Set t ings 1806

1796 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
1 Maps Step By Step

7.10.1 M aps Step By Step

In order to create a new map, follow the steps in this section. In the web interface, click on
Maps entry in the main menu to show the maps main screen.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

In this section:

§ St ep 1: Add Map 1797

§ St ep 2: Add Map It ems 1798

§ St ep 3: View and Share 1798

Step 1: Add Map

Click on the Add Map button. An assistant is shown. Enter a Map Name and define Map
Lay out settings (size and optionally a background image). in the Public Access section, define
whether your map will be visible without login.

For detailed information, see Maps Ot her Set t ings 1806 section (Settings).

03.04.2014 1797
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
1 Maps Step By Step

Add Maps Assistant Step 1

Step 2: Add Map Items

Click on the Cont inue t o st ep 2 button to open the Map Designer. Drag&drop an object
from the items list on the right side, define further properties of the item (mark it in the main
window of the map designer and see section Propert ies on the right), and confirm. The item
will be added immediately. Repeat this procedure as often as you wish until you have added all
desired items to the map. Drag items to change their position. Additionally, you can also draw
connection lines between items or edit existing items.

For detailed information, see Maps Designer 1800 section.

Step 3: View and Share

Click on the View Map tab to see the appearance of your map. Later, it will be shown the way
you see it there. If available for an object, most object names as well as all sensors can be
clicked on. It depends on the object's access rights and the currently logged in user account if
clicking the links will lead to more detailed information about the object or to an error
message indicating insufficient access rights.

Click on the Get HTML tab to get the direct URL of your map that you can share with others.
For detailed information, see Maps Ot her Set t ings 1808 section.

1798 03.04.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
1 Maps Step By Step

While showing a map, the single map items will be refreshed in the refresh interval defined for
this map.

03.04.2014 1799
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
2 Maps Designer

7.10.2 M aps Designer

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

In this section:

§ Use a Proper Browser 1800

§ Basic Design Concept 1800

§ Device Tree Select ion 1801

§ Propert ies Select ion 1802

§ Edit Exist ing Map It ems—Propert ies Box 1803

§ Edit Exist ing Map It ems—Hover Icons 1803

§ Edit Exist ing Map It ems—Using Cursor Key s 1804

§ Draw Connect ion Lines Bet ween It ems 1804

§ Snap To Grid 1804

§ More 1804

Use a Proper Browser

Due to the map designer's extensive scripting capability, it is important that you use a
compatible browser when editing maps. We recommend using Google Chrome 34 or later
(recommended) or Mozilla Firefox 28 or later. You can use Microsoft Internet Explorer 10 or 11
as well. The maps designer is not fully compatible with earlier versions of Internet Explorer or
Opera browsers.

Basic Design Concept

Click on the Map Designer tab to open the editor. It might take a few moments to load (for
unresponsive script warnings, please see More 1804 section below). Here, you can create your
map by adding or changing items. The designer screen consists of three main parts: The
Device Tree on the left side, the current Map in the middle, and the Propert ies on the right
side.

1800 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
2 Maps Designer

Map Designer

Each map item takes attributes from both selections.

§ Device Tree (left): Select the monitoring object which's data will be shown on the map
§ Propert ies (right): Define how the map item will be shown

Simply drag and drop any object from either side onto the map, or double-click on an object.
You will always see all changes immediately.

Device Tree Selection

Use the Device Tree to select the monitoring object which's data will be shown on the map
(this can be a probe, a group, a device, or a single sensor). In order to find the right object, you
have the following options:

§ Use the arrow symbols at the beginning of each line to open nodes in the device tree to
show objects underneath probes, groups, and devices.
§ Enter a few characters into the Search box in the upper left corner to search for names (or
part of names) of objects in your configuration. The search results will be shown
immediately. Click on the red x icon to clear your search.

No matter which method you choose to find the desired object, you can always drag any
object from the Device Tree on a free area of the map to create a new map item. If you drag it
onto an existing map item, it will be replaced, while Propert ies and size will remain. You can
also select a map item and double click on a Device Tree object to replace the map item. If no
item is selected, a double-click on an object will add a new map item.

To gain more space for map editing, reduce the size of the Device Tree box by dragging its
right border to left (or to the right to enlarge it again).

28.05.2014 1801
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
2 Maps Designer

Properties Selection

Use the Propert ies selection to define how the map item will be shown (for example, as an
icon, a map, a table, or a graph). Select the appearance in different categories. Hover a
property object to get a live preview of it (in most cases). Note: If a certain Propert ies object
is not available for the selected Device Tree object, you will see a corresponding text hint.

There are many different property object types available. Simply click a category's name to
show all available types.

§ Icons A, Icons B, Icons C


These three categories offer a variety of iconic symbols of typical network devices. Below
each icon the object name and a sensor overview for the object is shown. This shows how
many sensors are in which state. For some sensors, a mini graph is shown as well.
§ Icons A (St at ic), Icons B (St at ic), Icons C (St at ic)
These three categories offer the same variety of iconic symbols of typical network devices
as the category described above. Here, no object data displayed with them, but only the
icon is shown.
§ St at ic Maps
This category offers free or public domain geographical maps from different sources. For
additional geographical maps, please see More 1804 section below. Note: The items in this
section are independent from the selected Device Tree objects.
§ St at us Icons
This category shows options to insert status icons in different styles. These show the
object name and an overview of how many sensors are in which state. There is also an
object available for audible alert which will play a sound when the number of alarms of the
monitored object are > 0. Please note that your browser must support playing embedded
sounds (see More 1804 section below for further information).
§ Geo Maps
In this category you can choose from different geographical map styles from Google: road
map, satellite, hybrid, and terrain maps. The location of the currently selected object in the
Device Tree will be shown on the map as a pin mark. To use this feature, Geo Maps
integration must be enabled and you have to enter a Locat ion in the settings of the
monitoring object you want to use this with. For more information, please see Geo Maps 1744
section. Note: If Geo Maps integration is disabled, you will only see white boxes instead of
map previews.
§ Graphs
This category offers different graph styles in several dimensions and detail. You can also
select graphs including a legend or sensor states.
§ Object s
Add some simple geometric shapes to your map. The items shown in this tab are always the
same; the range displayed does not depend on the selected object in the Object field
above.
§ Dat a Tables
Choose from several tables showing sensor lists for the current selected object. You can
also choose from several lists showing sensors in a certain state only.

1802 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
2 Maps Designer

§ Top 10
Choose from several tables showing the top 10 of sensors with certain monitoring data,
such as least used CPUs, highes bandwidth usage, best availability, slowest websites, etc.
Note: In order to provide live previews, PRTG calculates all top 10 lists from your monitoring
data when opening this tab. It may take a few seconds before thumbnails are shown.
§ Cust om HTML
This can be used, for example, to add external images or applets to your map. In order to
actually add custom HTML code to your map, please add this item and then click on it to edit
1803 . You can then copy your custom code into the HTML Before and HTML Aft er fields in

the Propert ies box on the right side.

No matter which object you choose, you can always drag any object from the Propert ies box
on a free area of the map to create a new map item. If you drag it onto an existing map item, it
will be replaced, while its Device Tree object attributes and size will remain. You can also
select a map item and double click on an object in the Propert ies box to replace the map
item. If no item is selected, a double-click on an object will add a new map item.

To gain more space for map editing, reduce the size of the Propert ies box by dragging its left
border to right (or to the left to enlarge it again).

Edit Existing Map Items—Properties Box

Click on a map item to select it. You can then edit its attributes with the fields in the upper part
of the Propert ies box on the right side:

§ Top, Left , Widt h, and Height fields


Enter position and size values for direct positioning. Click the Save button to save your
settings. Alternative: Use the mouse to move and resize a map item.

§ Lay er field
The layer number defines if an item will be shown on top of or behind another item, if
overlapping. The item with the higher number will be shown on top. Enter a positive integer
value and click the Save button to save your settings. Alternative: Use the arrow symbols in
a map item's hover menu to Bring t o front or Send t o back an item one layer (see below).

§ HTML
Click on the arrow symbol underneath to show the HTML Before and HTML Aft er fields. Any
HTML code you enter in these fields will be added before respectively after the map item.
Please enter your custom HTML code that embeds an objects and click the Save button.
Your HTML object will be inserted. For example, you could enter the code <img src="http://
media.paessler.com/common/img/logoclaim_r1.gif"> to insert an image of the Paessler logo
from the Paessler website.

Edit Existing Map Items—Hover Icons

Hover a map item to show the edit icons for it.

§ Bring t o front (arrow up sy mbol)


Move this item one layer to the front. This is useful when adding several items to a map that
overlap each other.

28.05.2014 1803
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
2 Maps Designer

§ Send t o back (arrow down sy mbol)


Move this item one layer to the back. This is useful when adding several items to a map that
overlap each other.

§ Delet e (t rash sy mbol)


Delete this item. Note: Be careful! The item will be deleted immediately without notice and
you cannot undo this. Alternative: Select the item and press the Del button on your
keyboard.

§ Drop Connect ions (scissors sy mbol)


If you have drawn connection lines between two items, you can delete all lines starting from
this item. Connection lines will be dropped immediately. Note: If a line between two items is
not dropped, you've probably drawn it starting from the other item. Try the scissors symbol
on the other item instead.

Edit Existing Map Items—Using Cursor Keys

While an object is selected, use the cursor keys to move it by one pixel. Hold the Shift key in
combination with the cursor keys to move the object by 10 pixels.

Draw Connection Lines Between Items

You can draw connection lines between any map items via drag and drop. Simply click on the
grey handles next to an item and drag a line to another item you want to draw a connection
to. A line will be shown immediately. This can be useful to indicate network connections or
logical coherences between two items. To delete connection lines, click the scissors symbol in
the item's edit icons 1803 .

Lines between objects are colored dynamically. They will turn red as long as one of the
object's icons shows a red Down status. This will only affect half of the line, at the end where
the red sensor is shown. If both objects connected show a red sensor, this will result in a line
that is red all over.

Snap to Grid

Select whether to use Snap To Grid or Don't Snap, using the buttons underneath the Device
Tree box. This will affect how map items will be positioned when adding or moving them via
drag and drop. The setting is active immediately. With snap to grid enabled, you can place items
aligned with the grid only.

More
Knowledge Base: Why does my browser show an unresponsive script warning while loading
the Maps Designer?
§ http://kb.paessler.com/en/topic/19483

1804 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
2 Maps Designer

Knowledge Base: Where can I download free political/topographical map images for use in
PRTG map editor?
§ http://kb.paessler.com/en/topic/7463

Knowledge Base: Which audible notifications are available in PRTG? Can I change the default
sound?
§ http://kb.paessler.com/en/topic/26303

Knowledge Base: How can I add "deep links" into PRTG's interface for map status icons?
§ http://kb.paessler.com/en/topic/3763

Knowledge Base: How can I add or edit map objects used for PRTG's maps?
§ http://kb.paessler.com/en/topic/1703

Knowledge Base: How to setup interactive maps?


§ http://kb.paessler.com/en/topic/2253

Knowledge Base: Can you re-order or remove columns in sensor lists displayed in maps?
§ http://kb.paessler.com/en/topic/5523

Knowledge Base: How can I show up-to-date weather information, webcam and radar images in
PRTG's maps
§ http://kb.paessler.com/en/topic/9263

Knowledge Base: Can I use my own images/icons/logos in PRTG's map editor?


§ http://kb.paessler.com/en/topic/8043

28.05.2014 1805
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
3 Maps Settings

7.10.3 M aps Settings

Using the Map tabs you can access all functionalities and settings for a map.

Map Tabs

View Map

Click on the View Map tab any time to show a preview of your map.

Map Designer

Click on the Map Designer tab to edit the contents of your map. Please see Maps Designer 1800

section.

Settings

Click on the Set t ings tab to open a map's general settings. Note: When using the Add Map
dialog, not all of these settings are available. You can change them later by clicking on the
Set t ings tab.

Basic Map Set t ings

Map Name Enter a meaningful name for the map.

Security Context Define the user account that will be used for access to monitoring
data. The map will only contain objects which the selected user 94
is allowed to view. Please choose a user from the list. The available
users depend on your configuration. By default, this is the user that
created the map. PRTG Administrator users can change this setting.

Timezone Define the time zone that will be used for all date-specific options
in this map. Select a time zone from the list.

Tag Filter This setting affects table maps objects. Enter one or more tags
separated by space or comma to include sensors in tables. Only
sensors with one of the tags entered here will appear in this map's
data tables—including sensors which inherit 87 tags from parent
objects. Please enter a string or leave the field empty. Note: Use
with care! This setting will affect all tables of the current map!

1806 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
3 Maps Settings

Map Lay out

Map Width Define the width of the map in pixels. Please enter an integer value.

Map Height Define the height of the map in pixels. Please enter an integer
value.

Background Picture Define if you want to use a background picture for the map.
Choose between:
§ On: Use a background image (define below).
§ Off: Do not use a background image.

Background Image This option is only visible if a background picture is enabled above.
Click on the Choose File button and select an image from your
computer or network. Note: Only images in the format JPG, PNG,
and GIF are supported. The file size must be smaller than 2 MB. If
you try to upload other images, you will get an error message. In a
cluster, background images are not automatically deployed to the
other nodes! In order to view maps on other nodes, please copy
the background pictures manually to \webroot\mapbackground of
the program directory on every node. For detailed information on
how to find this path, please see Dat a St orage 2074 section.

Background Color Select a background color for this Map. Either enter a hex color
code or choose a color from the color selector. The hex color
code field will always display the currently defined color.

Public Access

Public Access Define if others can see the map. Choose between:
§ No Public Access: Do not allow public access to the map. Only
users with both a login to the PRTG web interface and sufficient
access rights can see the map.
§ Allow Public Access: Allow access to the map using a unique
address. The URL contains a key that you can change below.

Secret Key This field is only visible if public access is enabled above. The key is
automatically generated. It is part of the public URL for the map.
You can also enter a customized string. We recommend using the
default value. For more information on public access, please see
the Get HTML 1808 section. Note: The characters comma "," and
colon ":" are not allowed in the secret key field!

28.05.2014 1807
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
3 Maps Settings

Access Right s

User Group Access Define which user group(s) will have access to the object you're
editing. A table with user groups and right is shown; it contains all
user groups from your setup. For each user group you can choose
from the following access rights:
§ Inherit ed: Use the settings of the parent object.
§ None: Users in this group cannot see or edit the object. The
object does not show up in lists.
§ Read: Users in this group can see the object and review its
settings.
§ Writ e: Users in this group can see the object, as well as review
and edit its settings. However, they cannot edit access rights
settings.
§ Full: Users in this group can see the object, as well as review and
edit its settings and edit access rights settings.
You can create new user groups in the Sy st em Administ rat ion—
User Groups 1861 settings.

Click on the Save button to store your settings. If you change tabs or use the main menu, all
changes to the settings will be lost!

Get HTML

Your PRTG map is like a standalone HTML page. You can make it accessible to others, if you
like. Depending on the Public Access setting 1806 of your map, a visitor will need to provide
PRTG user account login data to view the map, or will see the map immediately using a URL
containing a secret key. When using this unique key, you can also include your map on
another webpage, embedding it via <iframe>.

§ Opt ion 1: Link t o a web page wit h t he map t hat requires login credent ials
The shown URL requires login credentials in order to display the map. PRTG will ask the user
trying to view the map via this URL for login credentials. Note: In the URL, usually the IP
address is given via which the page is available. Maybe a NAT translation is set in your
firewall, or you may want to use a domain name or a name from a dynamic DNS service for
public access. Please customize URL you use for access to your needs.
§ Opt ion 2: Link t o a web page t hat display s t he map wit hout a login
In order to get the shown URL working for public access without a login, enable Allow
Public Access in the settings tab 1806 of your map. Note: In the URL, usually the IP address is
given via which the page is available. Maybe a NAT translation is set in your firewall, or you
may want to use a domain name or a name from a dynamic DNS service for public access.
Please customize URL you use for access to your needs.

1808 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 10 Maps
3 Maps Settings

§ Opt ion 3: Show a map inside ot her web pages using an IFRAME
For your convenience, this shows source code for adding an iframe to another webpage. It
includes a URL for direct access. Just copy the code and paste it into your webpage's code.
Also enable Allow Public Access in the settings tab 1806 . Note: In the URL, usually the IP
address is given via which the page is available. Maybe a NAT translation is set in your
firewall, or you may want to use a domain name or a name from a dynamic DNS service for
public access. Please customize URL you use for access to your needs.

While a map is shown via these URLs, you can change the refresh interval any time by hovering
the arrows symbol in the lower right corner. Choose between 10, 30, or 60 seconds, 10
minutes or Refresh now.

Comments

In the Comment s tab you can enter free text for each object. This can be used for
documentation purposes or to leave information for other users.

History

In the Hist ory tab all changes in the settings of an object are logged with a timestamp, the
PRTG user which conducted the change, and a message. The history log keeps the last 100
entries.

Delete

You can delete the entire map any time by clicking on the trash symbol on the right.

More
Knowledge Base: How to disable links in public maps?
§ http://kb.paessler.com/en/topic/10283

§ Dat a Report ing 93

28.05.2014 1809
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup

7.11 Setup
In the setup settings of the PRTG web interface, you can define almost all system settings for
PRTG. However, some of the machine-oriented settings are defined using two Windows
administration tools (see Ot hers 1811 section below).

In the main menu, click on Set up to show the available options.

Setup Ov erv iew Page

Account Settings
§ Account Set t ings—My Account 1812

§ Account Set t ings—Not ificat ions 1817

§ Account Set t ings—Schedules 1827

System Administration
§ Sy st em Administ rat ion—User Int erface 1831

§ Sy st em Administ rat ion—Monit oring 1839

§ Sy st em Administ rat ion—Not ificat ion Delivery 1843

1810 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup

§ Sy st em Administ rat ion—Core & Probes 1849

§ Sy st em Administ rat ion—Clust er 1855

§ Sy st em Administ rat ion—User Account s 1856

§ Sy st em Administ rat ion—User Groups 1861

§ Sy st em Administ rat ion—Administ rat ive Tools 1865

PRTG Status
§ PRTG St at us—Sy st em St at us 1869

§ PRTG St at us—Aut o-Updat e 1878

§ PRTG St at us—Clust er St at us 1883

§ PRTG St at us—Act ivat ion St at us 1884

Optional Downloads and Add-Ons


§ Downloads—Client App for Windows (Ent erprise Console) 1885

§ Downloads—Client Apps for Mobile Devices 1885

§ Downloads—Remot e Probe Inst aller 1885

§ Chrome Deskt op Not ificat ions 1887

Support
§ Support —Cont act Support 1889

Others

There are some settings that have to be made in the Sy st em Administ rat ion Tools 1998 ,
running as Windows applications. For more details, please see sections:

§ PRTG Server Administ rat or 1999

§ PRTG Probe Administ rat or 2016

28.05.2014 1811
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
1 Account Settings—My Account

7.11.1 Account Settings—M y Account

In the My Account settings you can define values regarding your own PRTG user currently
logged in. All settings in this section are user specific. Some account control options may not
available, but can only be defined by the administrator.

My Ac c ount Settings

My Account Settings

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

User Account

Login Name Enter the login name for the user.

Display Name Enter a name for the user for display purposes. This will not be
used for login.

1812 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
1 Account Settings—My Account

User Account

Email Address Enter the user's email address.

Timezone Enter the time zone for the current user.

Date Format Enter in what format dates will be displayed for the current user.
Note: This setting will take effect after the next login.

Password Define the user's password. For security reasons, the account
settings page does not contain the password. Choose between:
§ Don't change
§ Specify new password
If you choose to specify a new password, enter the old password,
and the new password twice.
Note: The new password must be at least 8 characters long; no
character may occur more than 3 times. It must contain a number
and a capital letter.

Hash The hash (passhash) value can the used as password substitute
when calling functions from PRTG's Application Programming
Interface (API) that require an authentication. For more information
please see Using t he PRTG API (Applicat ion Programming
Int erface) 2031 section.

Aut o Refresh and Alert ing

Auto Refresh Type Specify how PRTG's web pages will be refreshed for the current
user. Choose between:
§ Refresh page element s using AJAX (recommended):
Automatically refresh the single page elements on the web
pages.
§ Refresh whole page: Automatically reload the whole page with
every refresh interval.
§ No aut o refresh: Do not automatically refresh web pages.

Auto Refresh Interval This setting is only relevant when auto refresh is enabled above.
(Sec.) Enter the number of seconds that will be waited between two
refreshes. We recommend using 30 seconds or more. Minimum
value is 20 seconds. Note: Shorter intervals create more CPU load
on the server running the PRTG core server. If you experience load
problems while using the web interface (or PRTG maps 1794 ), please
set a higher interval.

14.01.2014 1813
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
1 Account Settings—My Account

Aut o Refresh and Alert ing

Play Audible Alarms Define when an audible alarm will be played for the current user on
web pages whenever there are alarms 144 in PRTG. Choose
between:
§ Never: Do not play sound files on any web pages.
§ On dashboard pages only : When there are alarms, play a
predefined sound on dashboard 175 pages only. The sound will be
replayed with every refresh of a dashboard page.
§ On all pages: When there are alarms, play a predefined sound on
all web pages. The sound will be replayed with every page
refresh.
For more information about audible notifications and supported
browsers, please see More 1816 section below.

Ticket Sy st em

Email Notifications Define if you want to get emails from the ticket system. Choose
between:
§ I want t o receive an email whenever a t icket changes: You
will receive an email each time a ticket is assigned to you or your
user group, or if a ticket which is assigned to you or your user
group is changed. Note: If you edit tickets which are assigned to
you or your user group, or you assign a ticket to yourself or
your user group, you will not get an email.
§ I do not want t o receive any emails from t he t icket sy st em:
You will not get any emails about tickets.

Web Int erface

Homepage URL Define the user's default page loaded after login and when clicking
on the Home 175 button in main menu.

Max. Groups/Devices In order to provide you with a speedy user experience PRTG tries
per Group to keep the page size for the page showing the device tree small
by automatically folding groups and devices with many items.
Define how many groups and devices are shown at maximum
before the automatic reduction is performed. We recommend using
a value between 10 and 30.

1814 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
1 Account Settings—My Account

Web Int erface

Max. Sensors per In order to provide you with a speedy user experience PRTG tries
Device to keep the page size for the page showing the device tree small
by automatically folding groups and devices with many items.
Define how many sensors are shown at maximum before the
automatic reduction is performed. We recommend using a value
between 10 and 30.

Account Cont rol

Account Type This setting is only shown for administrator users. However, it is
not shown if the user you modify the account settings for is a
member of a group with administrative rights.
Define the account type for the current user. Choose between:
§ Read/Writ e User: The user may change settings.
§ Read Only User: The user may not edit any settings. This is a
good choice for public or semi-public logins.
Note: This setting cannot be changed for the default administrator
user.

Allow Acknowledge This setting is only visible if read only user is enabled above.
Alarms Acknowledging an alarm is an action which requires write access
rights. However, you can explicitly allow this action to read-only
users. If enabled, they still do not have write access, but may
acknowledge alarms 145 . Choose between:
§ Allow: Allow acknowledging alarms for this user.
§ Deny : The user will not be able to acknowledge alarms.

Primary Group This setting is only shown for administrator users. Select the
primary group for the current user. Every user has to be member of
a primary group to make sure there is no user without group
membership. Membership in other user groups is optional. For user
experience, there is no difference between the primary and other
user groups.

Status This setting is only shown for administrator users. Define the
status of the current user. Choose between:
§ Act ive: The current user can login to the account.
§ Inact ive: The current user's login is disabled. Use this option to
temporarily deny access for this user.
Note: This setting cannot be changed for the default administrator
user.

14.01.2014 1815
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
1 Account Settings—My Account

Account Cont rol

Last Login Shows the time stamp of the user's last login. This setting is shown
for your information only and cannot be changed here.

User Groups

Member of Shows the groups the current user is member of. Access rights to
the device tree are defined on group level. This setting is shown
for your information only and cannot be changed here.

Comments

In the Comment s tab you can enter free text for each object. This can be used for
documentation purposes or to leave information for other users.

History

In the Hist ory tab all changes in the settings of an object are logged with a timestamp, the
PRTG user which conducted the change, and a message. The history log keeps the last 100
entries.

Click on the Cont inue button to store your settings. If you change tabs or use the main menu,
all changes to the settings will be lost!

More
Knowledge Base: Which audible notifications are available in PRTG? Can I change the default
sound?
§ http://kb.paessler.com/en/topic/26303

1816 14.01.2014
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
2 Account Settings—Notifications

7.11.2 Account Settings—Notifications

In the notifications settings you can define and change notifications for the currently logged in
PRTG user. They can be triggered for certain sensor states and data.

Notific ation Settings

Note

This section describes one of three steps to set up the notification system in PRTG. A
complete notification setup involves:

1. Check and set up the Not ificat ion Delivery settings. This will tell PRTG how to send
messages.
For detailed information, see Sy st em Administ rat ion—Not ificat ion Delivery 1843 .
2. Check and set up several Not ificat ions. This will define the kind of message and its
content.
For detailed information, see Account Set t ings—Not ificat ions 1817 .
3. Check and set up Not ificat ion Triggers for objects. These will provoke the defined
notifications.
For detailed information, see Sensor Not ificat ions Set t ings 1716 .

For background information, please see Not ificat ions 1749 section.

28.05.2014 1817
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
2 Account Settings—Notifications

Notifications Overview

Click on the Not ificat ions tab to show a list of all existing notifications. Using the links next
to the notification name, you can perform the following actions:

§ Delet e: Delete this notification (not possible for predefined notifications)


§ Test : Trigger this notification immediately for testing purposes. Note: When using
placeholders, they will not be resolved in a test notification, but the variables will be sent
instead.
§ Pause: Pause this notification. If a notification is paused, no messages will be sent when it is
triggered.
§ Clone: Create an exact copy of this notification. It will be added to the notifications list as
Clone of ...
§ Used by : Show a list of objects using this notification.

Please see also Working wit h Table List s 156 . Additionally, there is multi-edit available. This
enables you to change properties of several objects at a time. For more details, please see
Mult i-Edit List s 1736 section.

Notifications Settings

Click on the Add new not ificat ion button to add a new notification, or click on the name of
an existing notification to edit it.

Note: This documentation refers to the PRTG Sy st em Administ rat or user accessing the Ajax
interface on a master node. For other user accounts, interfaces, or nodes, not all of the
options might be available as described. When using a cluster installation, failover nodes are
read-only by default.

Basic Not ificat ion Set t ings

Notification Name Enter a meaningful name for the notification, for example, SMS to
service team or similar.

Status Select the status of the notification. Choose between:


§ St art ed: This notification will be active.
§ Paused: Pause this notification. If a notification is paused, no
messages will be sent when it is triggered.

1818 28.05.2014
Part 7: Ajax Web Interface—Advanced Procedures | 11 Setup
2 Account Settings—Notifications

Basic Not ificat ion Set t ings

Schedule Define when this notification will be active. Please select None to
set it to always active, or choose a schedule from the list. Usually
schedules define when this notification will be active; schedules
defined as period list set this notification to inactive at the
corresponding time spans. The available options depend on your
setup. To add or change existing schedules, please see Account
Set t ings—Schedules 1827 section.

Postpone Define if notifications triggered during Pause status will be sent


later on.
§ No: Discard all notification triggers received while the notification
is paused.
§ Yes: Collect all notification triggers received while the notification
is paused. Send out notifications once the pause status ends.

Not ificat ion Summarizat ion

Method Define if and how notifications will be summarized if several


notification triggers are received in a certain time span. Note:
Regardless of the option chosen here, notifications of Execut e
HTTP Act ion and Execut e Program are always sent ASAP; they are
never summarized. Choose between:
§ Alway s not ify ASAP: Always send out one notification for each
notification trigger received.
§ Send first DOWN message ASAP, summarize ot hers: When
receiving several Down triggers, send the first notification
immediately, but summarize other notifications into one
message.
§ Send first DOWN and UP message ASAP, summarize ot hers:
When receiving several Down or Up triggers, send each first
notification immediately, but summarize other notifications into
one message.
§ Send all DOWN messages ASAP, summarize ot hers: When
receiving several Down triggers, send out one notification for
each trigger received, but summarize notifications for all other
triggers into one message.
§ Send all DOWN and UP messages ASAP, summarize ot hers:
When receiving several Down or Up triggers, send out one
notification for each trigger received, but summarize notifications
for all other triggers into one message.
§ Alway s summarize not ificat ions: When receiving several

You might also like