ActiveXperts Network Monitor Manual

ActiveXperts Software B.V. - www.activexperts.com - contact@activexperts.com
Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of ActiveXperts Software B.V. Products named herein may be trademarks of their respective manufacturers and are hereby recognized. Trademarked names are used editorially, to the benefit of the trademark owner, with no intent to infringe on the trademark.

1. Introducing Network Monitor

1.1. Product Overview

ActiveXperts Network Monitor is a network and server monitoring tool to allow administrators to monitor the network for failures and irregularities automatically. It can monitor all aspects of your LAN- and WAN servers, workstations and IP devices. For years, ICT administrators, network operators and helpdesk employees have relied upon the power, flexibility and reliability of ActiveXperts Network Monitor.

The mission of the product is to maximize the reliability of your production servers and applications through the automatic detection and correction of problems and issues. The product runs as a service on a Windows 2022/2019/Windows 2016/Windows 2012(R2)/2008(R2)/11/10/8/7/ platform. There's a 64-bit edition and a 32-bit edition of the software.

When a problem is detected, you're immediately notified by e-mail, SMS, pager, SNMP trap or network message. If possible, the network monitor tool will try to correct the problem.

The two main programs of ActiveXperts Network Monitor are:

  • ActiveXperts Network Monitor Engine - the Engine, running as a Windows background service;
  • ActiveXperts Network Monitor Manager - a Windows forms application used to configure the software and view the results.

The ActiveXperts Network Monitor Engine service is the Engine of the product; it runs in the background as a Windows Service, without a user interface. It continuously monitors servers, workstations and IP devices in your LAN/WAN for availability. This Engine is also responsible for notifying, triggering actions, recovery and logging. There's no agent software required on the servers being monitored; the monitoring service uses protocols and application layers of the Operating System to do its job.

The ActiveXperts Network Monitor Manager application is used to view the results and to make changes to the configuration. This Manager application allows you to visually monitor the network from any desktop PC.

The Manager application can be installed on any Windows 7 or higher workstation, or any Windows 2008 or higher server, and has different authority levels. You can for instance restrict your help desk staff to only see monitoring results, and allowing network operators to make changes to the configuration.

1.2. Product Features

Monitoring features
  • Monitor operating systems, including Windows, Linux and Unix;
  • Monitor virtualization platforms, including VMware, Citrix XenServer and Microsoft Hyper-V;
  • Monitor application services and performance counters;
  • Monitor databases;
  • Monitor environmental data, like temperature, humidity, wetness, CO2, dust, light, etc.;
  • Monitor networks, network protocols and network services;
  • Ability to write custom monitoring scripts using PowerShell, VBScript, Windows Command or SSH (Linux);
  • Multi-threaded monitoring engine.
Alert Notification features
  • Send out alert notifications upon failure and/or upon recovery;
  • Alert Types: E-mail, SMS, Pager, SNMP Traps, Network Notifications;
  • Global Address Book to store all alert recipients;
  • Templates for all notification types.
Alert Action features
  • Restart a service (or multiple services) upon failure;
  • Reboot a workstation or server upon failure;
  • Launch a Powershell script, VBScript, Executable or Windows Batchjob on failure;
Configuration
  • Configuration information is stored in an MS SQL Server Compact Database (.sdf) file. No installation of MS SQL is required;
  • Support for (auto)backup and restore of the configuration; Backup and restore are guided by a Wizard;
  • Access to the configuration is defined by Operator Roles, using Roles like: Full Admin, (Read-only) Operator, etc.;
  • API to modify the configuration; Powershell- and VBScript samples are included.
Maintenance schedules
  • Avoid servers to be considered as 'Failed' during maintenance hours. Notifications and actions will not occur during these schedules;
  • Maintenance periods can be configured globally or per check;
  • Maintenance periods can be scheduled as recurrent or only once;
  • Multiple maintenance schedules can be defined.
Dependencies
  • Avoid a flood of messages when - for instance - a router fails, by configuring dependencies;
  • Servers can depend on multiple servers; dependencies are transitive.
Reports
  • Features Standard Incident Reports and Availability Reports;
  • Use of 'Report Definition' files to customize reports;
  • Schedule creation and emailing Reports using the Task Scheduler;
  • Support for PDF, HTML, XML and CSV ('comma separated') format;
  • Use of Filters to include/exclude Checks;
  • Ability to migrate Data to MS SQL Server or MySQL database for optimal performance.
Graphs
  • Graphs are generated instantly, for single or multiple checks;
  • Select any timeframe;
  • Ability to save Graphs to various image formats and PDF.
  • Ability to migrate Data to MS SQL Server or MySQL database for optimal performance.
Logging
  • Network Monitor related information is written to the Application Log of the Event Viewer;
  • Support for Plain Text log files;
  • Support for MS SQL Server, MySQL and MS SQL Server Compact Database;
  • Support for Syslog Server.
Web Access
  • Comprehensive web interface, designed for mobile devices, tablets and PC's;
  • Integrates with Microsoft Web Server (IIS);
  • Mobile first, responsive design and can be viewed by any browser, on any (touchscreen) mobile device, tablet or PC, running iOS, Android or Windows;
  • Include/Exclude Folders;
  • Use Filters to filter on host, result, type, date/time, etc.;
  • Plot Graphs, select any timeframe.

1.3. Built-in Checks

ActiveXperts Network Monitor ships with powerful set of monitoring checks.

Virtualization checks:

  • VMware ESXi check - checks the ESXi host or one of its virtual machines. It monitors CPU usage, memory, network traffic, disk usage and more;
  • Citrix XenServer check - checks the Citrix XenServer host or one of its virtual machines. It monitors CPU usage, memory, network traffic, disk usage and more;
  • MS Hyper-V Server check - checks the Microsoft Hyper-V Server host or one of its virtual machines. It monitors CPU usage, memory, network traffic, disk usage and more;
  • Nimboxx VERDE check - checks the Nimboxx VERDE host or one of its gold images. It monitors CPU usage, memory, network traffic, disk usage and more;

IP-related checks:

  • DHCP check - checks the number of IP addresses in use by the DHCP server, or the number of IP addresses available. It can check if the DHCP server is working fine;
  • DNS Server check - checks various types of DNS server records by retrieving record values and comparing them against specified values;
  • FTP(s) check - checks the availability of an FTP(s) server. It can logon/logoff, change directory and check for file existence on the FTP(s) server. It can look for patterns in an FTP file;
  • HTTP/HTTPs check - checks the availability of a website by connecting to it and matching patterns on the site; includes support for proxy servers;
  • IMAP Mail Server check - checks the availability of an IMAP compliant e-mail server;
  • LDAP check - performs an LDAP query and analyzes the result;
  • NNTP News Server check - checks the availability of an NNTP News server, using the NNTP Internet protocol;
  • NTP Time Server check - checks the availability of a Time Server by sending an NTP query and analyzing the response;
  • Ping/ICMP check - checks the availability of an IP device or computer;
  • Ping/TCP check - checks the availability of an IP device or computer by checking a TCP port;
  • POP3 Mail Server check - checks the availability of a PO3 e-mail server;
  • RADIUS Server check - checks the availability of a RADIUS authentication server;
  • SFTP check - checks the availability of an SFTP server. It can logon/logoff, change directory and check for file existence on the SFTP server. It can look for patterns in an SFTP file;
  • SMPP check - checks the availability of an SMPP (Short Message Peer-to-Peer) server. Bind to the server using a system ID and password;
  • SMTP Mail Server check - checks the availability of an SMTP mail server;
  • SMTP to POP3 check - checks if e-mail service is working properly by sending a test e-mail through an SMTP server and verifying that it has been delivered to the recipient's mailbox;
  • SNMP GET check - queries a computer or device using the SNMP ("Simple Network Management Protocol") protocol, and analyzes the result;
  • SNMP Trap Receive check - receives SNMP traps from various machines/devices, and analyzes the message;
  • TCP/IP check - checks if a connection can be established on a particular TCP port;
  • TFTP check - checks for file existence on the TFTP server. It can look for patterns in a TFTP file;
  • TraceRoute check - checks for the path packets take from one IP address to another.

Windows checks:

  • Anti-Virus/Internet Security check - checks status and version of Anti-Virus/Internet-Security software on a workstation or server;
  • Certificate check - checks the expiration date of a Windows Certificate;
  • Citrix/ICA check - checks the availability of a Citrix server;
  • Citrix/XenApp check - checks the availability of a Citrix XenApp server;
  • CPU usage check - monitors CPU usage of processor(s) on a Windows platform. If the load reaches a certain level (for instance: 80%), an alert is generated;
  • Directory check - monitors a directory, for instance a user's Home Directory or a common Department Folder;
  • Disk Drives check - monitors all physical disk drives on a workstation or server running a Windows Operating System;
  • Disk Space check - checks the disk space; an alert is fired when a minimum (or maximum) is exceeded;
  • Event Log check - checks for certain events in the Windows Event Log;
  • File check - checks if a file exists on a server. It can also check the size of the file and look for specific patterns in the file;
  • Memory check - monitors various memory counters of a Windows machine;
  • MS Active Directory check - monitors the status of an MS Active Directory Domain Controller;
  • Microsoft Message Queue (MSMQ) check - monitors a Microsoft Message Queue;
  • MS Terminal Server check - monitors the availability of an MS Terminal Server; it monitors active sessions, inactive sessions and total number of sessions;
  • Network Traffic check - monitors the available network bandwidth and network data traffic of a Windows machine;
  • Performance Counters check - monitors one or more performance counters of a Windows machine;
  • PowerShell custom check - define your own custom PowerShell checks. It should return True for success or False for an error;
  • Printer check - checks a printer for availability by checking status information;
  • Process check - checks a process to see if it is running. It can check the memory usage of a process, and count the number of identical processes running. It can also check for any process consuming too much memory;
  • Removable Drives check - checks if there are unwanted removable drives inserted on domain computers;
  • Registry check - checks the registry for a change, or matches a registry key against a predefined value;
  • Scheduled Task check - checks if a scheduled task has completed successfully or not;
  • Service check - checks if a service is running on a server;
  • User/groups check - checks groups and group membership;
  • VBScript custom check - define your own custom VBScript checks. It should return True for success or False for an error;
  • User/groups check - checks groups and group membership;
  • Windows Defender check - monitors the status of a Windows Defender server; it monitors the Windows Defender services, processes and relevant performance counters.
  • Windows Update check - monitors the Windows Update status of a Windows machine; it monitors critical updates, security updates and more.

Windows Server related checks:

  • MS Active Directory check - monitors an Active Directory domain controller in a Windows domain;
  • MS BizTalk check - monitors the status of an MS BizTalk server; it monitors the BizTalk services, processes and relevant performance counters;
  • MS Dynamics NAV/AX/CRM/GPSL/ check - monitors the status of an MS Dynamics server. This can be MS Dynamics NAV, MS Dynamics AX, MS Dynamics CRM and MS Dynamics GP/SL. It monitors the Dynamics services, processes and relevant performance counters;
  • MS Exchange Server check - monitors the status of an MS Exchange server; it monitors the Exchange services, processes and relevant performance counters;
  • MS Forefront check - monitors the status of an MS Forefront server; it monitors the Forefront services, processes and relevant performance counters;
  • MS IIS Server check - monitors the status of an MS Internet Information server; it monitors the IIS services, processes and relevant performance counters;
  • MS Index Server check - monitors the status of an MS Index server; it monitors the MS Index services, processes and relevant performance counters;
  • MS ISA Server check - monitors the status of the caching component and/or firewall component of an ISA Server;
  • MS SharePoint Server check - monitors the status of an MS SharePoint server; it monitors the SharePoint services, processes and relevant performance counters;
  • MS SQL Server check - monitors the status of an MS SQL server; it monitors the MS SQL services, processes and relevant performance counters;

Environmental checks:

ActiveXperts supports a wide range of environmental devices. This allows you to monitor any environmental sensor, including:

  • Temperature
  • Humidity
  • Wetness
  • Dew Point
  • Heat Index
  • Power
  • Resistance
  • Light
  • Motion
  • Smoke
  • Door
  • Vibration
  • Carbon Oxide
  • Caron Dioxide

Database checks:

  • Database Query check - ActiveXperts Network Monitor uses OLE DB (also known as ADO) to check availability of any OLE DB complaint database, including Microsoft SQL, MySQL, SQLite, MS Access, Oracle, Paradox and more. You can enter a database query and check the result of the query to determine the result of the check;
  • ODBC Database check - checks the availability of a database. Most major database systems support ODBC;
  • Oracle Database check - checks for availability of Oracle database by through the SQLNET interface.

Linux/Unix checks:

  • SSH check - checks a Linux/ Unix server by executing remote shell scripts (secure) and processing StdErr and/or StdOut;
  • RSH check - checks a Linux/ Unix server by executing remote shell scripts (unsecure) and processing StdErr and/or StdOut;

Miscellaneous checks:

  • Serial Device check - checks a device connected via a serial COM port.

Add new functionality to the product by writing your own VBScript or PowerShell routines. This way, you can monitor almost every piece of hardware, network protocol, software, and so on. Also, VBScript allows you to include techniques like WMI (Windows Management Interface) and ADSI (Active Directory Service Interfaces).

1.4. Custom Checks

ActiveXperts Network Monitor allows you to extend the set of built-in check routines by writing your own check routines.
ActiveXperts supports PowerShell (Windows), VBScript (Windows), (Remote) Command (Windows) and SSH (Linux/Unix) for custom scripting.

PowerShell and VBScript are defacto standards for scripting in Windows. Both are popular because of its wide acceptance and its support for ActiveX technologies. PowerShell has full support for .NET frameworks. ActiveXperts ships with a large collection of PowerShell scripts, VBScript and Windows Batch scripts. You can use these script directly, or make modifications to it to meet your requirements.

SSH is a defacto secure standard for remote shell execution. RSH is the less-popular, non-secure equivalent. ActiveXperts ships with a large collection of SSH shell scripts. You can use these script directly, or make modifications to it to meet your requirements.

1.5. Warnings, Failures and Recovery

A Monitoring Check has a Status, which is the result of the check. These are the possible Status values:

  • OK
  • Warning
  • Failure
  • Maintenance
  • Failure by Depender
  • On Hold
  • Not Monitored
  • Uncertain
'OK' Status

The check meets all the conditions. The corresponding computer/device is working fine.

'Warning' Status

If a check doesn't meet the conditions as configured, the check does not fail immediately. Instead, it gets a 'Warning' status first. After a few 'Warnings' in a row (configurable), the status changes to 'Failure'.
Think of an ICMP check for server 'www.activexperts.com'. Sometimes, the ping will fail (for instance once a week), because a router on the Internet has a hick-up. No immediate action is required. Only after a few problems in a row, action is required. So, the check is in the 'Warning' status first, but after a few a problems in a row (configurable), it's considered as a 'Failure'.

'Failure' Status

A 'Failure' is the occurrence of one or more problems in a row. The first problem is a 'Warning'. The number of allowed Warnings (let's say x, the so called threshold) is configurable. After x Warnings in a row, the check fails. On 'Failure', alarm notifications are sent out and action scripts are triggered.
For instance, with an 'ICMP Ping' check that has the threshold set to 5, a failure notification will be sent after 5 consecutive failing pings.

'Maintenance' Status

If the result of a check is not successful during a Maintenance period, it won't be considered as a regular 'Warning' or 'Failure'. Instead, the status will be: 'Maintenance'. This indicates that the negative result is caused by maintenance on servers, devices or network. No notifications will be sent and no actions will be triggered.

'Failure by Depender' Status

If a check fails as a result of another failed server, and there is a dependency relation between these checks, it is not be reported as a normal failure. In this case, no notifications are sent and no actions are triggered. It is called a 'Failure by Depender'.
Imagine you have a server 'S1' on a remote location, and there's router 'R' connecting your LAN with the remote location, and you have ICMP checks for both 'S1' and 'R'. By making 'S1' dependent of 'R', a failure of 'R' will only result in notifications for 'R', not for 'S'. Dependencies can be configured from the Dependency command in the Tools menu.

'On Hold' Status

You can put a check 'On Hold'. This means, that the check will not be monitored as long as the check remains 'On Hold'.

'Not Monitored' Status

If a check cannot be processed by the engine, the status is set to 'Not Monitored'. Think of a monitoring check based on the SNMP check, but the Network Monitor Engine doesn't have the SNMP service installed. It cannot process the check and will set the result to 'Not Monitored'.

'Uncertain' Status

If the result of a check cannot be determined by the Engine, the status is set to 'Uncertain'. Think of a Disk Space monitoring check, monitoring free disk space on a file server. If the file server becomes totally unavailable, the Network Monitor Engine cannot determine the Disk Space. In this situation, the result is set to 'Uncertain'.

Note: You can change the way Network Monitor handles 'Uncertain' events. By default, all checks which results cannot be determined are set to 'Uncertain'. You can configure not to use the 'Uncertain' status, and set each undetermined result to either 'Success' or 'Failure'.

About Recovery

If a server changes from 'Failure' into 'Success' status, it is 'recovered'. 'Recovered' itself is not a status; however, on such status change, Notifications can be sent out and Actions can be triggered. This can be useful for Administrators and Operators, so they know that their Action was successful.

2. Installing Network Monitor

2.1. Software Components

The central monitoring service runs on a (dedicated) Windows Server (or Workstation) platform, 64-bit or 32-bit; it monitors computers/devices in your LAN, WAN or even outside your enterprise. No additional software is required on the monitored servers.

The graphical 'ActiveXperts Network Monitor Manager' application is running on the operators desktop PC; it connects to the central monitoring service, and allows you to make changes to the configurations, and view the results.

ActiveXperts Network Monitor Engine service

The 'ActiveXperts Network Monitor Engine service' is a Windows Service (AxNmSvc.exe), and is the actual monitoring program. It runs in the background without desktop interaction. It monitors the computers/devices in your LAN/WAN for availability at specific time intervals. This service is multi-threading, allowing the service to monitor many computers/devices simultaneously.

The service is responsible for notification, actions, recovery, logging, and so on.

Note: ActiveXperts Network Monitor doesn't require agent software on the servers you monitor; the service only uses protocols and application layers of the Operating System to do its job.

ActiveXperts Network Monitor Manager

The 'ActiveXperts Network Monitor Manager' application (AxsNmApp.exe) is used to view the status of your network and to make changes to the configuration. You can install the Manager application on any workstation/server in your LAN/WAN.

The Manager application can be installed on any Windows 7 or higher workstation, or any Windows 2008 or higher server.

ActiveXperts Report Generator

The 'ActiveXperts Network Monitor Report Generator' is used to create new reports. There are two versions: a graphical version (AxRgGui.exe) to create reports using a wizard, and a command line version (AxRgCmd.exe) to create reports from the command line or from the Task Scheduler.

Reports are based on a Report Definition file (.rep), which describes the properties of a report (like: filters, sorting, layout, output file and more).

ActiveXperts Graph

The 'ActiveXperts Network Monitor Graph' program (AxGraph.exe) is used to create statistical graphs.

ActiveXperts Reports and Graphs Configuration Tool

The ActiveXperts Reports and Graphs Configuration Tool (AxRgTpl.exe) is used to manage Reports and Graphs.

ActiveXperts Web Access

ActiveXperts Web Access is a comprehensive web interface, designed for mobile devices, tablets and PC's. It allows users you to see those parts of the Network Monitor configuration that they have access to.

ActiveXperts Web Access Configuration Tool

The ActiveXperts Network Monitor Web Access Configuration Tool (AxWebCfg.exe) is used to configure ActiveXperts Web Access.

Installation Files

The full ActiveXperts Network Monitor installation package is available from the ActiveXperts Download Site. There are two setup files: AxMonitorSetup64.exe (for 64-bit operating systems) and AxMonitorSetup32.exe (for 32-bit operating systems).

After you download the file from the Internet, you start the setup procedure on the server that you assigned as the monitoring server. This server doesn't have to be a dedicated server. The installation will install the monitoring service, the Manager application and several tools and utilities.

2.2. Install Network Monitor

Hardware requirements

The ActiveXperts Network Monitor Engine service only runs on a Windows workstation or server platform, with the following recommended specifications:

  CPU Memory SP Disk Space
Windows Server 2022 1.4GHz (x64)
Multi-core
4GB - 20GB
Windows Server 2019 1.4GHz (x64)
Multi-core
4GB - 20GB
Windows Server 2016 1.4GHz (x64)
Multi-core
4GB - 20GB
Windows Server 2012 R2 1.4GHz (x64)
Multi-core
4GB - 20GB
Windows Server 2012 1.4GHz (x64)
Multi-core
4GB - 20GB
Windows Server 2008 R2 1.4GHz (x64)
Multi-core
4GB - 20GB
Windows Server 2008 1.4GHz (x64) / 1GHz (x86)
Multi-core
4GB - 20GB
Windows 11 1GHz x64
Multi-core
4GB - 20GB
Windows 10 1GHz (x64/x86)
Multi-core
4GB (x64/x86) - 20GB
Windows 8 1GHz (x64/x86)
Multi-core
4GB (x64/x86) - 20GB
Windows 7 1GHz (x64/x86)
Multi-core
2GB (x64/x86) SP1/higher 20GB

It's recommended to use a server platform for the ActiveXperts Network Monitor Engine service, because server platforms support more simultaneous network connections Server platforms are optimized for application services.

Usually, the installation is done only once, on the server that is dedicated as the monitoring server. A wizard will take you through the installation.

Installing ActiveXperts Network Monitor

Before you start the installation, you must assign one of your Windows servers in your network as the ActiveXperts Network Monitor Server. This machine will host the Network Monitor Engine (service).

Download the installation file (AxMonitorSetup64.exe or AxMonitorSetup32.exe) from the Internet and run this program on the server that you assigned as the monitor server.

Installation - Step-by-Step

Step 1 - Welcome Message

This is where the installation begins.

Step 2 - Setup Type

Choose "Network monitor Engine + Management Console" if you want to install the Network Monitor service. The first installation should always be this type of installation. After the first installation, you can run a "Management Console" installation on network workstations to allow users to view the monitoring results of Network Monitor, or to make changes to the configuration.

Step 3 - Licensing information

Here, you can enter you License code. If you enter 'FREE' as the license code, you will be able to use the software for free with a limited number of checks.

Step 4 - Choose Destination Folder

Choose a destination folder. Setup will copy the service, the Manager application, the Manager Setup files and other components to this location. Please make sure to have approximately 50 megabytes available.

Step 5 - Select Program Folder

Specify a name for the Program folder.

Step 6 - Service Account

The 'ActiveXperts Network Monitor Engine service' (the Engine) must be configured to run under a Windows account. This can be the built-in System user, but it is recommended to provide a Domain Admin or Enterprise Admin account, because it is likely that ActiveXperts Network Monitor needs access to servers in the domain with administrative rights to do its job. However, it's not mandatory to provide a Domain/Enterprise Admin account; for every monitoring check, alternate credentials can be provided.

2.3. Install Console Only

About Installing the Console Only

You can use the Management Console (the 'ActiveXperts Network Monitor Manager') on any workstation in your domain. Use this ActiveXperts Network Monitor Manager application to:

  • Manage the configuration;
  • View the monitoring results;
  • Run Reports and Graphs.

The Manager application is already installed by default on the server where the ActiveXperts Network Monitor Engine service runs. So, there's no need to run ActiveXperts Network Monitor Manager installation on the server.

By default, installing ActiveXperts Network Monitor Manager applications on remote computers is prevented for security reasons. To allow the installation of the Manager application on other computer, a share must be created. This share will be used by the remote Manager application to communicate with the Network Monitor Engine.

To define the Share, use the 'ActiveXperts Network Monitor Manager' application and do the following:

  • Choose Options from the Tools menu, and select the Remote Manager tab;
  • A Wizard appears, which will guide you through the steps of creating the Share.

Once you have created the share, you're ready to install the ActiveXperts Network Monitor Manager on remote PC's.

Simply run the AxMonitorSetup64.exe or AxMonitorSetup32.exe setup program (same installation as used for the server installation) on the workstation, and choose 'Install Management Console only'. The Setup program will now prompt for a share. Enter the share (UNC format) of the central ActiveXperts Network Monitor directory.

To be able to run the Network Monitor Manager application on workstations, Users (operators) need Change (RWX) permissions on the files in the shared directory.

To allow/prevent users in the network from installing/running the Network Monitor Manager, simply use NTFS permissions or Share Permissions. The easiest is to use Share Permissions: simply add/remove RWX permissions to allow/prevent Users or Groups at Share level.

Installation Step-by-Step

Step 1 - Welcome Message

This is where the installation begins.

Step 2 - Setup Type

Choose 'Install Management Console only'. It will install the Network Monitor Manager, the Report Generator and utilities on the workstation PC.

Step 3 - Location of the central Network Monitor server

You're prompted for the location of the central Network Monitor Server share. Enter the share, as discussed in the previous topic.

Step 4 - Choose Destination Folder

Choose a destination folder. Setup will copy all program files to this location. Please be sure to have approximately 5MB available, depending on the type of installation.

Step 5 - Select Program Folder

Specify a name for the Program folder.

Note: If the central monitoring server runs a 64-bit edition of ActiveXperts Network Monitor, it is possible to install the 32-bit edition of the ActiveXperts Network Monitor on the Management console and connect to the 64-bit server.

2.4. Upgrade from previous version

Upgrading ActiveXperts Network Monitor from a previous version

Upgrade of ActiveXperts Network Monitor requires un-installation first, followed by a new installation of the software. All configuration files will be preserved during un-installation. However, it is recommended to export the configuration to a save place, before you uninstall the product.

For instructions, please see: FAQ item #Q6500005.

3. Configuring Network Monitor

3.1. Introduction

Use the ActiveXperts Network Monitor Manager application to make configuration changes, to view real-time monitoring information, and to analyze results. The Manager application can be launched from any 64-bit or 32-bit Windows platform, or from the machine where the service is running on.

To make changes to the configuration from a script, use the Configuration API. There are many VBScript and Powershell included with the product.

The 'ActiveXperts Network Monitor Engine service' reloads its configuration every time the configration is modified.

The ActiveXperts Network Monitor configuration can be imported, exported and cleared at any time. By using the Backup command, the configuration can be backed up to a save location. By using Restore command, a configuration can be loaded and set as the current configuration. By using the Clear command, you can clear your current configuration and start from scratch. None of the above commands need a restart of the ActiveXperts Network Monitor Engine service.

Note: The Config.sdf configuration file is an MS SQL Server Compact database.
You can open this file using either Microsoft SQL Server Management Studio (ships with Microsoft SQL Server 2008 and higher), or using Microsoft Visual Studio 2010 or higher.

3.2. Configuration File

The ActiveXperts Network Monitor configuration consists of checks and global settings, and is stored in an Microsoft SQL Server Compact Database named Config.sdf. In a default installation, it is located in folder:
C:\ProgramData\ActiveXperts\Network Monitor\Configuration\

Use the ActiveXperts Network Monitor Manager application to make configuration changes, to view real-time monitoring information, and to analyze results. The Manager application can be launched from any 64-bit or 32-bit Windows platform, or from the machine where the service is running on.

You don't need to restart the 'ActiveXperts Network Monitor Engine service' every time you make changes to the configuration. The service will detect configuration changes as they are made, and will reload the configuration.

The ActiveXperts Network Monitor configuration can be imported, exported and cleared at any time. By using the Backup command, the configuration can be backed up to a save location. By using Restore command, a configuration can be loaded and set as the current configuration. By using the Clear command, you can clear your current configuration and start from scratch. None of the above commands need a restart of the ActiveXperts Network Monitor Engine service.

Note: The Config.sdf configuration file is an MS SQL Server Compact database.
You can open this file using either Microsoft SQL Server Management Studio (ships with Microsoft SQL Server 2008 and higher), or using Microsoft Visual Studio 2010 or higher.

3.3. Configure using Manager

To launch the 'ActiveXperts Network Monitor Manager', click Start, point to the ActiveXperts Software folder, point to the Network Monitor folder and click on the Network Monitor Manager icon.

Views

The 'ActiveXperts Network Monitor Manager' application window is divided into three views:

  • Folder View (left view) - Checks can be grouped in logical containers called Folders;
  • Checks View (right view) - list of checks that are organized in the selected folder. The checks in the subfolder(s) of the selected folder are also displayed;
  • Activity View (bottom view) - shows the activity of the 'ActiveXperts Network Monitor Engine service'.
Permissions

You can assign permissions to users by the use of Operator Roles.

Status Information and Icons

In the server view, an icon precedes every server entry. Here's a list of all possible status values (with corresponding icons) and their meanings:

  • OK
  • Warning
  • Failure
  • Maintenance
  • Failure by Depender
  • On Hold
  • Not Monitored
  • Uncertain

For an explanation, see Warnings, Failures and Recovery.

3.4. Configure using Configuration API

The configuration API enables administrators to read and modify configuration settings programmatically. Use the API to script or automate tasks that need to be performed frequently or in large batches, such as creating new checks, modifying checks, or requesting the engine to immediate monitor a server.

There are samples included for Powershell and VBScript. To read more about the Configuration API, click here.

3.5. Folders

In ActiveXperts Network Monitor, all checks are organized in folders. Folders are used to organize/group checks.

Add new Folder

To add a new folder:

  • From the Monitor menu, choose New Folder;
  • In the Name field, type the name of the new folder.
Rename Folder

To rename a folder:

  • Select the Folder you want to rename;
  • Choose Properties from the Monitor menu;
  • Type a new name for the folder.
Delete Folder

To delete a folder:

  • Select the Folder you want to delete;
  • Choose Delete from the Monitor menu. When you delete a folder, all check routines and sub-folders in the folder tree will also be deleted.

3.6. Checks

To add a new monitoring check, click New Monitoring Check on the toolbar. To configure an existing monitoring check, double click on the particular check entry in the Manager application, or right-click on the selected check and choose 'Properties'.

Most important configuration items of a Monitoring Check are:

  • Check What - the type of check that is performed on a specific network device, server or workstation;
  • Display Name - the name of the check to be displayed by the Manager application. The display name is also used in log files and reports to refer to this Monitoring Check. The display name can be any user friendly name.
  • Check every / Schedule this Check - specifies how frequent a check will be scanned. You can set it to scan it at a specific date and time, or to scan it frequently with a specific interval.
  • Check fails after x warnings in a row - specifies the number of consecutive problems that should occur before a check fails. This option only applies to a check that is not scheduled.

The configuration of checks is discussed in detail in Chapter: Managing Checks.

3.7. Options

Options are global properties, used by all Checks. You can configure these options from the Tools menu, by selecting the Options item.

Logging

See topic: Application Logging

Scan Defaults

'Scan Defaults' apply to new Monitoring Checks. Default values can be defined in the Options dialog:

  • On the Tools menu, click Options;
  • Select the Scan Defaults tab.

The following default values can be configured per check-type:

  • Check every x seconds/minutes/hours/days - specifies the Check frequency; Initial default value: once every 30 seconds;
  • Check fails after x warnings in a row (warning threshold) - specifies the number of consecutive problems that should occur before a new monitoring check will fail.

Scan Default values only apply to new checks; they do not affect existing monitoring checks. However, you can apply the default values to all monitoring checks by pressing the Copy/Paste Special from the Edit menu.

Credentials - Windows

The ActiveXperts Network Monitor Engine Service Account credentials are used to monitor remote Windows servers and workstations. However, you may need other credentials to monitor computers outside a domain. See topic: Credentials - Windows".

Credentials - Other

Credentials for Linux, SSH, VMware and other platforms are stored globally for each server. See topic: Credentials - Other.

Performance

See topic: Configuring Threads.

Maintenance

To avoid notifications and actions during maintenance hours, you can configure maintenance schedules. All failures that happen during these schedules won't be notified, and no actions will be triggered.

The maintenance schedules can be configured as Every Day of the Week, or as On This Date.

To configure maintenance schedules:

  • On the Tools menu, click Options and select the Maintenance tab; here, you see the list of configured schedules. You can define multiple schedules;
  • To add a new schedule, choose either Day of Week or This Date.
  • In case of 'This Date', provide start date and time, and provide the number of hours the computer and devices will be unavailable;
  • In case of 'Day of Week', provide the days of the week that the computers and devices will be unavailable; also provide a start time, and provide the number of hours the servers will be unavailable.
  • Press the Add button to add the new schedule to the Maintenance Schedules list.

By default, the maintenance schedules are inherited by all Monitoring Checks; however, you can configure maintenance schedules for each check individually in the 'Advanced' tab of the Monitoring Check properties. Let's say a company has maintenance on every Friday at 11:00 pm for nearly all servers (use the global maintenance schedules for that). But for one server (server 'A'), maintenance is scheduled on Saturday at 09:00 am. Configure individual maintenance schedules for server 'A'.

Auto Backup

The 'ActiveXperts Network Monitor Engine service' can make a regular backup for you, to a save location. It is recommended to choose a destination folder for your backup that is part of your regular backup procedure.

All program data is located in the programs data folder. In a default installation, it is located in folder:
C:\ProgramData\ActiveXperts\Network Monitor\

With Auto-Backup, you can specify which items to backup automatically to a safe location.

Configure the following items for your Backup Location and Schedule:

  • Destination Folder - Folder that will store your backup files.
  • Backup Every - Configure the days and time when the Backup should run.

Configure What to Backup

  • Configuration File - Backup the Config.sdf configuration file;
  • Log Files - Backup the Logs\Log.txt and/or Logs\Log.sdf application log file(s);
  • Statistical Database - Backup the Stats\Stats.sdf Statistical Database. The option is disabled in case you migrated your Statistical Database to MS SQL Server or MySQL server.
  • Scripts - Backup the (custom) scripts in the Scripts folder;
  • Report Definition Files - Backup the Report Definition Files and associates XSL stylesheets in the Report Definitions folder;
  • WebView - Backup the WebView files in the Web folder;
Operators and Roles

See topic: Operators and Roles".

Date and Time

Network Monitor does not use Windows' Date/Time settings for displaying information, because results can be viewed by non-Windows users (Web interface, reports, etc.). Therefore, you can set Date/Time settings; these settings are stored in the configuration database, and will be used by all Manager applications, Web Views, Reports, etc..

To configure Date/Time settings:

  • On the Tools menu, click Options and select the Date and Time tab;
  • Select your preferred Time format and Date format.

3.8. Backup, Restore Configuration

Restore configuration settings

To import a previously saved configuration, use the Restore function. Note that the current configuration will be overwritten.

To import a configuration:

  • On the File menu, choose Restore Configuration;
  • Select the version of the import configuration file, and click Next;
  • In the File name box, enter a name of a previously exported configuration file;
  • Click Finish to finish the import.

Note: It is possible to Restore a configuration file that was created on another computer.

Backup configuration settings

It's a good practice to make a backup after major configuration changes. The 'Backup Configuration' function exports all of the configuration settings. This means: all global configuration settings (like mail server, default scan time, etc.) as well as all monitoring checks.

To backup a configuration:

  • On the File menu, choose Backup Configuration;
  • In the File name box, enter a name for the new configuration file;
  • Click Save.

Note: The Auto Backup feature automatically backups the configuration periodically. Auto Backup can be configured from the Auto Backup tab of the Options dialog.

New configuration

The New Configuration function clears the existing configuration and creates a new one. The 'ActiveXperts Network Monitor Manager' will ask you to save the current configuration before you clear it.

To create a new configuration:

  • On the File menu, click New Configuration;
  • The program will ask if you want to export the current configuration;
  • After the optional export, it asks you if you're sure to create a new configuration. Press Yes.

3.9. Configuration Maintenance

Configuration Database Maintenance

The ActiveXperts Network Monitor Engine (service) has a configuration database maintenance job that is performed at the following times:

  • After the ActiveXperts Network Monitor Engine service is started;
  • Once every hour

During the configuration database maintenance job, there are messages displayed in the Real-Time Activity View (View: 'Activity-System') like:

  • SYSTEM INFO: Configuration Database Maintenance started
  • SYSTEM INFO: Configuration Database Maintenance completed

The following actions are performed:

  • Orphan Checks are deleted. Orphan Checks are Checks that are not listed in the Tree Configuration. To see the Tree configuration, run Configuration API script ShowTree.ps1 or ShowTree.vbs;
  • Non-existing Tree nodes are deleted. If the tree contains ID's that do not have a Check configured, the ID is deleted from the tree. Run ShowCheck.ps1 or ShowCheck.vbs to see if a Check is configured;
  • Dependencies are fixed for IDs that do not exist anymore.

You can force a Configuration Database Maintenance operation using the Configuration API:

CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\PowerShell\Server Commands\"
Powershell .\ForceConfigDbMaintenance.ps1

or

CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\VBScript\Server Commands\"
CSCRIPT ForceConfigDbMaintenance.vbs

The Engine will then perform a Maintenance operation a few moments later.

4. Managing Checks

4.1. Adding a New Check

To add a new built-in Monitoring Check:

  • On the Monitoring menu, click Create New Check;
  • In the Check What drop-down box, select the type of check. In the next chapter, Monitoring Checks are described in more detail;
  • In the Display Name box, edit a custom display name; this name will also be used in the log files and reports;
  • In the Check every field, specify how often a check should run. By default, a check will be monitored once every 30 seconds. This default can be changed from the Options dialog in the Tools Menu. To use a scheduled check instead of running it at specific intervals, use the 'Schedule this Check' option (see below) instead of the 'Check every' option;
  • In the Check fails after field, specify the number of consecutive problems that should occur before a check fails;
  • In the Schedule this Check fields, you can define at what times the check should run.

Almost all built-in Checks have a scripted equivalent in both Powershell, VBScript and Windows Script. Using scripted Check, you can customize a Check by modifying the script.

To add a new scripted Monitoring Check:

  • On the Monitoring menu, click Create New Check (Script), and select the script-type you prefer;
  • In the Windows that pops-up, select a script file and optionally a function, and make sure you type in the required parameters. Most scripted checks have the option 'Click here to load a working sample'. That will fill in sample parameters.

The creation of Checks can be automized programmatically by using the Configuration API.

4.2. Copy/Paste a Check

To Copy an existing Monitoring Check:

  • On the Edit menu, click Copy.

To Paste a Monitoring Check:

  • On the Edit menu, click Paste.

You can copy/paste multiple checks at the same time. There's the option to change the hostname (or IP addresses) during the Paste operation, so you can apply a set of pre-defined checks to a new server, or even multiple servers.

NOTE: Copy/Paste is a powerful command in ActiveXperts Network Monitor. You can define checks for a new server in just a single operation, due to the ability to change the hostname (or IP address) during Paste. You can even Paste to a list of new hosts!

4.3. Copy/Paste Properties

To copy the properties of an existing Monitoring Check:

  • On the Edit menu, click Copy.

To paste properties:

  • Select one or more checks to paste the properties to (or even select a Folder);
  • On the Edit menu, click Paste Properties.

You can apply the following properties to other checks:

  • Check Frequency Settings;
  • Alert Notification Settings;
  • Alert Action Settings;
  • Advanced Settings.

4.4. Deleting a Check

To delete an existing Monitoring Check:

  • On the Monitor menu, click Delete;

Confirm that you really want to remove the Check from the configuration.

4.5. Editing a Check

The Monitoring Check dialog will pop up. This dialog contains 4 tabs:

  • Check Properties;
  • Alert Notifications - E-mail, SMS, Pager, SNMP Trap and Network/NetBIOS alert notifications;
  • Alert Actions - Run batch file, exe-file or VBScript programs; restart service(s) or reboot server;
  • Advanced Properties - Configure Notification Frequency (re-notifications), Action Frequency (re-run programs), Maintenance hours and Dependencies.
Check Properties

Select the Check Properties tab, and configure the following fields:

  • Check What - select the type of check, for instance: ICMP;
  • In the Display Name box, edit a custom display name; this name will also be used in the log files and reports;
  • In the Check every field, specify how often a check should run. By default, a check will be monitored once every 30 seconds. This default can be changed from the Options dialog in the Tools Menu. To use a scheduled check instead of running it at specific intervals, use the 'Schedule this Check' option (see below) instead of the 'Check every' option;
  • In the Check fails after field, specify the number of consecutive problems that should occur before a check fails;
  • In the Schedule this Check fields, you can define at what times the check should run.
Notifications Properties

Select the Alert Notifications tab, and configure the following fields:

  • E-mail: Alert Notification (Failure) - If the check fails, send an e-mail notification to the selected recipients. The recipients are either defined in the global Address Book, or configured for this particular check only;
  • E-mail: Recovery Notification (Success) - If the check changes from 'Failure' to 'Success', send an e-mail notification to the selected recipients;
  • SMS: Alert Notification (Failure) - If the check fails, send an SMS notification to the selected recipients;
  • SMS: Recovery Notification (Success) - If computer /device turns from offline to online, send an SMS notification to the selected recipients;
  • Pager: Alert Notification (Failure)s - If the check fails, send an SMS notification to the selected recipients;
  • Pager: Recovery Notification (Success) - If computer /device turns from offline to online, send an SMS notification to the selected recipients;
  • SNMP Trap: Alert Notification (Failure) - If the check fails, send an SNMP Trap notification to the selected recipients;
  • SNMP Trap: Recovery Notification (Success) - If computer /device turns from offline to online, send an SNMP Trap notification to an SNMP network management system;
  • Network: Alert Notification (Failure) - If the check fails, send a network notification to the selected recipients;
  • Network: Recovery Notification (Success) - If computer /device turns from offline to online, send a network notification to the selected recipients.

For all of the above items (except SNMP Traps), you can select recipient groups from the global Address Book.

If you want to use different recipients (or traps) for a particular Monitoring Check, press the '.' button next to the corresponding item.

Actions Properties

You can define an action for each particular check. Actions are triggered when a check fails, or when a check recovers from a failure. There are no global settings for Actions; all settings are made in the properties of the monitoring check.

There are 3 different types of actions:

  • Restart service
    After a failure, it's possible to restart a service. For instance, if you can't reach an IIS web server in your LAN, it may be a good idea to restart the W3SVC service. You can use either the short service name (for instance W3SVC) or the long service name (for instance: World Wide Web Publishing Service). To restart multiple services, enter all services separated by a semicolon (';'), for instance: alerter;browser;
  • Reboot computer
    In some situations, it may be useful to reboot a machine to try to recover from a failure;
  • Run Program You can configure to run a program after a failure has occurred. ActiveXperts Network Monitor supports three different types of programs:

    • Executable files;
    • Batch programs;
    • PowerShell programs;
    • VBScript programs.

You can pass parameters to these programs on the command line. You can also use Notification Variables as parameters, as described in Appx E. Notification Variables.

To configure Alert Actions, select the Alert Actions tab, and configure the following fields:

  • Run Program (.exe, .cmd, .bat) on Failure - If server/device goes offline, run the specified Win32 executable or batch file on the ActiveXperts Network Monitor server;
  • Run Program (.exe, .cmd, .bat) on Recovery from Failure - If server/device turns from offline to online, run the specified Win32 executable or batch file on the ActiveXperts Network Monitor server;
  • Run Program (.vbs) on Failure - If server/device goes offline, run the specified Visual Basic script on the ActiveXperts Network Monitor server;
  • Run Program (.vbs) on Recovery from Failure - If server turns from offline to online, run the specified Visual Basic script on the ActiveXperts Network Monitor server.
  • Run Program (.ps1) on Failure - If server/device goes offline, run the specified PowerShell script on the ActiveXperts Network Monitor server;
  • Run Program (.ps1) on Recovery from Failure - If server turns from offline to online, run the specified PowerShell script on the ActiveXperts Network Monitor server.
  • No reboot/restart after failure - No reboot or restart of a service when failure occurs;
  • After failure, reboot computer - Upon failure, reboot a particular server;
  • After failure, restart service(s) - Upon failure, restart a service on a particular server. You can restart multiple services by providing a list of services. A list of services should contain individual services, separated by the ';' character.

To restart a service or reboot a computer, the 'ActiveXperts Network Monitor Engine service' credentials are used by default (i.e. the credentials used to start the ActiveXperts Network Monitor Engine service, see also the "Services" applet in the "Administrative Tools" folder). However, if a server is in a different domain or forest, and there is no trust, you may need to pass different credentials to restart or reboot.

To do so, press the Credentials button and select an entry from the Alternate Credentials list. Alternate credentials are administrated globally.

Advanced

Select the Advanced tab to configure the following items:

  • Maintenance Plan for this Check - Select your Maintenance Plan.
  • Graph - Enable or disable graphing for this check. By default, graphing is disabled for new checks to ensure maximum performance of the Statistical Database. When Graphing is enabled, you can specify how frequent the data should be written to the Statistical Database (default: once every 5 minutes);
  • Result of this Check - This option allows you to invert the result of a check, where Success will be turned into Failure and vica versa. This option also allows you to map Uncertain results into either Success or Failure;
  • Notification and Action Frequency - This only applies to Failed checks. By default, notifications are sent only once after failure. If you prefer repetitive notifications, select the Notify every radio button and enter the notification frequency. If you prefer repetitive actions, select the Trigger every radio button and enter the frequency;
  • Dependencies - Read-only view of the dependencies for this check;
  • Check ID - Each check has a unique ID. This ID is the key in the [Nodes] table of the configuration database (Config.sdf)

4.6. Monitoring servers in same domain

The ActiveXperts Network Monitor Engine runs as a service on a Windows 2019/2016/2012(R2)/2008(R2)/10/8/7 operating system. This service run with Local System credentials or with Local/Domain Administrator credentials.

To change the ActiveXperts Network Monitor Engine service credentials:

  • Open the Computer Management application that is part of the Operating System;
  • Click on the Services applet;
  • Select the ActiveXperts Network Monitor Engine service and click on the Log On tab;
  • Choose This Account and enter the Account and Password information.

To monitor servers in a domain, enter an account that has Administration privileges on all domain members. A 'Domain Administrator' or 'Enterprise Administrator' account will suffice. You can use the UNC notation for the domain account, i.e.: DOMAIN\Account. You can also use other dotted domain notations (mysubdomain.mydomain.dom\Account) or user principle names (j.doe@mydomain.dom).

4.7. Monitoring servers in other domains

To monitor servers in another domain, ActiveXperts Network Monitor requires administrator rights on that domain. This can be established through a trust relationship between these domains. However, if there is no trust relationship, the service account credentials cannot be used.

To monitor servers in another - untrusted - domain, you need to enter alternate credentials for each Windows server in the Server Credentials table (see Options). This also applies to stand-alone servers.

If the alternate credentials fail, ActiveXperts will NOT try the ActiveXperts Network Monitor Engine service credentials, unless you set the following registry value (you MUST restart the ActiveXperts Network Monitor Engine service in order for changes to take effect):

HKEY_LOCAL_MACHINE\Software\ActiveXperts\Network Monitor\Server\WinLoginFallbackToService: 1

5. Built-in Checks

5.1. Virtualization Checks

VMware ESXi check

ActiveXperts Network Monitor can monitor VMware ESXi servers to check various performance counters, including CPU, Memory, Network Trafic, Physical Status and more. Checks can be performed on the ESXi host itself, and/or on the Virtual Machines that it is hosting.

A VMware ESXi check requires the following parameters:

  • ESXi Host - The IP address or hostname of the VMware ESXi server that you want to check;
  • Username and Password - The Username and Password used to logon to the ESXi server. These credentials need to be defined once for each ESXi host and can be used for other checks defined for this ESXi server;
  • Monitor ESXi Host or Monitor Virtual Machine - Select either the entire ESXi host (running the Virtual Machines) or an individual Virtual Machine;
  • Check Counter - Select what to monitor: CPU Usage (%), Memory Usage (%), Memory Available (MB), Memory Used (MB), Network Packets Received (#), Network Packets Transmitted (#), Network Receiving Rate (Kbps), Disk Usage (%), Disk Space Available (MB), Disk Space Used (MB), Virtual Machine Powered On (y/n), Virtual Machine Running (y/n), Virtual Machine Guest Tools Installed (y/n);
  • Value - Minimum/Maximum value for the above Check Counter.
Citrix XenServer check

ActiveXperts Network Monitor can monitor Citrix XenServer servers to check various performance counters, including CPU, Memory, Network Trafic, Physical Status and more. Checks can be performed on the XenServer host itself, and/or on the Virtual Machines that it is hosting.

A Citrix XenServer check requires the following parameters:

  • XenServer Host - The IP address or hostname of the Citrix XenServer server that you want to check;
  • Username and Password - The Username and Password used to logon to the XenServer server. These credentials need to be defined once for each XenServer host and can be used for other checks defined for this XenServer server;
  • Monitor XenServer Host or Monitor Virtual Machine - Select either the entire XenServer host (running the Virtual Machines) or an individual Virtual Machine;
  • Check Counter - Select what to monitor: CPU Usage (%), Memory Usage (%), Memory Available (MB), Memory Used (MB), Network Packets Received (#), Network Packets Transmitted (#), Network Receiving Rate (Kbps), Disk Usage (%), Disk Space Available (MB), Disk Space Used (MB), Virtual Machine Powered On (y/n), Virtual Machine Running (y/n), Virtual Machine Guest Tools Installed (y/n);
  • Value - Minimum/Maximum value for the above Check Counter.
MS Hyper-V check

The Hyper-V Server check monitors services, processes and WMI counters related to Microsoft Hyper-V Server.

The Hyper-V Server check requires the following parameters:

  • Services - A list of Exchange services that should be running on the target computer;
  • Processes - A list of Exchange processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • WMI Performance Counters - A list of Exchange performance counters that should be monitored.
Nimboxx VERDE check

ActiveXperts Network Monitor can monitor Nimboxx VERDE servers to check various performance counters, including CPU, Memory, Network Trafic, Physical Status and more. Checks can be performed on the Nimboxx VERDE host itself, and/or on the gold images that it is hosting.

A Nimboxx VERDE check requires the following parameters:

  • Nimboxx VERDE Host - The IP address or hostname of the Nimboxx VERDE server that you want to check;
  • Username and Password - The Username and Password used to logon to the Nimboxx VERDE. These credentials need to be defined once for each Nimboxx VERDE host and can be used for other checks defined for this VERDE host;
  • Monitor VERDE Host or Monitor Gold Image - Select either the entire VERDE host (hosting the gold images) or an individual gold image;
  • Check Counter - Select what to monitor: CPU Usage (%), Efficiency (%), Memory Usage (%), Network Receiving Rate (Kbps), Network Transmitting Rate (Kbps), System Disk Usage (%), User Disk Usage (%), Image Published, Image Guest Tools Installed, Current Session Count, Maximum Session Count, Reserved Session Count;
  • Value - Minimum/Maximum value for the above Check Counter.

5.2. IP-based Checks

DHCP Server check

ActiveXperts Network Monitor can monitor DHCP servers to check IP addresses in use, IP addresses offered and IP addresses available. The DHCP server have SNMP v.1 or SNMP v.2 enabled to allow Network Monitor to retrieve the performance data.

A DHCP Server check requires the following parameters:

  • Host/IP - The IP address or hostname of the DHCP server that you want to check;
  • Maximum number of IP addresses in use - The maximum number of IP addreses in use;
  • Maximum number of IP addresses offerred - The maximum number of IP addreses offered;
  • Maximum number of IP addresses available - The maximum number of IP addreses available;
  • SNMP Community Name - The SNMP Community Name used to monitor the DHCP server. SNMP v.1 or SNMP v.2c are supported.
DNS Server check

ActiveXperts Network Monitor can resolve any DNS record and check the result against a specified value. Allowed record types include the 'A' record, 'MX' record' and 'CNAME' record'.

A DNS Server check requires the following parameters:

  • Host/IP - The IP address or hostname of the DNS server that you want to check;
  • Name - The DNS name to resolve;
  • Type - The DNS record type of the DNS record. Valid record type are: 'A Record', 'MX Record' 'CNAME Record' or 'Any Record';
  • IP address(es) - The expected IP number(s). If the query result does not include the given IP address, the check will fail. Otherwise, the check will succeed. Please note that a DNS query can return more than one IP address. In case the 'Type' was set to 'CNAME Record', the expected result is a host name, not an IP address.
FTP check

ActiveXperts Network Monitor can check the availability of an FTP site. You must pass credentials (username and password) to access the actual FTP site. If the FTP server allows anonymous access, specify 'anonymous' in the 'Account' field, and specify a valid e-mail address in the 'Password' field. With the FTP check, you can check for a file in one of the subdirectories on the FTP server, and even check for a specific pattern in the file.

An FTP check requires the following parameters:

  • Host - Hostname or IP address of the remote FTP server. If the remote FTP server is listing on a port other than 21, you can append it to the host, like this: 192.168.0.1:23
  • Passive - Specifies the way ActiveXperts Network Monitor establishes a connection with the FTP server: in Passive mode or in Active mode. Default: Passive.
  • FTP Account - Account used to access the FTP server. You cannot leave it blank. If the FTP server allows anonymous access, you must specify 'anonymous' in the 'Account field' and a valid e-mail address in the 'Password' field;
  • FTP Password - Password used to access the FTP server. If the FTP server allows anonymous access, you must specify 'anonymous' in the 'Account field' and a valid e-mail address in the 'Password' field;
  • Anonymous - If the FTP server allows anonymous access, you can click on this check box to enter credentials automatically in the 'Account' and 'Password' fields. The 'Anonymous' property is not used by the engine;
  • Check Connectivity only / Check File Existence - If you want to check availability only, you should select 'Check Connectivity' here. If you want to check for existence of a particular file, you must select 'Check File Existence';
  • Directory - If you check for file existence, you can specify a working directory where the file indicated by the 'File' field should be located. Leave it blank to use the root of the FTP site as the working directory;
  • File - The file you want to check;
  • Check file existence only / Check for a specific pattern in the file - You can check for file existence only, or for a specific pattern in the file;
  • Use binary file transfer - Indicates how the file should be transferred so it can be analyzed. Only possible if 'Check for a specific pattern in the file' is selected;
  • Pattern should (not) match - If the pattern is matched, then the result of the check can be either success or error.
HTTP/HTTPs check

ActiveXperts Network Monitor can check the availability of HTTP and HTTPs sites, on default ports (i.e.: 80 and 443) or on alternate ports. If the HTTP(s) server is not directly accessible, you can configure ActiveXperts Network Monitor to go through a Proxy server to access the particular HTTP(s) server, even passing credentials for that Proxy server (to be able to make use of the Proxy). Additionally, you can pass credentials (username and password) to access the actual HTTP(s) site if required. ActiveXperts Network Monitor supports web site content checking; contents of web sites can be searched for text patterns (including tags).

An HTTP/HTTPs check requires the following parameters:

  • URL - The location of the website in URL format (i.e. http://server[:port]/path/... format);
  • Require Server verification - A flag to indicate: HTTP or HTTPs;
  • Check for availability only / Page must contain pattern / Page must not contain pattern - In case of 'Check for Availability only', only the availability of the site is checked. In case of 'Page must (not) contain string', the content of the URL is checked for specific contents;
  • Time-out after - Time-out in seconds. If the time-out expires, the result is 'Error';
  • Use website authentication - A flag to indicate whether authentication is required for the web site or not. If authentication is required, 'Website Account' and 'Website Password' must be provided;
  • Website Account - A valid account on the web site;
  • Website Password - A valid password for the account on the web site;
  • Use a Proxy server - A flag indicating whether the web site should be accessed through a Proxy server or not;
  • Proxy - If the 'Use a Proxy server' field is set, this field indicates the actual Proxy server. A hostname, NetBIOS name or IP address is required here;
  • Proxy authentication - If the 'Use a Proxy server' flag is set, and the proxy server indicated by the 'Proxy' field requires authentication, enable this check box;
  • Proxy Account - A valid account on the Proxy server;
  • Proxy Password - A valid password for the account on the Proxy server.
IMAP Mail Server availability check

ActiveXperts Network Monitor can check IMAP mail servers by establishing a connection on the remote IMAP port (usually port 143) and do a handshake. By handshaking, ActiveXperts Network Monitor can verify that the remote server's IMAP protocol is working well.

An IMAP Mail Server check requires the following parameters:

  • Host - Hostname or IP address of the server to be monitored;
  • Port - TCP port number of the IMAP protocol. Default: 143;
  • Send command when connected - As soon as connection is established, send a command. By default, no command string will be sent;
  • Response must include string - when connected, optionally send a command. Then wait for the response. The default response for IMAP servers includes: 'IMAP';
  • Time-out - Number of milliseconds before the check will time-out. Usually, a connection to the server will be established within 1 second. However, some slow/busy servers need more time. Recommended value is 7000 milliseconds.
LDAP check

LDAP (Lightweight Directory Access Protocol) is a protocol for querying (and modifying) directory services like Microsoft Active Directory and Novell Netware.

The LDAP check requires just one parameter:

  • LDAP Server - Hostname or IP address of the server to monitor.

The check will by default try to retrieve the full name of the queried directory service, and match the result against a pattern. One may check want to use more sophisticated queries; for this reason, the check is a VBScript check to allow customization.

NNTP News Server check

ActiveXperts Network Monitor can check NNTP news servers by establishing a connection on the remote TCP port (usually port 119) and do a handshake. By handshaking, ActiveXperts Network Monitor can verify that the remote server's NNTP protocol is working well.

An NNTP News Server Availability check requires the following parameters:

  • Host - Hostname or IP address of the server to be monitored;
  • Port - TCP port number of the NNTP protocol. Default: 119;
  • Send command when connected - As soon as connection is established, send a command. By default, no command string will be sent;
  • Response must include string - When connected, optionally send a command. Then wait for a response. The default response for NNTP servers includes: '200';
  • Time-out - Number of milliseconds before the check will time-out. Usually, a connection to the server will be established within 1 second. However, some slow/busy servers need more time. Recommended value is 7000 milliseconds.
NTP Time Server check

Commercial organizations today rely on networks of computers, all of which have clocks that are the source of time for files or operations they handle. Most of these organizations use a time server to ensure accurate time settings. The NTP protocol is the protocol used to synchronize times between workstations and servers, and external time sources. ActiveXperts Network Monitor uses the IP based NTP protocol to check availability of internal and external time sources.

An NTP check requires one parameter:

  • Time Server - Hostname or IP address of the time server.
Ping/ICMP check

Ping/ICMP checks a remote host for availability using the ICMP protocol. Local hosts should normally respond to ping requests within milliseconds. However, on a very congested network it may take up to 3 seconds or longer to receive an echo packet from the remote host. If the time-out is set too low under these conditions, it will appear that the remote host is not reachable (which is almost the truth). ActiveXperts Network Monitor checks servers for availability by sending ICMP Echo commands and wait for the responds. An ICMP time-out failure doesn't necessarily mean that the remote host is actually functioning beyond its ability to echo packets.

An Ping/ICMP check requires the following parameters:

  • Host - The host name or IP address of the computer/device you want to ping;
  • Time-out after - Maximum number of milliseconds it should take before a response is received;
  • Number of retries - The number of retries to send when a ping fails;
  • Time to Live - Maximum Time to Live (TTL) value;
  • Buffer Size (bytes) - Send buffer size.
Ping/TCP check

Ping/TCP checks a remote host to make sure it is listening to a specific TCP port. It can send multiple TCP connect requests and calculates the average connect time. You can set Connect Time limit. If exceeded, the check will fail.

An Ping/TCP check requires the following parameters:

  • Host - The DNS host name or IP address of the computer/device you want to ping;
  • TCP Port - The TCP port it should connect to;
  • Maximum average Connect Time - Maximum average connect time (msecs) allowed;
  • Number of Connect Requests - The number of times it will connect to the remote host. If one connect fails, the check will fail. The average connect time will be calculated based on the number of connects;
  • Interval (between Requests) - Number of seconds between two connect attempts.
POP3 Mail Server check

ActiveXperts Network Monitor can check POP3 mail servers by establishing a connection on the remote TCP port (usually port 110) and logon to a mailbox on that mail server.

A POP3 check requires the following parameters:

  • Host - Hostname or IP address of the server to be monitored;
  • Port - TCP port number of the POP3 protocol. Default: 110;
  • Secure - If your SMTP server is a secure server, click this checkbox; this will prompt you for a username and password;
  • Mailbox Account - Account name of a POP3 mailbox;
  • Mailbox Password - Account password.
  • Allow a maximum number of Messages in the Mailbox - Only allow a limited number of messages in the mailbox. For instance, to check if a forward (with delete) works fine.
  • Maximum number of Messages in the Mailbox - the maximum number of messages allowed in the mailbox.
RADIUS check

ActiveXperts Network Monitor can check RADIUS (Remote Authentication Dial In User Service) servers by authenticate a user.

A RADIUS check requires the following parameters:

  • RADIUS Server - Hostname or IP address of the server to be monitored;
  • RADIUS UDP Port - UDP port number of the RADIUS protocol. Default: 1812;
  • Timeout - Number of milliseconds before the check will time-out;
  • User - User to authenticate against the RADIUS server;
  • Password - Password of the user;
  • Secret - RADIUS secret.
SFTP check

ActiveXperts Network Monitor can check the availability of an SFTP server. SFTP (Secure File Transfer Protocol) allows secure network file transfer over an insecure network, such as the Internet. The Secure File Transfer Protocol is an extension to the SSH version 2.0 protocol. Most SSH server implementations will also allow for SFTP logins. SFTP is the secure successor to FTP.

An SFTP check requires the following parameters:

  • SFTP Host - Hostname or IP address of the remote SFTP server;
  • Port - Port of the SFTP daemon on the remote SFTP host. Default: port 22;
  • Account - Account used to access the SFTP server;
  • Password - Password to authenticate to the SFTP server. If omitted, you must set a valid Private Key File;
  • Private Key File - Private Key File to authenticate to the SFTP server. If omitted, you must set a valid Password;
  • Accept Host Key - Specifies whether to accept an unknown or changed host key;
  • Check Connectivity only / Check File Existence - If you want to check availability only, you should select 'Check Connectivity' here. If you want to check for existence of a particular file, you must select 'Check File Existence';
  • File (Full Path) - The file you want to check;
  • Check file existence only / Check for a specific pattern in the file - You can check for file existence only, or for a specific pattern in the file;
  • Pattern should (not) match - If the pattern is matched, then the result of the check can be either success or error.
SMPP check

ActiveXperts Network Monitor can check the availability of an SMPP server. SMPP (Short Message Peer-to-Peer Protocol) is a telecommunications industry protocol for exchanging SMS messages between peer entities.

An SMPP check requires the following parameters:

  • Host - Hostname or IP address of the remote SMPP server;
  • Port - Port of the SMPP daemon on the remote host. Default: port 2775;
  • System ID - Account used to access the SMPP server;
  • Password - Password to authenticate to the SMPP server;
  • System Type - Use 'SMPP' unless otherwise specified by your provider.
SMTP Mail Server check

ActiveXperts Network Monitor can check SMTP mail servers by establishing a connection on the remote TCP port (usually port 25) and do a handshake. By handshaking, ActiveXperts Network Monitor can verify that the remote server's SMTP protocol is working well.

An SMTP Mail Server check requires the following parameters:

  • Host - Hostname or IP address of the server to be monitored;
  • Port - TCP port number of the SMTP protocol. Default: 25;
  • Secure Mail Server checkbox - If your SMTP server is a secure server, click this checkbox; this will prompt you for a username and password;
  • Authentication checkbox - If your SMTP server requires authentication, click this checkbox and provide a logon and password;
  • Send command when connected - As soon as connection is established, send a command. By default, no command string will be sent;
  • Response must include string - when connected, optionally send a command. Then wait for the response. The default response for SMTP servers includes: '250';
SMTP to POP3 check

This check verifies whether an e-mail service is working properly by sending a test e-mail message through an SMTP server and verifying that it has been delivered to the recipient's mailbox.

An SMTP to POP3 check requires the following parameters:

  • E-mail Recipient - E-mail address of the recipient to send the e-mail to;
  • Subject - Subject of the e-mail. Note that the ActiveXperts engine will add a unique ID to it, to mark the e-mail as an SMTP to POP3 test mail;
  • SMTP Server - select what SMTP server to use: the global primary SMTP server, the global secondary server, or another SMTP server;
  • POP3 Server - the hostname or IP address of the POP3 server;
  • POP3 Account - the account to authenticate to the POP3 server;
  • POP3 Password - the password to authenticate to the POP3 server;
  • Check E-mail every - check interval, in minutes;
  • Check fails if e-mail is not received within - e-mail delivery time-out value. If the e-mail is not delivered to the POP3 box within the specified time, the check will fail;
  • Delete the mail after delivery - Network Monitor can optionally delete the e-mail once is has been delivered.
SNMP GET check

SNMP means: Simple Network Management Protocol. The SNMP GET message allows the Network Monitor Engine to request information about a specific variable on a remote computer or device. The agent, upon receiving a GET message, will issue a GET-RESPONSE message to the Network Monitor Engine with either the information requested or an error indication as to why the request cannot be processed.

An SNMP GET check requires the following parameters:

  • Host - Hostname or IP address of the computer/device to monitor;
  • Port - UDP port used for SNMP on the target machine/device. Default port is 161;
  • Community - The SNMP community string; Default: 'public';
  • Protocol - Indicates how the SNMP client should communicate with the remote SNMP agent. If you choose 'Automatic', the SNMP agents on both sites will negotiate and use the preferred protocol. Choose 'SNMPv1' to force the agents to use SNMP version 1; choose 'SNMP v2c' to force the agents to use SNMP version 2c; choose 'SNMP v3' to use secure SNMP;
  • OID (Numeric/Symbolic) - The Object ID; the OID is a long numeric tag or a symbolic (friendly) name, used to distinguish each variable uniquely in the MIB and in SNMP messages. If you use the numeric tag format, the OID can be prefixed by a '.'. This is optional. For example: .1.3.6.1.2.1.1.5.0 or 1.3.6.1.2.1.1.5.0. Friendly names are names like: system.sysName.0, or interfaces.ifTable.ifEntry.ifOperStatus.1.
  • Select a symbolic OID from a MIB file. - Use this button to select an alpha-numeric OID from a MIB file. You can use virtually any 3rd-party MIB file;
  • OID Data Type - The OID Data type. The following type are valid data types: Bit Stream, Counter, Integer, IP address, Object Identifier, Opaque String, String, Time Ticks and Unsigned Integer;
  • OID Data must be - Choose the condition: Equal To, Not Equal To, Less Than, Less or Equal To, Greater Than, Greater or Equal To. This condition is used to compare the actual SNMP value against the 'IOD Data Value';
  • OID Data Value - OID value that will be compared against the actual OID value, using the 'OID Data must be' operand;
  • AND / OR - To extend the condition, use AND or OR operator. On selecting AND or OR, you must specify an additional condition (Equal To, etc.) and OID Data Value.
SNMP Trap Receive check

The SNMP Trap Receive check listens for real-time network traps for processing. The SNMP Trap Receiver must be enabled at a global level. To enable the SNMP Trap Receiver:

  • On the Tools menu, choose Options;
  • Select the Advanced Tab and click on the Configure SNMP Trap Receiver button;
  • Enable the Trap Receiver by enabling the Enable SNMP Trap Receiver checkbox.

An SNMP Trap Receive check works different than other checks in Network Monitor: the SNMP Trap Receive check is event-driven. The check is not executed at timed intervals, but is triggered on a newly received trap. As a result, you cannot specify a time interval for SNMP Trap Receive checks.

An SNMP Trap Receive check requires the following parameters:

  • Accept Trap(s) from Host - Hostname or IP address of the computer/device to monitor. To specify any host, use '*';
  • Accept OID (Sym/Num) - The SNMP Object ID to receive. This can be a numeric OID or a symbolic OID. Type '*' to check for any OID;
  • Accept only if Data Value matches Regular Expression - You can determine whether or not to accept a the trap, based on the Data Value received;
  • Select a symbolic OID from a MIB file. - Use this button to select an alpha-numeric OID from a MIB file. You can use virtually any 3rd-party MIB file;
  • Match Data Value - Specify what conditions the value must meet to lead to a Failure of Success.
TCP/IP check

ActiveXperts Network Monitor can check local- or remote servers by challenging a specific port. It makes a connection to it, and performs a challenge/respond (by sending a sequence of bytes to it, wait for the respond and analyzing the received information).

A TCP/IP check requires the following parameters:

  • Host - Hostname or IP address of the server to be monitored;
  • Port - TCP port number of the protocol to be checked;
  • Send command when connected - As soon as connection is established, send a command;
  • Response must include string - When connected, optionally send a command. Then wait for a response;
  • Time-out - Number of milliseconds before the check will time-out. Usually, a connection to the server will be established within 1 second. However, some slow/busy servers need more time. Recommended value is 7000 milliseconds.
TFTP check

ActiveXperts Network Monitor can check the availability of a TFTP host by checking the existence of a file on the TFTP host. TFTP stands for 'Trivial File Transfer Protocol' and is a forerunner of the FTP protocol. It has less functionality than FTP: it is based on the (unreliable) UDP protocol, has no support for directory browsing and has not protected by a logon and password. With the TFTP check, you can check for a file in a directory on the TFTP host, and check for a specific pattern in the file.

A TFTP check requires the following parameters:

  • Host - Hostname or IP address of the remote TFTP server. If the remote TFTP server is listing on a port other than 69, you can append it to the host, like this: 192.168.0.1:8069
  • File - The file you want to check;
  • Check file existence only / Check for a specific pattern in the file - You can check for file existence only, or for a specific pattern in the file;
  • Use binary file transfer - Indicates how the file should be transferred so it can be analyzed. Only possible if 'Check for a specific pattern in the file' is selected;
  • Pattern should match / Pattern should not match - If the pattern is matched, then the result of the check can be either success or error.

5.3. Windows Server Checks

By default, ActiveXperts uses the ActiveXperts Network Monitor Engine service credentials to access the remote Windows machines. However, if the service does not have sufficient rights to access the remote Windows machine, you can specify alternate credentials for this Windows machine.
To read more, see topic Monitoring servers in other domains.

MS Active Directory check

The Active Directory check monitors services, processes and WMI counters related to Microsoft Active Directory.

The Active Directory check requires the following parameters:

  • Services - A list of Active Directory services that should be running on the target computer;
  • Processes - A list of Active Directory processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Active Directory performance counters that should be monitored.
  • WMI Performance Counters - A list of Active Directory performance counters that should be monitored.
MS BizTalk check

The BizTalk check monitors services, processes and performance counters related to Microsoft BizTalk.

The BizTalk check requires the following parameters:

  • Services - A list of BizTalk services that should be running on the target computer;
  • Processes - A list of BizTalk processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of BizTalk performance counters that should be monitored.
  • WMI Counters - A list of BizTalk WMI counters that should be monitored.
MS Dynamics NAV check

With ActiveXperts Network Monitor, you can check MS Dynamics NAV servers. The Dynamics NAV check monitors services, processes and performance counters related to Microsoft Dynamics NAV.

The Dynamics NAV check requires the following parameters:

  • Services - A list of Dynamics NAV services that should be running on the target computer;
  • Processes - A list of Dynamics NAV processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Dynamics NAV performance counters that should be monitored.
  • WMI Counters - A list of Dynamics NAV WMI counters that should be monitored.
MS Dynamics AX check

With ActiveXperts Network Monitor, you can check MS Dynamics AX servers. The Dynamics AX check monitors services, processes and performance counters related to Microsoft Dynamics AX.

The Dynamics AX check requires the following parameters:

  • Services - A list of Dynamics AX services that should be running on the target computer;
  • Processes - A list of Dynamics AX processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Dynamics AX performance counters that should be monitored.
  • WMI Counters - A list of Dynamics AX WMI counters that should be monitored.
MS Dynamics CRM check

With ActiveXperts Network Monitor, you can check MS Dynamics CRM servers. The Dynamics CRM check monitors services, processes and performance counters related to Microsoft Dynamics CRM.

The Dynamics CRM check requires the following parameters:

  • Services - A list of Dynamics CRM services that should be running on the target computer;
  • Processes - A list of Dynamics CRM processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Dynamics CRM performance counters that should be monitored.
  • WMI Counters - A list of Dynamics CRM WMI counters that should be monitored.
MS Dynamics GP/SL check

With ActiveXperts Network Monitor, you can check MS Dynamics GP and MS Dynamics SL servers. The Dynamics GP/SL check monitors services, processes and performance counters related to Microsoft Dynamics GP and MS Dynamics SL.

The Dynamics GP/SL check requires the following parameters:

  • Services - A list of Dynamics GP/SL services that should be running on the target computer;
  • Processes - A list of Dynamics GP/SL processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Dynamics GP/SL performance counters that should be monitored.
  • WMI Counters - A list of Dynamics GP/SL WMI counters that should be monitored.
MS Exchange Server check

The Exchange Server check monitors services, processes and performance counters related to Microsoft Exchange Server.

The Exchange Server check requires the following parameters:

  • Services - A list of Exchange Server services that should be running on the target computer;
  • Processes - A list of Exchange Server processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Exchange Server performance counters that should be monitored.
  • WMI Counters - A list of Exchange WMI counters that should be monitored.
MS Forefront check

The Forefront check monitors services, processes and performance counters related to Microsoft Forefront TMG.

The Forefront check requires the following parameters:

  • Services - A list of Forefront services that should be running on the target computer;
  • Processes - A list of Forefront processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Forefront performance counters that should be monitored.
  • WMI Counters - A list of Forefront WMI counters that should be monitored.
MS IIS Server check

The IIS Server check monitors services, processes and performance counters related to Microsoft IIS Server.

The IIS Server check requires the following parameters:

  • Services - A list of IIS services that should be running on the target computer;
  • Processes - A list of IIS Server processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of IIS Server performance counters that should be monitored.
  • WMI Counters - A list of IIS Server WMI counters that should be monitored.
MS Index Server check

The Index Server check monitors services, processes and performance counters related to Microsoft Index Server.

The Index Server check requires the following parameters:

  • Services - A list of Index Server services that should be running on the target computer;
  • Processes - A list of Index Server processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of Index Server performance counters that should be monitored.
  • WMI Counters - A list of Index Server WMI counters that should be monitored.
MS ISA Server check

The ISA Server check monitors services, processes and performance counters related to Microsoft ISA Server.

The ISA Server check requires the following parameters:

  • Services - A list of ISA Server services that should be running on the target computer;
  • Processes - A list of ISA Server processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of ISA Server performance counters that should be monitored.
  • WMI Counters - A list of ISA Server WMI counters that should be monitored.
MS SharePoint Server check

The SharePoint Server check monitors services, processes and counters related to Microsoft SharePoint Server.

The SharePoint Server check requires the following parameters:

  • Services - A list of SharePoint Server services that should be running on the target computer;
  • Processes - A list of SharePoint Server processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of SharePoint Server performance counters that should be monitored.
  • WMI Counters - A list of SharePoint Server WMI counters that should be monitored.
MS SQL Server check

The SQL Server check monitors services, processes and counters related to Microsoft SQL Server.

The SQL Server check requires the following parameters:

  • Services - A list of SQL Server services that should be running on the target computer;
  • Processes - A list of SQL Server processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • Performance Counters - A list of SQL Server performance counters that should be monitored.
  • WMI Counters - A list of SQL Server WMI counters that should be monitored.

5.4. Windows Checks

By default, ActiveXperts uses the ActiveXperts Network Monitor Engine Service credentials to access the remote Windows machines. However, if the service does not have sufficient rights to access the remote Windows machine, you can specify alternate credentials for this Windows machine.
To read more, see topic Monitoring servers in other domains.

Anti-Virus/Internet Security check

The Anti-Virus/Internet Security check allows monitoring various popular Anti-Virus/Internet Security packages on workstations and servers. There are many Anti-Virus/Internet Security suites supported, including Avast, AVG, BitDefender, Eset, F-Secure, G Data, Kaspersky, McAfee, Norman, Sophos, Symantec, Trend Micro, Vipre, Zonealarm and many more.

An Anti-Virus/Anti-Spam check requires the following parameters:

  • Services - A list of services that should be running on the target computer;
  • Processes - A list of processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • WMI Performance Counters - A list of performance counters that should be monitored.
Certificate check

ActiveXperts Network Monitor can check Windows Certificates managed by the Windows Certificates Services Role. It monitors the validity (in days) of the certificate(s). Only Windows Certificates can be monitored.

A Certificate check requires the following parameters:

  • Server - The Windows Server running Certificates Services;
  • Domain - The domain that has the Windows Server is member of;
  • Certificate Services Server - The Certificate Services Server string, by default formatted as:
    <server>\<netbios-domain>-<server>-ca
  • Check All Certificates / Check ony this Certificate - Specify what to monitor: all certificates on the server, or a particular certificate;
  • The Certificate(s) should be valid for at least - Specify the minimum number of days the certificate(s) should be valid
Citrix ICA check

ActiveXperts Network Monitor can check Citrix ICA servers by establishing a connection on the remote TCP port (usually port 1494) and do a handshake. By handshaking, ActiveXperts Network Monitor can verify that the remote server's ICA protocol is working well.

An Citrix ICA check requires the following parameters:

  • Host - Hostname or IP address of the ICA server to be monitored;
  • Port - TCP port number of the ICA protocol. Default: 1494;
  • Send command when connected - As soon as connection is established, send a command. By default, no command string will be sent;
  • Response must include string - When connected, optionally send a command. Then wait for a response. The default response for ICA includes: 'ICA';
  • Time-out - Number of milliseconds before the check will time-out. Usually, a connection to the server will be established within 1 second. However, some slow/busy servers need more time. Recommended value is 7000 milliseconds.
Citrix XenApp check

The Citrix XenApp check monitors services, processes and WMI counters related to Citrix XenApp.

The Citrix XenApp check requires the following parameters:

  • Services - A list of Citrix XenApp services that should be running on the target computer;
  • Processes - A list of Citrix XenApp processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • WMI Performance Counters - A list of Citrix XenApp performance counters that should be monitored.
CPU Usage check

ActiveXperts Network Monitor provides the 'CPU Usage' check to monitor processor(s) on Windows platforms. When the CPU load exceeds the limit, an alert is generated. For multi-processor systems, you can select to monitor all CPU's (default) or monitor an individual CPU.

A CPU Usage check requires the following parameters:

  • Computer - The NetBIOS name, DNS name or the IP address of the computer you want to monitor;
  • CPU - Select 'All CPU's' or 'This CPU'; on a multi-processor system, you can monitor a specific CPU ('This CPU'). To monitor all processors on a single- or multi-processor system, select 'All CPU's';
  • Max. CPU Usage - Maximum allowed CPU usage (%).
  • Credentials - Select alternate Windows credentials if necessary.
Directory check

You are running Windows Server and some of your users insist on copying the contents of their notebook computer to your file server. Other users want to download everything they see on the Web. Unfortunately, you're running out of disk space. Disk space is your server's most expensive subsystem, so it's a good practice to monitor - for instance - user's Home Directories. The 'Directory check' can be of good help.

A Directory check requires the following parameters:

  • Directory - The directory in UNC ('Universal Naming Convention') format. For instance: \\server01\public\docs;
  • Check Directory Existence Only / Check Directory Size / Check File Count / Check Directory Content Change - Select the type of Directory check;
  • Minimum/Maximum size - Minimum or maximum size (MB) of the directory (only applicable if 'Check Directory Size' is selected);
  • Minimum/Maximum number - Minimum or maximum of files in a directory (only applicable if 'Check File Count' is selected). If you want to count a directory as a file, select 'Also count a directory as a file';
  • Include subdirectories - select this option to include subdirectories in any type of directory check;
  • Credentials - Select alternate Windows credentials if necessary.
Disk Drives check

ActiveXperts Network Monitor can monitor all physical disk drives on servers running the Windows operating system. If a malfunctioning disk drive is detected on the computer, an alert is generated.

A Disk Drive check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Credentials - Select alternate Windows credentials if necessary.
Disk Space check

The amount of free disk space is checked periodically, and if it drops too low you're immediately notified. It can also notify if used space gets too high.

A Disk Space check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Drive - the drive letter as it appears on the remote server;
  • Disk Space - Maximum allowed space / Minimum required free space - In case of 'Minimum required free space', the computer is checked for a minimum available space specified by the number of MB's that you enter. In case of 'Maximum allowed used space', the computer is checked for a maximum used space specified by the number of MB's that you enter;
  • MB / GB / % - the upper/lower limit in Megabytes, Gigabytes or percentage;
  • Credentials - Select alternate Windows credentials if necessary.

Note: The 'Disk Space' check uses the system's administrative shares (i.e. C$, D$ etc.) to access drives on remote computers. For security reasons, these share are sometimes renamed by system administrators, for instance: MYCDRIVE$. You can type such a name in the selection box, and the Network Monitor Engine will use this administrative share name instead of the defaults administrative share name.

Event Log check

ActiveXperts Network Monitor can read Windows Event logs on local- or remote computers. It can look for specific Event Sources, Categories, Event ID's and so on. It can look for a pattern in the Description of the Event. It can do advanced filtering in Event Logs; it can look for multiple events in the Event Log, and notify the system administrator if one of the Events occurred in a specific time interval. For instance, as a network administrator, you want an alert if there's a McAfee or Norton virus message in the Application Event Log, but only if the event is posted in the last 30 minutes. ActiveXperts Network Monitor uses VBScript and WMI for this.

It enables you to fully customize Event Log filtering, speeding up performance by checking for more than one event in each cycle.

An Event Log check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Log File - The Log File to be checked. Choose the appropriate log file, for instance: 'Application', 'Security', 'System', or server-related log (like DNS, Exchange, etc.);
  • Credentials - Select alternate Windows credentials if required;
  • Information/Warning/. - Filter these event types;
  • Source - Filter events that match this Event Source;
  • Category - Filter events that match this Event Category;
  • ID - Filter events that match this Event ID;
  • User - Filter events that match this User;
  • Description matches string - Filter events that match the description string in the Event Message;
  • Only Events from the last x minutes - This options allows you to discard errors that happened in the past. For instance, if you don't want to be notified about error events that happened in the past (like a week ago), use this option;
  • This check will fail if such event is found/not found - Specify whether this check will fail or succeed when an event is found.
File check

ActiveXperts Network Monitor can monitor file existence, file size and file content. This is particularly useful in situation where log files need to be analyzed. In many organizations, batch jobs run at night and produce logging information; ActiveXperts Network Monitor can check this logging information and analyze it. It can check the existence, or search for patterns. It can also check the size of a file.

A File check requires the following parameters:

  • File (UNC Path) - The path of the file to be checked in UNC format (i.e. \\server\share\... syntax);
  • Check for: Existence only / Maximum Size / Pattern - Choose an option: just checks the existence, or check the size of a file (in KB/MB), or search for a pattern in the file
  • If condition should be True/False - If the file conditions are true, then the result of the check is: success; otherwise, the result will be: error;
  • Credentials - Select alternate Windows credentials if necessary.
Memory Usage check

ActiveXperts Network Monitor can check the memory usage of the Windows Operating System. It can monitor the total available physical memory usage, the committed memory or the pages per second.

A Memory Usage check requires the following parameters:

  • Computer - Host name or IP address of the computer to monitored;
  • Memory - select 'Minimum required Available Physical Memory' to check physical available memory; choose 'Maximum allowed Committed Memory' to check committed memory; choose 'Maximum allowed Pages Per Second' to check paging;
  • MB / Pages per Second - enter the amount in MB's (for the physical memory and committed memory checks) or number of pages per second;
  • Credentials - Select alternate Windows credentials if necessary.
MS Message Queue (MSMQ) check

ActiveXperts Network Monitor monitors the status of the MS Message Queue's. It can check a queue for its length (i.e. number of jobs in the queue) or for its total size (MB).

An MSMQ check requires the following parameters:

  • Server - The host name or IP address of the server;
  • Queue Name - Name of the MSMQ queue, for instance: private$\admin_queue$;
  • Maximum Queue Length - Maximum number of jobs allowed in the queue;
  • Maximum Queue Size - Maximum amount of MB's in the queue;
  • Credentials - Select alternate Windows credentials if necessary.
MS Terminal Server check

ActiveXperts Network Monitor monitors the status of the Operating System's Terminal Server role (part of Windows 2019/2016/2012(R2)/2008(R2)/10/8/7) by checking the number of active/inactive sessions.

A Terminal Server check requires the following parameters:

  • Terminal Server Computer - The host name or IP address of the Terminal Server computer;
  • Maximum number of Active Sessions - Maximum active sessions;
  • Maximum number of Inactive Sessions - Maximum inactive sessions, i.e. disconnected and idle sessions;
  • Maximum number of Sessions - Maximum number of active and inactive sessions;
  • Credentials - Select alternate Windows credentials if necessary.
Performance Counters

The Performance Counter check monitors one or more Performance counters.

One or more Performance Counters must be defined:

  • Performance Object - Type of Performance Data, e.g. Network Interface;
  • Instance - If there are multiple instance, specify which instance you want to monitor;
  • Condition - The condition that should be met, e.g. Bytes Received/sec<1000.
Printer Availability check

Even the most mechanically sound printer stops working or needs maintenance from time to time:

Printers run low on toner, run out of paper, or get jammed - unavoidable situations that prevent users from printing their documents. Unfortunately, when a printer stops working, no notice is sent to users; in addition, users can still send print jobs to the printer. If the problem is not identified and corrected, those jobs will continue to accumulate as long as the printer is unavailable. For these reasons, monitoring the printers in your organization is an important part of print management. With a well-designed monitoring strategy in place, you can receive timely notification whenever a printer stops functioning and take immediate steps to either get the printer back online or transfer print jobs to a different printer. ActiveXperts Network Monitor checks printers for availability by checking its status. Windows knows a wide range of printer status values, like: 'Running', 'In Test', 'Power Off', 'Offline', 'Power Save', and so on. If the Printer Status is not equal to Running or Power Save, then the printer is considered as malfunctioning.

A Printer Availability check requires the following parameters:

  • Print Server - The hostname or IP address of the print server;
  • Printer Name - The name of the printer, as it appears in the Windows' control panel. For instance: 'HP LaserJet 2300 Series PS';
  • Credentials - Select alternate Windows credentials if necessary.

Note: The printer availability check is based on WMI.

Process

ActiveXperts Network Monitor allows users to check processes on local- and remote computers; if a process is active, a computer is considered available. Additionally, memory usage of a process can be checked, to detect memory leaks.

A Process check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Process - The module name of the process, including the extension. For instance: alerter.exe, or explorer.exe;
  • Check memory of this process - Enable/disable memory checking of the particular process. Enter the maximum amount of memory (in MB) that a process may consume;
  • No process on this computer should consume more than - Checks for any process using more than the specified amount of memory;
  • Credentials - Select alternate Windows credentials if necessary.

Note: The process check is based on WMI; it requires WMI on both monitored and monitoring system.

Registry check

ActiveXperts Network Monitor can check a registry value on a remote Windows machine. You can compare a current registry value with a predefined pattern. You can even monitor registry changes.

A Registry check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Root Key - The registry root key, e.g. HKEY_LOCAL_MACHINE;
  • Sub Key (Path) - Registry subkey, e.g. Software\Microsoft\Windows\CurrentVersion\Setup;
  • Value - The registry value that you want to monitor;
  • Data must be - Choose the condition: Equal To, Not Equal To, Less Than, Less or Equal To, Greater Than, Greater or Equal To. This condition is used to compare the actual registry value against the predefined value;
  • AND / OR - To extend the condition, use AND or OR operator. On selecting AND or OR, you must specify an additional condition (Equal To, etc.) and OID Data Value.
Removable Drives check

Use the Removable Drive check to detect the presence of USB drives, CompactFlash, memory cards and other portable storage devices on your domain or network.

A Removable Drive check requires the following parameters:

  • Domain or List of Computers - Specify what to check: all computers in a domain, or a list of computers;
  • Exclusion List - List of pairs (computer/drive) that is excluded from the check.
Scheduled Task

With the Scheduled Task check, one can check if a scheduled task has completed successfully or not. A Scheduled Task check can only be applied to a task that should run today. I.e. you cannot check the completion of a task that ran - for instance - yesterday.

A Scheduled Task check requires the following parameters:

  • Scheduled Task Log File - the fully qualified path name to the Scheduled Task Log File (SchedLgU.txt), in UNC format; for instance: \\Server01\C$\Windows\Tasks\SchedLgU.txt
    Please note that this file is hidden in the Windows Explorer. Use a command prompt and type DIR C:\WINDOWS\TASKS to list the file;
  • Job Name - Job name, as it appears in the SchedLogU.txt file. For instance, job name should be mytask.bat according to the following log entry:
    "mytask.job" (mytask.bat)
    Finished 1/19/2006 1:43:00 PM
    Result: The task completed with an exit code of (0).
  • Completed Keyword - The keyword that determines the completion of a scheduled task. For many servers, the keyword will be Finished. However, the keyword can be different on non-English Operating Systems you are monitoring;
  • Today's Date Format - The string that determines the date format used in the Scheduled Task Log File. Note that your network servers can use different time formats. For that reason, you must specify the date format, so Network Monitor will be able to find the log entries that match the day of today. Default format: mm/dd/yyyy, i.e. month (2 digits), day (2 digits), year (4 digits), separated by a '/';
  • Match Result - The string that indicates a successful/unsuccessful completion of the task.
    A successful completion is usually determined by the following string:
    Result: The task completed with an exit code of (0);
    An unsuccessful completion is usually determined by the following string:
    Result: The task completed with an exit code of (1);
    Note that the string can be different on non-English platforms and on legacy (e.g. Windows NT 4) platforms;
    If pattern matched, result is - Indicates the result of the check if pattern is matched: Success or Error.
Service

Service monitoring involves a probe that returns the status of a service. ActiveXperts Network Monitor monitors services on local- and remote computers by checking if the status equals "Running". If so, the server is running fine, otherwise it's not.

A Service check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Service - The Windows service name. You can either the 'friendly name' (as it appears in the Control Panel) or the 'short name' (the registry key name in the HKLM\System\CurrentControlSet\Services registry hive);
  • Must run / Must not run - Determines success or error of the check. If the service should NOT be running, select 'Must not run', otherwise select 'Must run';
  • Credentials - Select alternate Windows credentials if necessary.
Windows Defender

The Windows Defender check monitors services, processes and WMI counters related to Microsoft Windows Defender.

The Windows Defender check requires the following parameters:

  • Services - A list of Windows Defender services that should be running on the target computer;
  • Processes - A list of Windows Defender processes that should be running on the target computer. For each process, you can specify a maximum CPU usage and a maximum memory usage;
  • WMI Performance Counters - A list of Windows Defender performance counters that should be monitored.
Windows Update

The Windows Update check monitors the update status of a Windows machine. It monitors the number outstanding critical updates, security updates, regular updates, feature packs and more. It requires the Windows Update service on the remote machine to be installed. If the service is not running, ActiveXperts will try to start it.

The Windows Update check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Maximum number of available critical updates - If the actual number of available critical updates exceeds this value, the check will fail; otherwise, it will return success;
  • Maximum number of available security updates - If the actual number of available security updates exceeds this value, the check will fail; otherwise, it will return success;
  • Maximum number of available total updates - If the actual number of total updates exceeds this value, the check will fail; otherwise, it will return success. All updates will be counted, included critical updates, security updates, minor updates, feature packs and more.
WMI Counters

The WMI Counter check monitors one or more WMI counters.

One or more WMI Counters must be defined:

  • WMI Data Class - Type of WMI Data, e.g. Win32_OperatingSystem;
  • WMI Data Instance - If there are multiple instance, specify which instance you want to monitor;
  • Condition - The condition that should be met, e.g. MessagesQueuedForSubmission<10.

5.5. Windows Custom Script

PowerShell

PowerShell is a command line interface shell for Microsoft Windows platforms. It is a standard feature on Windows platform. It is installed by default on Windows 2008R2 Server platforms and higher, and also on Windows 7 workstation platforms and higher. On lower platforms, it is available but not installed by default.

ActiveXperts Network Monitor can check any Windows server by running a PowerShell script. The script is executed on the monitoring machine. There's no need to have PowerShell installed on the monitored server; it must be installed on the monitoring computer. PowerShell scripts do not need to be copied to the monitored computer; you can have all PowerShell scripts located on the monitoring computer to monitor remote computers.

ActiveXperts Network Monitor ships with a collection of PowerShell (.ps1) that work out of the box.

ActiveXperts Network Monitor requires the PowerShell script output (i.e. StdOut) to be formatted according to the following syntax:

    [SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> field is displayed in the 'Last Response' column in the Manager application. The <value> field is displayed in the 'Data' column in the Manager application.

Samples:

    ERROR: Free Disk space is less than 40 GB DATA:34
    SUCCESS: CPU Usage is 10%, maximum allowed is 50%  DATA:10 

A PowerShell check requires the following parameters:

  • Script File - The PowerShell script. The script is executed on the monitoring computer;
  • Parameter1 - 1st parameter of the script (optional);
  • Parameter2 - 2nd parameter of the script (optional);
  • Parameter3 - 3rd parameter of the script (optional);
  • Parameter4 - 4th parameter of the script (optional);
  • Parameter5 - 5th parameter of the script (optional);
  • Parameter6 - 6th parameter of the script (optional);
  • Parameter7 - 7th parameter of the script (optional);
  • Parameter8 - 8th parameter of the script (optional);
  • If StdErr is not empty, the result will be - If there's an error in the script, you can handle this error and specify what the result of the check should be: Uncertain, Error or Success;
  • Time-out - Number of milliseconds before the check will time-out.
Remote Command

ActiveXperts Network Monitor can check any Windows server by executing a command on a remote computer. The command file (executable, batch-job, etc.) must be located on the remote monitored computer.

ActiveXperts Network Monitor requires the remote command output (i.e. StdOut) to be formatted according to the following syntax:

    [SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> field is displayed in the 'Last Response' column in the Manager application. The <value> field is displayed in the 'Data' column in the Manager application. Samples:

    ERROR: Free Disk space is less than 40 GB DATA:34
    SUCCESS: CPU Usage is 10%, maximum allowed is 50%  DATA:10

A Remote Command check requires the following parameters:

  • Computer - The host name or the IP address of the computer you want to monitor;
  • Command - The command to execute on the remote computer. This command must reside on the remote computer;
  • If StdErr is not empty, the result will be - If there's an error in the script, you can handle this error and specify what the result of the check should be: Uncertain, Error or Success;
  • Command Time-out - Number of milliseconds before the command will time-out.

Note: The Remote Command check installs a service on the remote computer in order to execute the command. This service is called 'ActiveXperts Remote Command service'; the associated executable name is 'AxRemSvc.exe'. The service is uninstalled after the check has completed and is re-installed once the check is processed again.

VBScript

ActiveXperts Network Monitor provides a programming interface to IT administrators. VBScript is the standard scripting language in ActiveXperts Network Monitor product. VBScript is the most popular scripting language in Windows environments.

A VBScript check requires the following parameters:

  • File - Name of the VBScript file. The script should contain a function as specified in the Function name field. This function should return True (-1) on success, False (0) on error or Unknown (1) in case the results is not known;
  • Function - The function that should be called by ActiveXperts Network Monitor. This function should return True (-1) on success, False (0) on error or Unknown (1) in case the result is not known;
  • Parameter1 - 1st argument of the function (optional);
  • Parameter2 - 2nd argument of the function (optional);
  • Parameter3 - 3rd argument of the function (optional);
  • Parameter4 - 4th argument of the function (optional);
  • Parameter5 - 5th argument of the function (optional);
  • Parameter6 - 6th argument of the function (optional);
  • Parameter7 - 7th argument of the function (optional);
  • Parameter8 - 8th argument of the function (optional);
  • Advanced Settings:Time-out - You can specify a time-out for a VBScript check. If the script takes longer than the time-out (in seconds), the function is aborted and an 'Unknown' result is reported. By default, there's no time-out used;
  • Advanced Settings:Block script after a bad operation - If a script crashes, for instance because of bad programming, you can block the script so that it will be executed the next time. By default, this option is enabled.

Visit www.activexperts.com/support/network-monitor/online/vbscript/ for detailed information on writing custom VBScript checks.

5.6. Linux/Unix Checks

SSH

SSH Secure Shell allows secure network services over an insecure network, such as the Internet. With SSH, ActiveXperts Network Monitor can login onto a remote machine running the SSH daemon, and execute a command or shell script. ActiveXperts Network Monitor requires the output (i.e. StdOut) to be formatted according to the following syntax:

[SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> field is displayed in the 'Last Response' column in the Manager application. The <value> field is displayed in the 'Data' column in the Manager application.

Samples:

ERROR: Free Disk space is less than 40 GB DATA:34
SUCCESS: Daemon 'LPD' is running

To allow clients (incl. ActiveXperts Network Monitor) to run a shell script on Linux/Unix machine using SSH, the following pre-conditions must be met:

  • The remote Linux machine must have the SSH daemon running;
  • The client must have an entry in the host.allowed configuration file;
  • The shell script must be copied to the Linux machine first, i.e. it cannot be launched from a Windows machine.

An SSH Shell Script check requires the following parameters:

  • Remote Host - Host name or IP address of the remote Linux/Unix host;
  • Port - TCP port used for SSH on the remote host. Default port is 22;
  • SSH Command - Specifies the command to run on the remote host;
  • Script Time-out - Specifies the maximum number of milliseconds to wait for completion of the script; if the script takes longer, it will be terminated. Default value: 5000 milliseconds;
  • Account - Account used to authenticate to the remote host;
  • Password - Password used to authenticate to the remote host. If you use a Private Key File to authenticate, you can leave the 'Password' field blank;
  • Private Key File - Private Key File used to authenticate to the remote host. If you use a Password file to authenticate, you can leave the 'Private Key File' field blank;
  • If StdErr is not empty, the result will be - If there's an error in the script, you can handle this error and specify what the result of the check should be: Uncertain, Error or Success.
SSH

SSH Secure Shell allows secure network services over an insecure network, such as the Internet. With SSH, ActiveXperts Network Monitor can login onto a remote machine running the SSH daemon, and execute a command or shell script. ActiveXperts Network Monitor requires the output (i.e. StdOut) to be formatted according to the following syntax:

[SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> field is displayed in the 'Last Response' column in the Manager application. The <value> field is displayed in the 'Data' column in the Manager application.

Samples:

ERROR: Free Disk space is less than 40 GB DATA:34
SUCCESS: Daemon 'LPD' is running

To allow clients (incl. ActiveXperts Network Monitor) to run a shell script on Linux/Unix machine using SSH, the following pre-conditions must be met:

  • The remote Linux machine must have the SSH daemon running;
  • The client must have an entry in the host.allowed configuration file;
  • The shell script must be copied to the Linux machine first, i.e. it cannot be launched from a Windows machine.

An SSH Shell Script check requires the following parameters:

  • Remote Host - Host name or IP address of the remote Linux/Unix host;
  • Port - TCP port used for SSH on the remote host. Default port is 22;
  • SSH Command - Specifies the command to run on the remote host;
  • Script Time-out - Specifies the maximum number of milliseconds to wait for completion of the script; if the script takes longer, it will be terminated. Default value: 5000 milliseconds;
  • Account - Account used to authenticate to the remote host;
  • Password - Password used to authenticate to the remote host. If you use a Private Key File to authenticate, you can leave the 'Password' field blank;
  • Private Key File - Private Key File used to authenticate to the remote host. If you use a Password file to authenticate, you can leave the 'Private Key File' field blank;
  • If StdErr is not empty, the result will be - If there's an error in the script, you can handle this error and specify what the result of the check should be: Uncertain, Error or Success.
RSH

RSH is a client process that opens connections to an rsh daemon; it sends a command to execute on the remote server and retrieves its output, both stdout and stderr. The connection is established on standard port 514 (tcp port for the shell/cmd protocol). ActiveXperts Network Monitor requires the output (i.e. StdOut) to be formatted according to the following syntax:

[SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> field is displayed in the 'Last Response' column in the Manager application. The <value> field is displayed in the 'Data' column in the Manager application.

Samples:

ERROR: Free Disk space is less than 40 GB DATA:34
SUCCESS: Daemon 'LPD' is running

To allow clients (incl. ActiveXperts Network Monitor) to run a shell script on Linux/Unix machine using RSH, the following pre-conditions must be met:

  • The remote Linux/Unix machine must have the RSH daemon running;
  • The remote Linux/Unix must have an entry in its .RHOSTS file for the computer where the ActiveXperts Network Monitor Engine service is running on; this entry must include two values: the host name of the ActiveXperts Network Monitor server and the username to use.

A RSH Shell Script check requires the following parameters:

  • Remote Host - Host name or IP address of the remote Linux/Unix host;
  • RSH Username - The username to use on the remote host. If not specified, the service account name will be used. The value must be configured in the .RHOSTS file on the remote host;
  • RSH Command - Specifies the command to run on the remote host;
  • Script Time-out - Specifies the maximum number of milliseconds to wait for completion of the script; if the script takes longer, it will be terminated. Default value: 5000 milliseconds;
  • If StdErr is not empty, the result will be - If there's an error in the script, you can handle this error and specify what the result of the check should be: Uncertain, Error or Success.

5.7. Database Checks

Database Query (Generic)

ActiveXperts Network Monitor uses OLE DB (also known as ADO) to check availability of databases. OLE DB (sometimes written as OLEDB or OLE-DB) is an API for accessing different types of data stores in a uniform manner, including: MS SQL, MS Access, Oracle, MySQL and more.

The Database Query check requires the following parameters:

  • OLE DB (ADO) Connection String - The OLE DB connection string, for instance: DRIVER=Microsoft Access Driver(*.mdb);DBQ=\\SERVER03\Public\Northwind.mdb You can use a password in this connections string. To hide the password, you can use the <%PASSWORD%> placeholder. When using this placeholder, ActiveXperts will automatically substitute this placeholder with the 'Password' field described below;
  • Password - This is the password string (shown as asterisks) that will substitute the <%PASSWORD%> field described above;
  • Database Query - The database query. The result of the check is determined by the result of this query;
  • Match Field - The field that will be matched to determine the result of the check;
  • Value must be... - Operator and value to compare;
  • Compare as - data type.

You can use an AND/OR operator to create an advanced condition.

Note: For advanced database checks, you should use the custom VBScript database check. This check can be fully customized to meet your requirements. For instance, you can build complex queries, and analyze the query output. To create a new VBScript based database check, select Create New Check (Scripts) from the Monitor menu, choose VBScript Check..., and select 'Database.vbs'. Then, modify 'Database.vbs' to meet your requirements.

ODBC Database

ActiveXperts Network Monitor uses ODBC to check availability of a variety of databases. Most major database systems support ODBC, such as: Microsoft SQL Server, Microsoft Access, Microsoft Excel, Oracle, FoxPro, Paradox, SyBase, Informix, OpenIngres, InterBase, Progress, IBM LANDP, DB2 and AS/400. You must configure ODBC (from the Control Panel on the server where ActiveXperts Network Monitor is running on) before ActiveXperts Network Monitor can check ODBC compliant databases.

An ODBC check requires the following parameters:

  • ODBC DSN Name - the ODBC DSN (Data Source Name). This DSN entry must be configured on the server where the ActiveXperts Network Monitor Engine service is running;
  • Username/Login - credentials required to access the database;
  • Password - credentials required to access the database.

ActiveXperts Network Monitor also provides Oracle checks based on SQLNet, like TNSPing and logon/logoff through SQLNet.

Note: The 'ADO / OLE/DB' check requires fewer configurations and is usually faster. As a result, it is the preferred way to check database, unless the database doesn't ship with an OLE DB driver.

Oracle Database

ActiveXperts Network Monitor uses SQL*Net to monitor Oracle servers for availability. The role of SQL*Net is to establish and maintain a connection between the client application and the server and exchange messages between them. SQL*Net is a software layer that is required to communicate between Oracle clients and servers. It provides both client-server and server-server communications across any network. It enables client tools to access, modify, share, and store data on Oracle servers over a Network. The communication between client applications and servers takes place across one or more networks, and is referred to as client/server communication.

ActiveXperts Network Monitor has two SQL*Net based checks for Oracle:

  • TNSPing check;
  • Logon/logoff to a database using username and password for that database.

A Database-Oracle TNSPing check requires the following parameters:

  • Server TNS name - TNS name of the Oracle database.

A Database-Oracle Logon/Logoff check requires the following parameters:

  • Server TNS name - TNS name of the Oracle database;
  • Username/Login - credentials required to access the database;
  • Password - credentials required to access the database.

5.8. Environmental Checks

Environmental Devices

ActiveXperts supports a wide variety of Environmental Monitoring devices. These devices are characterised by the following: a) they have an IP interface, and b) they have ports to connect multiple sensors.

A sensor is a (long) cable that connects on one side to one of the ports of the device, and on the other side has the actual sensor.

ActiveXperts has native support for the following brands:

  • AVTech; see www.avtech.com;
  • Sensatronics (company no longer exists, but tens of thousands of devices are still functional in the world).

In addition, ActiveXperts provides support for almost all environmental monitoring devices available worldwide, through the use of the standard protocols:

ActiveXperts provides native support for all AVTech Room Alert models, namely:

  • AVTech Room Alert 32S
  • AVTech Room Alert 12SR
  • AVTech Room Alert 12S
  • AVTech Room Alert 3S

The AVTech devices have the following features in common:

  • They have an Ethernet Interface
  • They have a built-in temperature sensor (built into the device)
  • They have 1 or more Digital Sensors
  • They have 1 or more Switch Sensors

For a comprehensive AVTech product overview, as well as price information, click here.

Checks

ActiveXperts Network Monitor supports a wide variety of sensors attached to your environmental monitoring device, including:

  • Temperature Sensor
  • Humidity Sensor
  • Combined Temperature/Humidity Sensor
  • Flood (Wetness) Sensor
  • Room Entry (Door) Sensor
  • Airspeed (Airflow, Airconditioner) Sensor
  • Power (Active) Sensor
  • Powerstate Sensor
  • Smoke Sensor
  • Voltage/Analog Sensor

An Environmental check requires the following parameters:

  • IP / Hostname - The host name or IP address of the network interface of the monitoring device;
  • Device Model - The type of device that has the internal sensor or external sensors attached;
  • Sensor - The particular sensor ('probe'). This can be an internal sensor, or an external sensor attached to the device;
  • Sensor Units - Select the preferred unit: Fahrenheit, Celsius, Kelvin or Rankine;
  • Range - Minimum Value - Minimum allowed value;
  • Range - Maximum Value - Maximum allowed value;
Environmental Monitoring and SNMP Traps

By default, a check in ActiveXperts is executed once every few seconds or minutes. This is sufficient for most checks. However, some checks require immediate alerting. A good example is a door sensor. Suppose the door sensor is executed once in a minute, then it is still quite possible that someone will quickly enter and there is no alerting. Same goes for the motion sensor. A movement can be a fraction of a second.

Immediate alerting can be accomplished through the use of SNMP Traps, for instancne for an AVTech Room Alert monitoring device:

  • On the Monitoring menu, click Create New Check;
  • In the Check What drop-down box, select Environmental->Any Sensor (SNMP Trap based);
  • In the Accept Host box, type the IP address or hostname of the AVTechm Room Alert monitoring device;
  • In the Load AVTech Alarm OID... drop-down box, select a AVTech Room Alert Model;
  • In the Accept only if Data Value matches... box, type a regular expression that matches the Sensor description. This is to receive only the SNMP Traps addressed to this specific sensor
  • In the Match Data Value box, type the '.*ALARM:.*' regular expression, so that the result of the check will be a Failure.

AVTech devices have only ONE alarm OID for all sensors.

AVTech Room Alert 32S:

iso.org.dod.internet.private.enterprises.avtech.products.roomalert32S.traps.alarmmessage.0
.1.3.6.1.4.1.20916.1.11.2.1.0

AVTech Room Alert 12S / 12SR:

iso.org.dod.internet.private.enterprises.avtech.products.roomalert12S.traps.alarmmessage.0
.1.3.6.1.4.1.20916.1.12.2.1.0

AVTech Room Alert 3S:

iso.org.dod.internet.private.enterprises.avtech.products.roomalert12S.traps.alarmmessage.0
.1.3.6.1.4.1.20916.1.12.2.1.0

As the Trap OID is not unique to the sensor, but is used for all sensors, there must be another way to distinguish the sensor. We do this by constructing a regular expression, accepting/not accepting the received SNMP Trap.

For example, if you have a Door Sensor and a Motion sensor (both are Switch Sensors) on a Room Alert 32S device with IP 10.1.1.155, this is what needs to be done:

  • In the AVTech Room Alert device settings, make sure both sensors have unique descriptions defined. For instance 'SwitchSensor01: Door Sensor' and 'SwitchSensor02: 'Motion Sensor';
  • In the AVTech Room Alert device settings, make sure a trap is sent out on failure. Make sure it is sent to the IP address of the ActiveXperts monitoring server;
  • In the ActiveXperts Manager, create a new Check for the Door sensor by selecting [Environmental Monitoring]->'Any Check (SNMP Trap based)'
  • Use the following parameters in the configuration dialog: Accept Trap(s) from host: 10.1.1.155
    Accept OID Sym/Num: iso.org.dod.internet.private.enterprises.avtech.products.roomalert32S.traps.alarmmessage.0
    Accept Only if Data Value matches following Regular Expression: .*Door.*, or ^.*SwitchSensor01.*$
  • Leave all other fields default
  • Create a new Check in the same way, but make sure the regular expression is different, e.g.: ^.*Motion.*$

5.9. Miscellaneous Checks

Serial Device check

ActiveXperts Network Monitor allows you to query a serial device (e.g. a modem, a weight indicator, etc.) and analyze the response. The device must have a serial port interface, for instance an RS-232 interface. USB devices are also supported, but only if the device ships with a driver to emulate a serial port.

A Serial Device check requires the following parameters:

  • Device - Device driver to use. You can either use a Windows telephony device (recommended) or a physical COM port (directly);
  • Flow Control - Select the type of flow control to use. The following values are valid: Default, None, Hardware, Hardware+Software. You can only select 'Flow Control' if 'Device' is set to a direct port (i.e. not a TAPI device);
  • Baudrate - Select the baudrate (port speed). You can only select 'Baudrate' if 'Device' is set to a direct port (i.e. not a TAPI device);
  • Send command when connected - As soon as connection is established, send a command;
  • Response must include string - Expected response;
  • Time-out - Number of milliseconds before the check stop reading information from the device.
Users & Groups

ActiveXperts Network Monitor monitors groups and group membership. In case of unexpected members in certain groups (for instance: unexpected Domain Admins members), it'll notify the network administrators.

ActiveXperts Network Monitor checks different kinds of Directory Services, for instance: Active Directory, or Novell NDS. You can configure ActiveXperts Network Monitor to check user accounts (locked out, disabled, etc.), groups, group membership, organizational units, and so on.

The User/Group Membership check requires the following parameters:

  • Domain - The Active Directory domain. In case you want to monitor a stand-alone server (i.e. a server not member of a domain), you can enter the computer name;
  • Group - The group name to the Active Directory group you want to check, like: Domain Admins;
  • Users - Specify the names of the users that are allowed in the specified group. If the groups appears to have members who are not entered in this 'Users' field, the check will fail.

6. Scripted Checks

6.1. Introduction

ActiveXperts Network Monitor allows you to extend the set of built-in check routines by writing your own check routines.
ActiveXperts supports PowerShell (Windows), VBScript (Windows), (Remote) Command (Windows) and SSH (Linux/Unix) for custom scripting.

PowerShell and VBScript are defacto standards for scripting in Windows. Both are popular because of its wide acceptance and its support for ActiveX technologies. PowerShell has full support for .NET frameworks. ActiveXperts ships with a large collection of PowerShell scripts, VBScript and Windows Batch scripts. You can use these script directly, or make modifications to it to meet your requirements.

SSH is a defacto secure standard for remote shell execution. RSH is the less-popular, non-secure equivalent. ActiveXperts ships with a large collection of SSH shell scripts. You can use these script directly, or make modifications to it to meet your requirements.

Enabling PowerShell scripts

Out of the box, the Operating System does not allow you (or ActiveXperts Network Monitor) to run PowerShell scripts. You must enable PowerShell scripting first from the command line.

6.2. PowerShell (Windows)

Introduction

PowerShell is a command-line shell with associated scripting language from Microsoft. It was released in 2006, and is part of Windows Operating Systems currently support by Microsoft.

Enabling PowerShell scripts

Out of the box, the Operating System does not allow you (or ActiveXperts Network Monitor) to run PowerShell scripts. You must enable PowerShell scripting first from the command line.

To allow execution of Powershell scripts in ActiveXperts Network Monitor, please do the following:

  • Open a new command prompt (for instance by typing CMD.EXE" in the Windows Start-Run line)
  • Type PowerShell.exe and press <Enter>
  • Type Set-ExecutionPolicy Unrestricted and press <Enter>
Using PowerShell scripts in ActiveXperts Network Monitor
In order to use PowerShell with Network Monitor, PowerShell needs to be installated on the monitoring server. It is not required to have PowerShell installed on the monitored server!

ActiveXperts Network Monitor ships with a set of PowerShell that run out of the box. These can be used to check servers and can be modified in order to meet your requirements. ActiveXperts Network Monitor requires the output (i.e. StdOut) of the PowerShell script to be formatted according to the following syntax:

  [ SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> will be shown in the 'Last Response' column in the Manager application. The <value> field will be shown in the 'Data' column in the Manager application. For example:

  ERROR: Free disk space is less than 40 GB DATA:34

or

  SUCCESS: Free disk space is more than 40 GB DATA:102

6.3. VBScript (Windows)

ActiveXperts Network Monitor contains a comprehensive set of built-in monitoring checks. The product is designed to let operators write their own monitoring checks and use them in the product. ActiveXperts uses VBScript because it is the most popular scripting language in Windows environments.

ActiveXperts ships with a collection of cooked VBScript files and routines. These scripts are located in the folder '\Scripts\Monitor (vbs)' folder, and can be used out of the box. Feel free to modify these scripts.

VBScript check routines should return one of the following values:

  • -1 (True); Return -1 in case the check is successful. For instance, if your function checks the existence of a certain directory, and it does exist, then return -1;
  • 0 (False); Return 0 in case the check is not successful. For instance, if your function checks the existence of a certain directory, and it does not exist, then return 0;
  • 1 (Unknown); Return 1 in case the check cannot determine True or False. For instance, if your function checks the existence of a certain directory on a server, but it cannot find the server at all (for instance because the computer is down), return 1;

Keep the following in mind when writing a new VBScript function:

  • The routine must be a Function, not a Sub;
  • The Function must return True (-1), False (0) or Unknown (1);
  • The SYSEXPLANATION and SYSDATA variables must be declared (e.g. 'Dimmed') because they are used internally by ActiveXperts Network Monitor;
  • Use the SYSEXPLANATION system variable to add your own explanation to the result of the function; this SYSEXPLANATION is shown in the client program each time the check is made;
  • Use the SYSDATA system variable to store any relevant data, if any. This data field is also shown in the Manager ('Data' column) and is also written to the log files;

Function template:

Const retvalUnknown = 1
Dim SYSDATA, SYSEXPLANATION

Function Foo( var1, var2, ..., varn )
   If( Not Pre-condition ) Then
      SYSEXPLANANTION = "Unable to determine..."
      Foo = retvalUnknown
   Else
      If( condition ) Then
         SYSEXPLANANTION = "Yes it is true because ..."
         SYSDATA = 5
         Foo = True
      Else
         SYSEXPLANANTION = "No it's not true because ..."
         SYSDATA = 6
         Foo = False
      End If
   End If
End Function  

To add a VBScript check:

  • From the Monitor menu, choose Create New Check (Scripts) and choose VBScript Check...;
  • Select a VBScript File and a VBScript function;
  • Enter the required parameters and press OK.

To create a new VBScript file, choose Create New File from the File selection box and a new file will be created. To create a new function in a VBScript file, choose Add New Function from the Function selection box and a new function will be written.

Don't use WScript objects in your scripts

Any commands and functions related to a console or User Interface should be avoided. Keep in mind that the Network Monitor Engine runs as a service, and has no user interface. Message boxes and console output statements may lead to undesirable results. Some objects will not work in Network Monitor:

  • Wscript object;
  • WshArguments object;
  • WshEnvironment;
  • WshNamed;
  • WshNetwork;
  • WshRemote and WshRemoteError;
  • WshScriptExec
  • WshShell
  • WshSpecialFolders;
  • WshUnnamed;
  • WshUrlShortcut.

Also, avoid functions that display a dialog box, like InputBox.

Using the ActiveXperts VBScript debugger class to troubleshoot

ActiveXperts Network Monitor includes a debug control to print debug information to a log file while the Network Monitor Engine interpreter runs the script. The debug control is called ActiveXperts.VbDebugger.

ActiveXperts.VbDebugger has the following properties:

  • DebugFile - the name of the debug output file. The path of the file must be a valid path. If the file does not exists, the file will be created.

ActiveXperts.VbDebugger has the following functions:

  • ClearDebugFile - this function creates a new, empty debug file. Use it to clear debug output from a previous debug session; The function has no parameters;
  • Write - this function writes a piece of text to the debug file. The functions requires one parameter: the string to write to the file. If you want a newline at the end, you must pass it manually yourself as part of the parameter, or use the WriteLine function;
  • WriteLine - this function writes a piece of text to the debug file, including a newline at the end. The functions requires one parameter: the string to write to the file;
  • Sleep - this function will hold the script for some milliseconds. The function requires one parameter: the number of milliseconds.

The following sample shows how to use the debug control:

Function IsWeekend()
    Set objDebugger = CreateObject( "ActiveXperts.VbDebugger" )
    objDebugger.DebugFile = "c:\temp\debug.txt"
    objDebugger.ClearDebugFile  ' Clear the file is desired
    objDebugger.Write "Function WeekDay will be called now... " & vbCrLf
    If WeekDay( Date() ) = VBSaturday or WeekDay( Date() ) = VBSunday Then
        SYSEXPLANATION = "Yes, weekend"
        IsWeekend = True
    Else
      SYSEXPLANATION = "No, no weekend"
        IsWeekend = False
    End If
    objDebugger.Sleep 3000 ' Hold the script for three seconds
    objDebugger.Write "Exit IsWeekend" & vbCrLf
End Function
Online ActiveXperts VBScript Guidelines

Visit www.activexperts.com/support/network-monitor/online/vbscript/ for detailed information on writing custom VBScript checks. It contains detailed information about writing custom scripts, describes the debugger and contains various samples.

6.4. Windows Command Script

ActiveXperts Network Monitor supports the execution of a command script on the local Windows monitoring server; the result of the Check is based on the standard output.

ActiveXperts Network Monitor requires the output (i.e. StdOut) to be formatted according to the following syntax:

[ SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> will be shown in the 'Last Response' column in the Manager application. The <value> field will be shown in the 'Data' column in the Manager application. Samples:

ERROR: Free Disk space is less than 40 GB DATA:34
SUCCESS: Daemon 'LPD' is running

6.5. Windows Remote Command Script

ActiveXperts Network Monitor supports the execution of a command on a remote server; the result of the Check is based on the standard output.

The check is executed by installing a service on the remote monitored server. This service is called 'ActiveXperts Remote Command Service' (AxRemCmd). After installation, the service is started and is ready for a request from the Network Monitor service. After the command has been executed, the service is uninstalled by the Network Monitor service.

ActiveXperts Network Monitor requires the output (i.e. StdOut) in the same way as the Windows Command Script check.

6.6. SSH (Linux,Unix)

The Secure Shell Script (SSH) check allows you to login to a Linux/Unix host and run a shell script in a secure way. There are two ways to login: using an account and a password, or using an account and a private key file.

ActiveXperts Network Monitor requires the output (i.e. StdOut) to be formatted according to the following syntax:

[SUCCESS | ERROR | UNCERTAIN]: { <explanation> } { DATA:<value>}

The <explanation> field is displayed in the 'Last Response' column in the Manager application. The <value> field is displayed in the 'Data' column in the Manager application.

Samples:

ERROR: Free Disk space is less than 40 GB DATA:34
SUCCESS: Daemon 'LPD' is running

Sample Shell Script to check directory existence:

#!/bin/sh

# Macro definitions
FREE=`free -m | awk '/^Mem:/  { printf( "%s\n", $4 ); }'`
USED=`free -m | awk '/^Mem:/  { printf( "%s\n", $3 ); }'`

# Validate number of arguments
if [ $# -ne 2 ] ; then
    echo "UNCERTAIN: Too few arguments Usage: memory <free>|<usage> <size>";
    exit 1;
fi

# Validate arguments
if [ $1 != "free" ] && [ $1 != "used" ]; then
   echo "ERROR: Wrong parameters entered  DATA:0";
fi

# Check free memory
if [ $1 == "free" ] ; then
   if [ $FREE -gt $2 ]||[ $FREE == $2 ] ; then
      echo "SUCCESS: Free memory is [$FREE MB], minimum required=[$2 MB] DATA:$FREE";
   else
      echo "ERROR: Free memory is [$FREE MB], minimum required=[$2 MB] DATA:$FREE";
   fi  
fi  

# Check used memory
if [ $1 == "used" ] ; then
   if [ $USED -lt $2 ]||[ $USED == $2 ] ; then
      echo "SUCCESS: Used memory is [$FREE MB], maximum allowed=[$2 MB] DATA:$FREE";
   else
      echo "ERROR: Used memory is [$FREE MB], maximum allowed=[$2 MB] DATA:$FREE";
   fi  
fi

ActiveXperts Network Monitor installs a collection of SSH monitoring checks. In a default installation, it is located in folder:
C:\ProgramData\ActiveXperts\Network Monitor\Scripts\Monitor (ssh)

7. Alert Notifications

7.1. Introduction

Alert Notifications are sent:

  • When a Check fails - After a configurable number of warnings (warning threshold) in a row, the check fails. By default, only one alert notification (e.g. one e-mail and one SMS) is sent after a failure; if you want to be notified regularly after a failure, it can be configured by pressing the Advanced button in the Monitoring Check Properties tab;
  • When a Check recovers from the 'Failure' status - ActiveXperts Network Monitor has the ability to repair, for instance by running a custom script. It can be useful to send an alert to notify that the previous problem has been solved.

Notification Settings are software settings that are global for all monitoring checks. You can configure these from the Tools menu, by selecting the Notification Settings item.

For all notification types - except pager notifications and SNMP traps - you can use an Address Book. In the Address Book, you can organize notification recipients in groups. Groups can be used in any check. But you can still define a custom list of recipients for individual checks.

The following alert notification types are supported by ActiveXperts Network Monitor:

  • E-mail alert notifications;
  • SMS Text alert notifications;
  • WhatsApp alert notifications;
  • Numeric Pager alert notifications;
  • Alpha-numeric Pager alert notifications;
  • SNMP Trap alert notifications;
  • Network alert notifications.
Default Alert Notification settings for new Monitoring Checks

Default Alert Notification settings apply to new Monitoring Checks. These values can be defined in the Notifications Settings dialog:

  • On the Tools menu, click Notification Settings;
  • Select the Default Alerts tab.

The following Alert Nootification defaults can be configured:

  • E-mail notification when check fails - this value indicates whether an e-mail notification should be sent when a check fails;
  • Email notification when check recovers from failure - this value indicates whether an e-mail notification should be sent when a check is successful after a failure;
  • SMS notification when check fails - this value indicates whether an SMS notification should be sent when a check fails;
  • SMS notification when check recovers from failure - this value indicates whether an SMS notification should be sent when a check is successful after a failure;
  • WhatsApp notification when check fails - this value indicates whether an WhatsApp notification should be sent when a check fails;
  • WhatsApp notification when check recovers from failure - this value indicates whether an WhatsApp notification should be sent when a check is successful after a failure;
  • Pager notification when check fails - this value indicates whether a Pager notification should be sent when a check fails;
  • Pager notification when check recovers from failure - this value indicates whether a Pager notification should be sent when a check is successful after a failure;
  • SNMP Trap notification when check fails - this value indicates whether an SNMP Trap notification should be sent when a check fails;
  • SNMP Trap notification when check recovers from failure - this value indicates whether an SNMP Trap notification should be sent when a check is successful after a failure;
  • Network notification when check fails - this value indicates whether a network notification should be sent when a check fails;
  • Network notification when check recovers from failure - this value indicates whether a network notification should be sent when a check is successful after a failure;
  • Notification Frequency Defaults - specifies how often a notification (e-mail, SMS and so on) should be sent after a failure. By default, a notification is sent only once after failure; however, you can configure to notify every x minutes after failure;

7.2. Address Book

The Address Book contains all Contacts and Contact Groups used to send out Alert Notifications when there's an incident.

A Contact has properties like 'First Name', 'Last Name', 'E-mail Address' and 'SMS Mobile Number'.
You can group one or more Contacts in one or more Contact Groups.

At a Check level, you can assign Contact Groups and/or Contacts to the Alert Notification properties of the Check. The Contact Addresses will be used to send out the Notifications.

The Address Book is also used by the Reports module, where Reports are scheduled and sent as e-mail attachments to those who want to receive the Reports.

NOTE: It is recommended to assign Contact Groups rather than individual Contacts to the Check's Alert Notification properties. With a Contact Groups, you don't need to change the Check's properties when there's a new User.. You just need to modify the Contact Group membership list one time.

7.3. E-mail Alert Notifications

To use SMTP e-mail notifications, the ActiveXperts Network Monitor Engine service must have access to a (secure) SMTP server to send out e-mails. It can be any SMTP (secure) compliant mail server.

ActiveXperts Network Monitor supports the SSL/TLS secure protocol, as well as STARTTLS, is compliant with SMTP servers that require SMTP authentication, like Microsoft Exchange. SMTP AUTH is the protocol that is used to verify that you are one of the users of the SMTP server. ActiveXperts Network Monitor is RFC 821 and RFC 822 SMTP AUTH compliant. It also supports multiple character sets, including English (ISO-8859-1), Chinese (big5) and Japanese (ISO-2202-JP).

E-mail Notification Global Settings

To configure global e-mail Alert Notification Settings use the 'ActiveXperts Network Monitor Manager':

  • On the Tools menu, click Notification Setup and select the E-mail tab;
  • Enable the Enable E-mail Alert Notifications checkbox to enable e-mail notifications;
  • The SMTP Server can be an IP address (like 10.0.0.1), a host name (like mail.mydomain.com) or a NetBIOS name (like EXCHANGE01); this is the server that will send out the actual notification messages to the recipients;
  • If your SMTP server is a secure server, select the Security Protocol;
  • If your SMTP server requires authentication, click the Authentication checkbox and provide a logon and password;
  • Provide Sender E-mail Address (required) and Sender's Display Name (optional). The recipient will see this name/address as the sender, and all replies will be delivered to this mail account;
  • Use the E-mail Address Book to organize e-mail recipients in groups. The Address Book can be used for all checks. The E-mail Address Book makes configuration easier, because you don't have to configure a separate list of recipients for each monitoring check; however, it is still possible to configure a separate list of recipient for any check;
  • Click on Format Message to edit the e-mail template and to enable/disable RTF (HTML) formatting. In this dialog, you can also set the preferred character set: English (ISO-8859-1), Chinese (big5) or Japanese (ISO-2202-JP). Enable RTF (HTML) formatting to support HTML tags. If you switch on RTF formatting, you must use the <br> tag (or an alternative tag) to insert new lines.
  • Click on Secondary Server to specify a fallback server. The secondary server is only used if the primary SMTP mail server is down while attempting to send out an SMTP notification.

To test the E-mail Notification Settings, use the Test SMTP Server button. It will send a request the Network Monitor Engine to send an E-mail message using the given settings.

Message Templates are discussed in topic Message Templates.

Note: Be aware of e-mail clients that do not have Rich Text enabled for security reasons.

E-mail Notification Check Settings

For each check, you can make the following configuration settings:

  • Notify when check fails - when the check is set to 'Failure', a message is being sent. Default: On;
  • Notify when a check recovers from a failed status - when the check turns from 'Failure' to 'Success', a message is being sent. Default: Off;
  • For both 'Success' and 'Failure' status changes, you use the Address Book recipient groups, or use a custom recipient list.
  • For both 'Success' and 'Failure' status changes, you use the Address Book recipient groups, or use a custom recipient list.

7.4. SMS Alert Notifications

ActiveXperts Network Monitor supports alpha-numeric SMS messaging in four ways:

  • Using Twilio, a communications platform as a service (CPaaS). Requires a Twilio subscription or demo account;
  • Using GSM Modem (or GSM phone), connected to the Network Monitor server by serial cable or IP connection;
  • Using SMSC HTTP protocol. Requires a subscription with an SMSC provider providing the HTTP(s) protocol for sending;
  • Using SMSC SMPP service provider. This requires Auron SMS Server on one of your network computers (or on the same machine as ActiveXperts Network Monitor).
SMS Notification Settings Global Settings

To configure global SMS Alert Notification settings:

  • On the Tools menu, click Notification Setup and select the SMS tab;
  • Enable the Enable SMS Alert Notifications checkbox to enable SMS notifications;
  • Make a choise: through Twilio, a GSM Modem, through an SMS/HTTP provider or through Auron SMS Server;
  • Click on the Format Message button to edit the SMS template. Message Templates are discussed in Chapter 3.15: "Message Templates".
SMS Notification Global Twilio Settings

Get yourself a Twilio subscription first. This can be either a paid subscription, or a free Twilio test account. For more information, see: www.twilio.com/try-twilio

Use your Twilio account information to fill in:

  • Twillio Account SID - your Twilio account login
  • Twillio AUTH Token - your Twilio password
  • Your Twilio Phone Number - the mobile number assigned to you, used for all SMS messages
SMS Notification Global GSM Modem Settings

In the GSM Modem setup dialog, you must select the Windows telephony device (recommended) or a physical COM port (directly) that is used to connect to the physical GSM modem. As soon as you select the device from the list, the Network Monitor Manager tries to detect the device connected to the Network Monitor server. If a GSM modem cannot be detected, a log file is provided for troubleshooting purposes.

Use the Advanced Settings button to configure advanced communication settings.

SMS Notification Global SMS Server Settings

Auron SMS Server is an SMS messaging framework to enable sending, receiving and processing of SMS messages. You can relay SMS notifications from any application (including Network Monitor) to the SMS Server.

With Auron SMS Server, you can benefit from the product's SMPP support. SMPP is the fastest and most reliable way of sending bulk SMS messages.

To relay Network Monitor SMS notifications to Auron SMS Server, you must install the Auron SMS Server Client Tools on the server that has the Network Monitor Engine service running. Once installed, you can select an SMPP channel.

SMS Recipient Number

The SMS recipient number must be in International Number Format: the SMS number, prefixed by the international dialing number and the '+' character. The use of the '+' character is required. For example: +4412345678

SMS Notifications Check Settings

For each check, you can make the following configuration settings:

  • Notify when check fails - when the check is set to 'Failure', a message is being sent. Default: On;
  • Notify when a check recovers from a failed status - when the check turns from 'Failure' to 'Success', a message is being sent. Default: Off;
  • For both 'Success' and 'Failure' status changes, you use the Address Book recipient groups, or use a custom recipient list.

Note: To log all modem operations, you must enter a valid file name in the following registry entry:
HKLM\Software\ActiveXperts\Network Monitor\Server\Trace\NotifySms

7.5. Pager Alert Notifications

ActiveXperts Network Monitor supports numeric DTMF Paging (using a Hayes compatible modem) and alpha-numeric paging (using an SNPP provider).

The modem must be connected to the server where the 'ActiveXperts Network Monitor Engine' service is running. When there's a failure, ActiveXperts Network Monitor will use the modem to dial-out to the Pager recipients.

Pager Notification Global Settings

To configure global Pager Alert Notification settings:

  • On the Tools menu, click Notification Setup and select the Pager tab;
  • Enable the Enable Pager Alert Notifications checkbox to enable pager notifications;
  • Choose Use alpha-numeric paging to send alpha-numeric pager messages using an SNPP provider, or choose Use numeric DTMF paging to send numeric DTMF pager messages using a standard Hayes compatible modem.
Pager Notification Global Settings - alpha-numeric SNPP paging

In the Pager/SNPP setting dialog:

  • Enter the Host (host name or IP address) of your SNPP paging provider. Enter the IP port used to connect to your SNPP provider (default: 444);
  • If your SNPP provider requires a password, enable the Password required option and provide a valid password.
  • In the Time-out field, enter the time-out (in millisecond) used to connect to the SNPP provider.
Pager Notification Global Settings - numeric DTMF paging

In the Pager/DTMF setting dialog:

  • Select a Modem from the list. The list is inherited from the list of Telephone Devices of the operating system (configured in the Control Panel on the system where the Network Monitor Engine is installed). If there is no modem driver installed for your device, you can also select a direct com port. Use the Test Pager Settings button to test the configuration;

Note: A Pager recipient can only consist of the following characters:
T0,1,2,3,4,5,6,7,8,9,+,-,*,#@,a,b,c,d,A,B,C,D,w,WT

Pager Notification Check Settings

For each check, you can make the following configuration settings:

  • Notify when check fails - when the check is set to Failure, a message is being sent. Default: On;
  • Notify when a check recovers from a failed status - when the check turns from 'Failure' to 'Success', a message is being sent. Default: Off;
  • For both Success and Failure status changes, you use the Address Book recipient groups, or use a custom recipient list.

Note: To log all Pager operations, you can enter a valid file name in the following registry entry:
HKLM\Software\ActiveXperts\Network Monitor\NotifyPager

7.6. SNMP Trap Alert Notifications

ActiveXperts Network Monitor supports SNMPv1, SNMPv2c and SNMPv3 Trap notifications.

SNMP Trap Notification Global Settings

To configure global SNMP Trap notification settings:

  • On the Tools menu, click Notification Setup and select the SNMP Traps tab;
  • You can now configure a list of SNMP Traps. Usually, you will need just one trap to send out to a network management station, but you can define multiple traps. Press the Add Trap button to add a trap to the list; press the Edit Trap button to edit the parameters of a specific trap, and press the Remove Trap button to remove a trap from the list.
  • When you use the Add Trap button or the Edit Trap button, you can configure the parameters of a single trap. These parameters are described below.
SNMP Trap Parameters

A trap consists of the following parameters:

  • Agent - the host name or IP address of the (remote) SNMP network management station;
  • Port - the port used for sending SNMP traps; default: 162;
  • Community - the community of SNMP devices. Default: public;
  • Protocol Version - Select either SNMPv1, SNMPv2c or SNMPv3. Default: SNMP v2c;
  • SNMPv3 authentication - enter SNMPv3 login parameters to be used with SNMPv3 traps;
  • OID - the Object Identifier; Network Monitor accepts numeric and alpha-numeric OID's, for instance: system.sysName.0, or 1.3.6.1.2.1.1.5.0;
  • OID Data Type - this field indicates the type of data that is sent to the (remote) network management station. Network Monitor supports the following data types: strings, integers, IP addresses, time ticks, counter types, OID's and some other, less frequently used types;
  • OID Value - the actual value that is sent over the network. You can include notification variables, like <%DISPLAYNAME%> , <%TIME%>, or <%HOST%>. For a complete list of notification variables, see also Appx E. Notification Variables;
  • Generic Trap - this optional field is only used with SNMP v1.
SNMP Trap Notifications Check Settings

For each monitoring check, you can configure the following settings:

  • Notify when check fails - when the check fails, a message is being sent. Default: On;
  • Notify when check recovers from a failed status - when the check reverts to 'success', a message is being sent. Default: Off;
  • For both Online and Offline status changes, you can choose to use Global SNMP Trap List as defined in the Global SNMP Trap Notification Settings, or use a Custom SNMP Trap List.

7.7. Network Alert Notifications

Network Notifications are the well-known 'Net Send' (or 'NetPopup') messages over the network. Only machines that support NetBIOS can send/receive these messages. NetBIOS messages can be sent to users and/or computers.

Network Notification Global Settings

To configure global Network Alert Notification settings:

  • On the Tools menu, click Notification Setup and select the Network Popup tab;
  • Enable the Enable Network Popup Notifications checkbox to enable network notifications;
  • Use the Network Popup Address Book to organize NETBIOS recipients in groups. The Address Book can be used for all checks. The Address Book makes configuration easier, because you don't have to configure a separate list of recipients for each monitoring check; however, it is still possible to configure a separate list of recipient for any check;
  • Click on Format Message to edit the network message template. Message Templates are discussed in Chapter 3.15: "Message Templates".

To test the Network Notification Settings, use the Send Test Message button. It will send a request the Network Monitor Engine to send an network popup message using the given settings.

Network Notifications Check Settings

For each check, you can make the following configuration settings:

  • Notify when check fails - when the check is set to Failure, a message is being sent. Default: On;
  • Notify when a check recovers from a failed status - when the check turns from 'Failure' to 'Success', a message is being sent. Default: Off;

7.8. Message Templates

A notification message can be customized. Use the Format Message button in the appropriate global notification tab of the Notification Setup dialog from the Tools menu. Each notification type has its own message template.

Inside a message template, you can use system variables. These variables are substituted each time the message is sent out. System variables must be enclosed between <% and %> strings, for example: <% DATE %>. See also Appx E. Notification Variables for a complete list of Notification Variables.

Message Template Example

Example of a message template:

Message from ActiveXperts Network Monitor, <% DATE %> <%TIME %>:
Item:    <% DISPLAYNAME %>
Result:  <% RESULT %>
Explanation:<% EXPLANATION %> 

Note: Using newlines in SMS Message Templates is NOT recommended. Many GSM phones don't know how to handle newlines and will display bad characters.

7.9. Dependencies

Dependencies allow you to create a hierarchy of checks that depend on each other. This hierarchy is not related to the Folder structure of your Network Monitor configuration. Dependencies prevent you and your network administrators from being overwhelmed with notifications when a central router or server goes down. Without a dependency configuration, the failure of a central server or device would cause a failure of other servers, and as a result many notifications would be sent out. There are at least two items involved when configuring dependencies:

  • Dependee - the computer/device that plays a central role. A failure of this 'Dependee' device or server would cause failures of other servers and devices (so called 'Dependers');
  • Depender(s) - servers, devices or folders that depend on the 'Dependee'.

A dependee cannot be a folder, only a check. You can make other checks and/or folders dependent on the Dependee. It is recommended to use Folders rather than Checks as a Depender, because it is dynamic.

For more information about Dependencies, visit the Online Dependency Guidelines on the ActiveXperts web site. It contains a good sample and some best practice hints.

8. Web Access

8.1. Introduction

ActiveXperts Web Access is a comprehensive web interface, designed for mobile devices, tablets and PC's. It allows users you to see those parts of the Network Monitor configuration that they have access to.

ActiveXperts Web Access requires the Web Server (IIS) server role to be installed on the Windows Operating System running ActiveXperts.

ActiveXperts Web Access has a mobile first, responsive design and can be viewed by any browser, on any (touchscreen) mobile device, tablet or PC, running iOS, Anndroid or Windows.

Each ActiveXperts Network Monitor Folder can be published in ActiveXperts Web Access, each one having its own credentials. A Folder can have one or more so called 'Filters', so users can filter on different aspects, for instance displaying only Failure results, or displaying only VMware and Citrix checks, or combined. You can even draw Graphs on your (mobile) device, to see the history of a Check.

ActiveXperts Web Access uses jQuery on the (mobile) device to fetch the information live from the ActiveXperts database.

For each check displayed in ActiveXperts Web Access, there's a small icon that you can press to plot a Graph. This requires Classic ASP to be installed.

Up to ActiveXperts Network Monitor v.2017, Web Access had a not responsive design without underlying jQuery technology. XML pages were generated every 30 secs (by default), and were made-up by XSL templates. The drawback was a less responsive web interface, but it had a large flexibily in terms of customization. This flexibility is still popular amongst the customers. For that reason, the XML/XSL based interface is still available but disabled by default. To read more on the v.2017 XML/XSL web interface, click here.

8.2. Web Server (IIS)

To use ActiveXperts Web Access, Microsoft 'Web Server (IIS)' role must be installed on the server hosting ActiveXperts. Using the ActiveXperts Web Access Configuration tool is the best and easiest way to install/configure Web Server (IIS). It makes sure all necessary components are installed. If the 'Web Server (IIS)' role is already installed but some features are missing, the 'ActiveXperts Web Access Configuration' will (re)install/(re)configure the features:

  • Start the ActiveXperts Web Access Configuration Tool from the Manager;
  • Select the Publish to IIS tab;
  • Press the Install/Configure Web Server (IIS) now... button. It will launch a Powershell script to install/configure 'Web Server (IIS)'.
    It is no problem to run the Powershell script multiple times; it will only take action if it is required.

But you can also use the Windows 'Server Manager' to install/configure the 'Web Server (IIS)' role.
NOTE: If you use Server Manager instead to install/configure 'Web Server (IIS)', make sure you install the 'Application Development' feature and select 'classic' ASP. Classic ASP is required to run Graphs in a web browser.

After the 'Web Server (IIS)' role is installed, configured and running, you need to host the ActiveXperts Web Access web site on IIS:

  1. Automatically, using the ActiveXperts Web Access Configuration tool;
  2. Manually, using Windows' Internet Information Services (IIS) Manager.
Publish Web Site using ActiveXperts Web Access Configuration Tool

ActiveXperts Web Access needs a web site in Microsoft Web Server (IIS). The easiest is to use the 'ActiveXperts Web Access Configuration' tool.

To create a new site using the 'ActiveXperts Web Access Configuration' tool:

  • Start the ActiveXperts Web Access Configuration Tool from the Manager;
  • Select the Publish to IIS tab;
  • Press the Publish to IIS... button;
  • Fill in the required fields and press the Publish button.
Publish Web Site using IIS Manager

To create a new site using the microsoft 'Internet Information Services (IIS) Manager' tool:

  1. Launch the Internet Information Services (IIS) Manager from the Windows Administrative Tools group;
  2. In the left column you will see the machine name, expand local machine and right click on Sites then open Add new Web Sites;
  3. Fill all the necessary details which is as below:
    - Site Name; Name of Site, e.g. ActiveXperts Web Access
    - Physical path; Default: C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\
    - Type; Type of Web site. Default: https
    - IP Address; IP Address of the site.
    - Port; Port number on which site will run.
    - Host name; Domain name of site.

8.3. Web Access Sample

The following sample shows the basics of ActiveXperts Web Access:

ActiveXperts Network Monitor is used by company Northwind Traders Ltd. to monitor all internal servers and devices. The domain is named 'northwind.intra' and is divided into two sub-domains:
- Domain: 'usa.northwindtraders.intra'
- Domain: 'emea.northwindtraders.intra'

There's the following Folder structure configured in Network Monitor:

Entire Network
  |-- usa.northwindtraders.intra (folder-id #1)
        |-- system administration (folder-id #1000)
        |-- production (folder-id #1001)
        |-- webservers (folder-id #1002)
        |-- vmware (folder-id #1003)
  |-- emea.northwindtraders.intra
        |-- sales (folder-id #2001))
        |-- support (folder-id #2002))

The first step is, to publish ActiveXperts Web Access through Microsoft Information Services (IIS).
The root of the Folder to be published is C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\ (default).

Use the ActiveXperts Web Access Configuration program to publish the above. In this sample, it is published as:
https://webaccess.northwindtraders.intra:8080

A port is opened on the firewall with NAT translation, to make Web Access available from the ublic Internet through the following URL:
https://webaccess.northwindtraders.com

In this configuration, we define the following Views:

View: ALL

  • Displays: all servers of northwindtraders.intra (so both 'usa' and 'emea')
  • Accessible through: https://webaccess.northwindtraders.com/1/
  • Selectable Filters: All Results - Failed Only - ICMP Only

View: System Administration

  • Displays: all servers in folder 'system administration'
  • Accessible through: https://webaccess.northwindtraders.com/1000/
  • Selectable Filters: All Results - Failed Only - Active Directory, DNS, DHCP only - Disk Space only
  • View: Production

  • Displays: all servers in folder 'production'
  • Accessible through: https://webaccess.northwindtraders.com/1001/
  • Selectable Filters: All Results - Failed Only - MS SharePoint and MS Dynamics Only
  • View: Support

  • Displays: all servers in folder 'support'
  • Accessible through: https://webaccess.northwindtraders.com/1002/
  • Selectable Filters: All Results - Failed Only - Helpdesk system only
  • Index page

  • Displays: an index of all of the above views
  • Accessible through: https://webaccess.northwindtraders.com/
  • Permissions

    In this samples, there are the following Active Directory groups:

    • northwindtraders.intra\Administrators
    • northwindtraders.intra\Production
    • northwindtraders.intra\Support

    Members from the 'Production' should not have access to monitoring results other than https://webaccess.northwindtraders.com/1001/. To achieve this, the following permssions are defined for C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\1001\:

    • northwindtraders.intra\Administrators: Full Control
    • northwindtraders.intra\Production: Read+Execute

    Members from the 'Support' should not have access to monitoring results other than https://webaccess.northwindtraders.com/1002/. To achieve this, the following permssions are defined for C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\1002\:

    • northwindtraders.intra\Administrators: Full Control
    • northwindtraders.intra\Support: Read+Execute

    8.4. Web Access Data Files

    ActiveXperts Network Monitor stores its monitoring results in XML files, which are accessed by the (mobile) web clients. For each filter in a web view, an XML data file is written. In the sample configuration of the previous section, the data files (with default filters) would be like this:

    Entire Network
          \WebRoot\1\all.xml
          \WebRoot\1\failed.xml
          \WebRoot\1000\all.xml
          \WebRoot\1000\failed.xml
          \WebRoot\1001\all.xml
          \WebRoot\1001\failed.xml
          etc.

    If you define a new filter, for instance filter'ICMP' on Folder #1001, the XML data files in folder #1001 would look like this:

    Entire Network
          \WebRoot\1001\all.xml
          \WebRoot\1001\failed.xml
          \WebRoot\1001\icmp.xml
          etc.

    An XML data file looks like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <monitor>
      <webview-name>Entire Network View</webview-name>
      <webview-description>All Checks</webview-description>
      <refreshtime>04/09/2020 08:14:53 AM</refreshtime>
      <check>
        <id>10001</id>
        <displayname>www.monitortools.com - Ping (ICMP)</displayname>
        <host>www.monitortools.com</host>
        <folder>\</folder>
        ...
      </check>  
      <check>
        <id>10001</id>  
        ...
      </check> 
    </monitor>
    

    The web clients access the XML data files using qQuery and Ajax to show the results in the web browser.

    8.5. Web Views

    A Web View is an ActiveXperts Web Access Page with the following properties:

    • It represents one Folder in the Network Monitor configuration;
    • It is accessible through the following URL: http://web-access-root/folder-id/, for instance: http://axnetworkmonitor/1/
    • It has one or more so called Filters. By default, filters All Results and Failed Results are defined, but you can have many Filters, to filter Results and/or Check Types;
    • A Web View has permission properties, defined by the NTFS Folder permissions;
    • A Web View is optionally listed in the root: http://web-access-root/, for instance: http://axnetworkmonitor/
    • A Web View is visible by any mobile (touch) device or PC.
    Create a New View

    To Create a new View:

    • Start the ActiveXperts Web Access Configuration Tool from the Manager.
      To do so, Open Web Access from the Tools menu and select Web Access Configuration....
    • Press the Add View button. All web sites on the selected IIS server will be listed;
    • Select a Folder from the Folder Selection box;
    • The Default Filters will be applied. You can define additional Filters by clicking the Add View button.
    Configure a View

    To Configure a new View:

    • Start the ActiveXperts Web Access Configuration Tool from the Manager;
    • Select the View and press the Configure View button.

    8.6. Web View Access Control

    Controlling access to your ActiveXperts Web Views is crucial for hosting ActiveXperts Web Access. With Windows and the security features in IIS, you can effectively control how users access your Web Views, granting/denying access to particular Views.

    For example, enabling Anonymous access for all pages of ActiveXperts Web Access will allow any users to see what's happening on the Network. In most cases this is not acceptable.

    How Access Control Works

    You can control user access to your Web server content by properly configuring your Windows file system and Web server security features. When a user attempts to access your Web server, the server carries out several access control processes to identify the user and determine the allowed level of access.

    The following is an outline of the process:

    • The client requests a Web View on the IIS server;
    • The IIS server, if configured to require it, will request authentication information from the client.
    • The browser may either prompt the user for a user name and password, or offer this information automatically;
    • IIS checks if the user has a valid Windows user account. If the user does not, then the request fails, and the user gets a "403 Access Forbidden" message;
    • IIS checks if the user has Web permissions for the requested Web View. If the user does not, then the request fails, and the user gets a "403 Access Forbidden" message.
    How to configure Access Control

    Internet Information Services relies on NTFS permissions for securing individual files and directories from unauthorized access. You can use NTFS permissions to precisely define which users can access your content and how those users are allowed to manipulate that content.

    ActiveXperts recommends the following NTFS permissions on the root of the Web Access folder and all sub folders. This is by default: C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\).

    • SYSTEM: Full Control
    • AXSERVER\Administrators: Full Control
    • AXSERVER\Users: Read
    • AXSERVER\Guests: No Access

    To prevents users from preventing access to specific Folder except one group, set the following permissions on that Folder:

    • SYSTEM: Full Control
    • AXSERVER\Administrators: Full Control
    • AXSERVER\GROUP: Read

    For instance yo prevents users from preventing access to Folder 1005 except group Support, set the following permissions on folder C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\1005\:

    • SYSTEM: Full Control
    • AXSERVER\Administrators: Full Control
    • AXSERVER\Support: Read

    8.7. Web View Refresh Rate

    Client Browser Refresh Interval

    Client devices refresh their Views in order to update data provided by the ActiveXperts Network Monitor Engine service. For each View, you can configure the Client Browser Refresh Interval (seconds). The default is set to 10 seconds.

    If there are many check in a Folder, or if Check intervals are configured execute only once an hour or so, a user may prefer to have the frequency less frequent. Imagine a user is monitoring a Folder with only Temperature checks; updating once every 2 minutes would suffice.

    Server Refresh Interval

    The ActiveXperts Network Monitor Engine service provides data for Client devices. This is done once every 10 seconds by default. This value can be changed. Having a lower freqeuncy rate will offload the Engine's CPU and Disk activity.

    A confugration with only Ping checks may need a more frequent interval rate (e.g. once every 5 seconds) because usually, Ping checks run at a frequent rate producing different Ping reply times.

    On the other hand, confugration with only Temperature checks may need a less frequent interval rate (e.g. once every 5 minutes) .

    8.8. Customizing Web Access

    Introduction

    The web interface displays information about the status of your network servers and devices. You can tailor the visual design of these pages to make them fit into the look and feel of your internet or intranet site. Customization requires basic HTML and CSS knowledge.

    The design of the web interface is controlled via HTML files and CSS files. The majority of the HTML and CSS code is implemented in the following files:

    • WebRoot\index.html - the Web Access index page
    • WebRoot\libs\activexperts\style.css - almost all styling code
    • WebRoot\<FOLDER_ID>\list.html - List View markup file
    • WebRoot\<FOLDER_ID>\map.html - Map View markup file

    Please beware of the following:

    • WebRoot\index.html is rewritten every few seconds or minutes (configurable), because it lists the Web Views. New Web Views can be created, others can be deleted, so the list is dynamic
    • WebRoot\<FOLDER_ID>\List.html and WebRoot\<FOLDER_ID>\map.html have duplicates in ALL Web View Folders.

    After you have finished customization, the modified code must be copied to the _installer folder: C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\_installer\
    The 'Installer Folder' is further explained in the next topic. At the end of the section, there is a step-by-step customization guide.

    Installer Folder

    ActiveXperts Web Access uses an 'Installer Folder'. After you've finished implementing and testing your modifications, you must copy the modified files to the 'Installer Folder':
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\_installer\
    After that, you must delete all Files and Folders in C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\ folder EXCEPT the _installer folder. The Engine will then regenerate all files and folders.
    This is explained later on in this section in the 'step-by-step' guide.

    If you have made a mistake in the _installer, and you want revert to the original one, all you need to do is deleting the following folder:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\
    The Engine will then copy its original WebRoot folder from the C:\Program Files\ActiveXperts\Network Monitor\Sys\Tpl\ folder.

    The following folders in the _installer folder are relevant for customization:

    • folder - this folder contains the List-view list.html file and Heatmap map.html file used in all Web Views (except for Graphs);
    • folder.graphs - this folder contains the Active Server Pages (.asp) files required by the Engine to prepare the Graphs;
    • index - this Folder contains the 3 possible index files used in the root of Web Access:
      * index-webviewsdisabled.html - index page when Web Access is disabled
      * index-webviewsvcnotrunning.html - index page when Web Access is enabled but the ActiveXperts service is not running
      * index-webviewsenabled.html - index page when Web Access is enabled and running. There's a special placeholder named $LISTSECTION that wil be replaced by the actual index information.
    • libs - this Folder contains a collection of Javascript and CSS files. Most important for customization is the libs\activexperts\css\style.css file, which contains styling definitions for all pages;
    • libs.xsl - this Folder contains all mark-up files to support the v2017 (XSL/XML) compatible web views..
    Customizing Web Access Step-by-Step

    Use the following steps to customize ActiveXperts Web Access:

    Step 1: Modify MAP.HTML and LIST.HTML

    It is important to understand that map.html and list.html have copies in all folders. For that, we are going to modify map.html and list.html in ONE folder and copy these to the installer folder after all customizations have completed.

    • Select a single Web View folder, preferably the Web View with Folder ID '1':
      C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\1\
    • Edit the map.html and list.html files in the copied folder using your favorite HTML editor:
      You can test using your browser, by using a URL like this:
      https://hostname/1/list.html
      https://hostname/1/map.html
    • After completion, copy the modified files to the following folder:
      C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\_installer\folder\

    Step 2: Modify the CSS file

    All styles are implemented in the following file:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\libs\activexperts\css\style.css
    Make changes to this file and test from your browser. After completion, copy the file to the following folder:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\_installer\libs\activexperts\css\

    NOTE: A change to style.css may require a deletion of your browser cache before testing.

    Step 3: Modify the JS (Javascript) files

    All Javascript functions are implemented in the following folder:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\libs\activexperts\js\
    Make changes to the file(s) and test from your browser. After completion, copy the file(s) to the following folder:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\_installer\libs\activexperts\js\

    NOTE: A change to any Javascript file may require a deletion of your browser cache before testing.

    Step 4: Modify the INDEX files

    There are three different index files:
    index-webviewsdisabled.html, index-webviewsvcnotrunning.html and index-webviewsenabled.html
    All three are described in the 'Installer Folder' topic in this section.

    You can find these three files in folder:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\_installer\
    Only one of these files is copy to the root of Web Access by the engine and is accessible by the browser using URL:
    https://hostname/index.html

    Modify and test all three directly in the _installer folder.

    Step 5: Let the Engine recreate all Files and Folders from the 'Installer Folder'

    Now that you completed all customizations, let the ActiveXperts Network Monitor Engine service regenerate all Files and Folders from the _installer folder. This is a simple but very important step:

    Delete all Files and Folders in C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\
    EXCEPT the _installer folder.

    In a few seconds, all Files and Folders will be regenerated by the Engine service.

    Customizing Web Access - A sample how to add a field to the List View

    In this section, we will add the 'comments' field to the Web Access List View. The 'comments' field is displayed in the Manager, but it not shown by default in Web Access.

    Step 1: LIST.HTML

    Adding a single field does not require a change in list.html, so we skip this step.

    Step 2: Modify the CSS file

    #aidBodyList #aidDivData .aclDataRow .aclRowPrimary span:nth-child(7) {
      padding-left: 15px;
      padding-bottom: 5px;
      -ms-grid-column: 1;
      -ms-grid-row: 6;
      grid-row: 6;
      grid-column: 1/3;
    }

    Step 3: Modify AXCORE.JS and AXLISTVIEW.JS Javascript files

    Open the following file:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\libs\activexperts\js\axcore.js
    and add the following line in the ajxParseMonitoringData function:

    items.push({
      id:  parseInt($(value).find('id').text()),
      class:  strStatusClass,
      valDisplName:  $(value).find('displayname').text(),
      valDisplNameshort:  $(value).find('displayname-short').text(),			
      valHost:  $(value).find('host').text(),
      valHostshort:  $(value).find('host-short').text(),
      valType:  $(value).find('type').text(),
      valTypeshort:  $(value).find('type-short').text(),
      valResultOrder:  $(value).find('result-sortorder').text (),
      valData:  $(value).find('data').text(),
      valLastMon:  $(value).find('update').text(),
      valLastMonSecs:  $(value).find('update-secs').text(),
      valLastMonshort:  $(value).find('update-short').text(),
      valLastResponse:  $(value).find('explanation').text(),
      valComments:	$(value).find('comments').text()
      });

    Open the following file:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\libs\activexperts\js\axlistview.js
    and add the following line in the drawMonitoringData function:

    datalist
      .append($("
    ", { class: "aclDataRow " + item.class, "id" : item.id, "data-datdisplname": item.valDisplName, "data-datdisplnameshort": item.valDisplNameshort, "data-dathost": item.valHost, "data-dathostshort": item.valHostshort, "data-dattype": item.valType, "data-dattypeshort": item.valTypeshort, "data-datdata": item.valData, "data-datlastmon": item.valLastMon, "data-datlastmonshort": item.valLastMonshort, "data-datlastresponse": item.valLastResponse, "data-datcomments": item.valComments, click: clickEvent }) .append($("
    ", { class: "aclRowPrimary" }) .append($("
    ", { class: "aclRowIndicator" })) .append($("", { text: item.valDisplNameshort + " (#" +item.id + ")" })) .append($("", { text: "Host: "+ item.valHost })) .append($("", { text: item.valTypeshort + " - Value: " +item.valData })) .append($("", { class: "aclRowLastupdate", text: "Last Update: "+item.valLastMon })) .append($("", { class: "aclRowExplanation", text: item.valLastResponse })) .append($("", { text: "Comments: "+ item.valComments })) ) );

    Step 4: INDEX.HTML

    Adding a single field does not require a change inone of the index files, so we skip this step.

    Step 5: Let the Engine recreate all Files and Folders from the 'Installer Folder'

    Now that you completed and tested all customizations, copy the modifed files in step 2 and step 3 manually to the _installer folder, and let the ActiveXperts Network Monitor Engine service regenerate all Files and Folders from the _installer folder. This is a simple but very important step:

    Delete all Files and Folders in C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\
    EXCEPT the _installer folder.

    In a few seconds, all Files and Folders will be regenerated by the Engine service.

    8.9. Web Access v2017 (XSL-XML)

    As mentioned in the previous section, the client web browser uses jQuery and Ajax to access the XML monitoring data and display it in a nice way on the (mobile) device. This is not way it used to be in ActiveXperts Network Monitor v.2017 and older. Those version used an XSL layer on the XSL data files to make-up the web pages. The XSL stylesheet was included in the first line of the XML data. Almost all browsers available today are able to display XML data files formatted by an XSL template.

    This technique is still popular amongst the ActiveXperts customers, as it offer huge flexibilty on customizing the web interface, and therefore it is still offered by current ActiveXperts versions. By default, the XSL formatting is disabled, but can enabled easily:

    • Launch the ActiveXperts Web Access Configuration tool;
    • Select the Web View;
    • Enable the XSL/XML based custom web view (v2017 compatible) option.

    Once enabled, you can associate an XSL stylesheet with each Web View configured. That XSL line is inserted in each XML data file that is published, like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <?xml-stylesheet type="text/xsl" href="/libs-xsl/ChecksByResult.xsl"?>
    <monitor>
      <webview-name>Entire Network View</webview-name>
      <webview-description>All Checks</webview-description>
      <refreshtime>04/09/2020 08:14:53 AM</refreshtime>
      <check>
        <id>10001</id>
        <displayname>www.monitortools.com - Ping (ICMP)</displayname>
        <host>www.monitortools.com</host>
        <folder>\</folder>
        ...
      </check>  
      <check>
        ...
      </check> 
    </monitor>
    
    Customizing

    To customize the v.2017 XSL/XSL layout, you should make changes to files in the following folder:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\_installer\libs-xsl\

    IMPORTANT: After customization, you MUST delete all files and folders in C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\ EXCEPT the _installer\ folder. That way, all files and folders (customizations) will be rewritten in the C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\ folder.

    If you have made a mistake in the _installer, and you want revert to the original one, all you need to do is deleting the complete folder:
    C:\ProgramData\ActiveXperts\Network Monitor\WebRoot\
    The Engine will then copy its original WebRoot folder from the C:\Program Files\ActiveXperts\Network Monitor\Sys\ folder.

    To customize the XSL/XML web interface, you need to modify the *.xsl files and/or the axnetmonstyle.css files. With a little knowledge of XSL and CSS, it is very straightforward.
    The following XSL elements are used frequently:

    • <xsl:value-of>
    • <xsl:sort>
    • <xsl:value-of>
    • <xsl:value-of>

    9. Reports

    9.1. Introduction

    With the ActiveXperts Report Generator, users can create virtually any report. Reports can either be created using a Wizard, or can be generated by a Windows 'Task Scheduler' task without user interaction, which will generate them automatically, periodically (e.g. daily, weekly, monthly). If a report is run from a schedule, the actual report(s) can be sent automatically to a list of e-mail recipients.

    ActiveXperts Reports features the following:

    • Availability Reports. These reports contain reports aggregate fields, such as total up-time, total down-time etc. Aggregate fields are shown as absolute values (e.g. days, hours, minutes) as well as relative (percentage) values;
    • Incident Reports. These reports show all status changes, including reason for the status change and amount of time it remained in that particular status;
    • Filters - Filters ensure that your reports only return the data you require. The filters available are date/time, checks, folders and results;
    • Create reports interactive through a Windows Wizard (AxRgGui.exe);
    • Create reports from the Windows Task Scheduler using the Report Generator Command-Line Tool (AxRgCmd.exe);
    • Send Reports an an e-mail attachment;
    • Define custom Report Templates;
    • Supported Report formats:PDF, XML, HTML and CSV;

    9.2. Report Data

    Report Data is retrieved from a database called the Statistical Database. All data is retrieved from the ReportData table.
    The database also stores the Graph Data used to plot Graphs .

    You can configure Statistical Database settings using the Report and Graphs Configuration Tool:

    • Choose Tools from the Manager application, and select the Reports and Graphs Configuration Tool.

    To read more about the Statistical Database and the Report and Graphs Configuration Tool, see chapter Statistical Data Logging.

    9.3. Create a Report

    Step 1: Launch the Report Generator Wizard

    You can launch the ActiveXperts Report Generator from the Manager.
    To do so, Open Reports and Graphs from the Tools menu and select Create New Report.

    Step 2: Select a Report Definition File

    Select a Report Definition (.rep) file. A definition file includes all properties of the new report, including type of report, formartting, timeframe, filters and more.

    Step 3: Finish

    Press Finish to create the report. The report is saved in the Reports folder; in a default installation, it is located in folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Stats\
    A Log file is created in the Logs folder; in a default installation, it is located in folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Logs\

    Additionally, you can send the report to the e-mail recipients; the check box is only enabled if the Report Definition file contains e-mail recipients.

    9.4. Create a Report (scheduled)

    ActiveXperts Reports allows you to send out reports automatically to a specified list of e-mail recipients. This can be useful for scheduled reports, for instance for reports that run automatically every week or every month.

    Step 1 - Configure a Report Definition file with e-mail recipients

    To send a report to e-mail recipients from a scheduled job, you must configure the e-mail recipients in the Report Definition (.rep) file.

    ActiveXperts Reports uses the same global e-mail settings as the ActiveXperts Network Monitor Manager and the ActiveXperts Network Monitor Engine service, like: SMTP server, fallback SMTP server (if any), SMTP login credentials (if any), E-mail Address Book, etc. To change global e-mail settings, you must use the ActiveXperts Network Monitor Manager.

    To configure e-mail recipients for a Report Definition (.rep) file:

    • Start the ActiveXperts Report Configuration Tool from the Manager.
      To do so, Open Reports and Graphs from the Tools menu and select Reports and Graphs Configuration....
    • Select the Reports tab;
    • Select a Report Definition File from the list, and press the Edit Selected button;
    • Select the E-mail properties sheet;
    • Select the E-mail report checkbox. You can now edit the e-mail subject and e-mail body, and select the e-mail recipients.

    NOTE: It is recommended to use E-mail Distribution Groups (from the E-mail Address Book) rather than individual recipients. With a Distribution Group, you don't need to change the Report Definition file to add/remove a recipient. You just need to modify the Distribution Group's recipient list. Besides that, a Distribution Group can be used by multiple Report Definition files.

    Step 2 - Create a test report from the command line (AxRgCmd.exe)

    Before you schedule a report using the Task Scheduler, it is recommended to test the report using the command line tool AxRgCmd.exe. This command line tool produces the same result as the graphical report tool (AxRgGui.exe) described in Chapter 7.2, but does not require any user intervention so it can be run from the Task Scheduler.

    To create a new report from the command line:

    • Start a new Command Prompt. You can start the prompt by pointing to Run in the Start menu, and type: CMD.EXE You can also start a new prompt pointing to Accessories from the All Programs menu, and then select Command Prompt.
    • Change the current directory; set it to the network monitor installation directory. For instance:
      CD "C:\Program Files\ActiveXperts\Network Monitor\"
    • Start the command line program to create a new report. It requires one parameter: the Report Definition File to be used to create the new report. For instance:
      AxRgCmd.exe /f detail-today-pdf.rep
    • The command line utility will create the report file. The output filename is specified in the Report Definition File. The results of the operations are logged in the following file:
      \Logs\ReportGenerator.log
    Step 3 - Schedule a Report using the Task Scheduler

    Report creation can be automated by scheduling the creation of a report using the Windows Task Scheduler. Scheduling is often used to create monthly reports and send the report to a specified list of e-mail recipients.

    With the Task Scheduler, you can only run the command-line version of the Report Creation Tool (AXRGCMD.EXE). The graphical version (AxRgGui.exe) requires user input and is not designed to run from the Task Scheduler.

    'Step 3' already described how to use the AxRgCmd.exe tool command line tool. This tool can be used to create a report from the command line using a Report Definition (.rep) file, without user intervention, like this:

    @echo off
    CD "C:\Program Files\ActiveXperts\Network Monitor\Program"
    AXRGCMD.EXE /f "detail-today-pdf.rep"

    Or (similar)

    @echo off
    CD "C:\Program Files\ActiveXperts\Network Monitor\Program"
    "C:\Program Files\ActiveXperts\Network Monitor\Program\AXRGCMD.EXE" /f "incident-today-pdf.rep"

    For scheduled tasks, it is recommended to make use of a batch file to encapsulate parameters. For instance, see:
    C:\Program Files\ActiveXperts\Network Monitor\Report Definitions\BatchJobs\Incident-Day.cmd

    9.5. Report Definition Files (*.rep)

    The properties of a report is described in a Report Definition file (.rep) file. This definition file describes the properties of a report, including:

    • Report Type; this can be either a Incident Report or an Availability Report. A 'Incident Report' shows all status changes and time the checks had a particular status; an 'Availability Report' provides overall availability information of the checks;
    • Report output file. Use placeholders to use dynamic report file names;
    • Time Frame. Date range, like: today, this month, last 4 weeks, etc.
    • Output format. Supported output formats are: PDF, HTML, XML, XML/XSL and CSV;
    • Filters. Filter on Checks, Folders, Check Types, and Results;
    • E-mail recipients. Recipient who should receive the report via e-mail.

    You can manage Report Definition file (.rep) files, use the ActiveXperts Report Configuration Tool. You can start this application from the 'ActiveXperts Network Monitor Manager':

    • On the Tools menu, click Reports and Graphs and click on the the Reports and Graphs Configuration Tool;
    • Select the Reports tab.
    ActiveXperts Network Monitor provides a set of pre-defined Report Definition files that can be used to create new reports:

    • Availability-month.rep
    • Availability-previousmonth.rep
    • Availability-today-html.rep
    • Availability-today.rep
    • Availability-yesterday.rep
    • Incident-month.rep
    • Incident-previousmonth.rep
    • Incident-today-html.rep
    • Incident-today.rep
    • Incident-yesterday.rep

    9.6. Customizing Reports

    To create/modify a Report Definition File, start the ActiveXperts Reports and Graphs Configuration Tool and do the following:

    • Select the Reports tab;
    • To create a new Report Definition File, click on the Create New button;
    • To modify an existing Report Definition File, select a Report Definition File from the list box and press the Edit Selected button;
    • When your create or edit a report, a wizard starts. It will prompt you for all necessary info.
    Availability Reports vs. Incident Reports

    On of the configurable items in a Report Definition File is the type of report. There are two types:

    • Availability Report;
    • Incident Report.

    An Availability Report provides overall availability information of your servers/checks during the nominated date range. You can see uptimes and downtimes, in days, hours, minutes and seconds, and also as percentages. An 'Availability Report' is used for instance to compare real availability statistics against the SLA requirements.

    A Incident Report provides a detailed list of all status changes during the nominated date range. For each check, you can see exactly when and why it failed, and for how long.

    Output filename

    On of the configurable items in a Report Definition File is the report output filename.

    You can choose for:

    • Fixed filename - a fixed filename, without placeholders;
    • Dynamic filename - a variable filename. It has year/month/day placeholder, so its name depends on the date when the report is created.

    On of the configurable items in a Report Definition File is the report output filename. If you use scheduled day/week/month/quarter/year reports, it is recommended to use dynamic filenames. Otherwise, new report files will automatically overwrite older ones, because the report output files have identical names.

    With dynamic files, the name of the report file depends on the date it is created. You can use the following placeholders:

    • DD - day notation with leading zero
    • D - day notation without leading zero
    • MM - month notation with leading zero
    • M - month notation without leading zero
    • YYYY - year notation
    • YYY - year notation (3 digits only)
    • YY - year notation (2 digits only)
    • Y - year notation (1 digit only)
    Filename:    IncidentReport%MMDDYY%.xml
    Date of creation:  20180422
    Result:      IncidentReport042218.xml
    
    Filename:    IncidentReport%YYYYMMDD%.xml
    Date of creation:  20180422
    Result:      IncidentReport20180422.xml
    
    Report Output format

    One of the configurable items in a Report Definition File is the report output format. ActiveXperts Network Monitor supports four different output formats:

    • PDF;
    • HTML;
    • XML;
    • CSV.
    Timeframe

    On of the configurable items in a Report Definition File is the Start Date and the Start Date of a report. You can select the absolute Start Date and End Date, but it is recommended to use a relative Start Date and End Date. For example

    • This Day;
    • Previous Week;
    • Previous 5 Months;
    Filters

    You can define filters in your Report Definition File to show only a subset of all checks in your reports. You can define the following filters:

    • Checks - include all check in your report, or only a subset of all checks;
    • Check Types - include all kinds of checks, or only a subset. You can for instance create a report that only contains ICMP and HTTP checks;
    • Result - include only checks that have a specified result. For instance you can create a report of all checks with result: failed.
    E-mail

    The 'ActiveXperts Report Generator' allows you to send out reports automatically to a nominated list of e-mail recipiuents. This is particularly useful for automated reports, where reports are created daily/weekly/monthly, automatically. Recipients are automatically notified of a new report. They just need to click on the URL that is inside the e-mail message.

    The 'ActiveXperts Report Generator' makes use of the SMTP settings and E-mail address book of the ActiveXperts Network Monitor configuration. So, it uses the same primary- and secundary SMTP server as used by the ActiveXperts Network Monitor Engine service. You can use the same e-mail distribution groups as used for e-mail alerts.

    9.7. Formatting Reports

    The PDF and HTML reports are based on an XSL stylesheet to format the report. With the PDF/HTML report, the stylesheet is used to create the report. Once the report has been created, you cannot change the format of the generated report. With XML based reports, a link to the XSL stylesheet is included in the XML report. This means that report data and formatting are stored in two separate files, so you can change the format of the XML report at any time.

    XML Report Data

    Appx D. Report Definition XML Tags describes the Report Data of the XML files.

    XSL

    The 'ActiveXperts Report Generator' allows you to send out reports automatically to a nominated list

    By default, all PDF/HTML 'detail' reports are based on the following XSL stylesheet:
    IncidentReport.xsl

    All PDF/HTML 'availability' reports are based on the following XSL stylesheet:
    AvailabilityReport.xsl

    To change the format of a report, you can either modify the XSL file, or create a new custom XSL file and link the reports to the new XSL file.

    To create a new XSL file:

    • Start the Windows Explorer;
    • Point to the \Report Definitions\StyleSheets\ directory;
    • Make a copy of an existing XSL sheet.

    To link a report to a new custom XSL file:

    • Start the ActiveXperts Reports and Graphs Configuration Tool;
    • Select the Reports tab, select the Report Definition File and press the Edit button;
    • In the Report Output tab, select a new XSL file. XSL files are located in the \Report Definitions\StyleSheets\ folder.

    To modify an XSL file:

    • Start the Windows Explorer;
    • Point to the \Report Definitions\StyleSheets\ directory;
    • Select an XSL file and choose Edit from the context menu.

    To change the format of an HTML or XML report requires basic knowledge of XSL. A good tutorial to XSL can be found here: www.w3schools.com.

    Basic XSL statements

    Use the <xsl:for-each> tag to iterate over a set of checks.

    <xsl:for-each select="monitor/check">
        ...
        <br><xsl:value-of select="result"/><br>
    </xsl:for-each>
    
    The XSL <xsl:for-each> element can be used to select every XML element of a specified node set. 
    The <xsl:value-of> element can be used to select the value of an XML element and add it to the 
    output stream of the transformation.
    

    Use the <xsl:sort> tag to sort a record set.

    <xsl:for-each select="monitor/check">
    <xsl:sort select="result"/>
    <xsl:sort select="displayname"/>
        ...
    <xsl:for-each>
    
    To sort output it at the same time, simply add the <xsl:sort> sort element inside the for-each 
    element in your XSL file. Use multiple <xsl:sort> elements to sort on multiple columns.
    

    Use the <xsl:if> tag to use a condition.

    <xsl:if test="result > 2">
      ...
    </xsl:if>
    
    To put a conditional if test against the content of the file, simply add an <xsl:if> element 
    to your XSL document. The value of the required test attribute contains the expression to 
    be evaluated.
    

    Appx D. Report Definition XML Tags describes the XML tags that can be used in the report definition stylesheets (.xsl).

    10. Graphs

    10.1. Introduction

    With the ActiveXperts Graphs tool, users can create graphs for any Check. You can have multiple Graphs in one screen for multiple Checks, with the restriction that the Checks must be of the same check type (e.g., all ICMP).
    Graphs are created from the Manager using the Check's context menu. Simply right-click on a check, and the Graphs option will appear.

    ActiveXperts Graphs features the following:

    • Show Graphs of single or multiple Checks in one Window. Checks must be of same check type.
    • Define any Time Frame. You can create Graphs of any start date and end date in history;
    • Zoom feature, to zoom in and out;
    • Save the Graph(s) in various formats including PDF, PNG and JPG;

    10.2. Graph Data

    Graph Data is retrieved from a database called the Statistical Database. All data is retrieved from the GraphData table.
    The database also stores the Report Data used to create Reports .

    You can configure Statistical Database settings using the Report and Graphs Configuration Tool:

    • Choose Tools from the Manager application, and select the Reports and Graphs Configuration Tool.

    To read more about the Statistical Database and the Report and Graphs Configuration Tool, see chapter Statistical Data Logging.

    10.3. Creating a Graph

    Step 1: Use the ActiveXperts Network Monitor Manager

    Launch the ActiveXperts Network Monitor Manager.

    Step 2: Select one or multiple Checks

    Select a single Check, or select multiple Checks of the same check type.

    Step 3: Launch the Graph tool from the context menu

    Right-click on the selected Check(s), and choose Show Graph....

    11. Windows Servers

    11.1. WMI

    Windows Management Instrumentation (WMI) is like a database of information about a Windows machine. Nearly every piece aspect of a Windows device is stored within the WMI repository. For example: network interfaces, disks, memory, CPU's, user accounts, performance data, and many more. Besides information about Windows devices, all kinds of information about the Windows Operating System and Windows applications is stored in this repository.

    ActiveXperts relies on WMI to query Windows machines. There are two ways for ActiveXperts to access WMI:

    • DCOM (traditional way) - Queries are executed locally on the monitoring machine, reducing the overall performance of ActiveXperts Network Monitor
    • WinRM (recommended) - Queries are executed on the remote monitored machines and does not affect the performance negatively.

    ActiveXperts recommends using WinRM when possible since it executes faster, it is more secure and easier to configure through a firewall.

    11.2. WMI over DCOM

    DCOM is the traditional protocol used by WMI to connect to remote Windows machines. Over the years, WinRM has superseded DCOM as recommended remote WMI protocol. There are three disadvantages of DCOM compared to WinRM:

    • DCOM uses dynamic ports for communication between client and server. It uses TCP port 135 and a dynamic range of TCP ports 1024 through 65535, making it hard to use over the internet. WinRM uses just one port.
    • Queries are executed locally on the monitoring machine. This reduces the overall performance of ActiveXperts Network Monitor
    • DCOM is less secure compared to WinRM

    Verify DCOM only (without WMI) on a (remote) Windows machine

    If you just want to check if DCOM is enabled or disabled without checking WMI, use the following Powershell command:

    New-CimSession -ComputerName MYSERVER01 -SessionOption (New-CimSessionOption -Protocol Dcom) -Credential "MYDOMAIN01\Administrator"

    Verify WMI over DCOM on a (remote) Windows machine

    You can easily check if DCOM is enabled or disabled by using the following Powershell command:

    Get-WmiObject -ComputerName MYSERVER01 -Credential "MYDOMAIN01\Administrator" -Query "SELECT * FROM Win32_UserAccount"

    Disable DCOM on a (remote) Windows machine

    On the monitored Windows machine, open the Windows Run prompt and type DCOMCNFG. Then:

    • In the Component Services dialog box, go to 'Component Services' -> 'Computers' -> 'My Computer';
    • Right-click 'My Computer' and select 'Properties';
    • Select the 'Default Properties' tab;
    • To disable DCOM, de-select the Enable Distributed COM on this computer checkbox.

    11.3. WMI over WinRM

    WinRM is a Microsoft implementation of WSMan. WSMan is a SOAP based protcol that is used to query hardware and operating systems. WinRM uses HTTP or HTTPs. Default ports are 5985 (HTTP) or 5986 (HTTPs). WinRM uses both NTLM and Kerberos (domain) authentication natively. After authentication, AES (Advanced Encryption Standard) is used for data interchange. There are three advantages of WinRM compared to DCOM:

    • WinRM uses just one port is easy to configure on your router/firewall, as it uses just one port. DCOM uses multiple dynamic ports. Default port is 5986 (secure, HTTPs), or port 5985 (not secure, HTTP).
    • Queries are executed on the remote monitored server, boosting the overall performance of ActiveXperts Network Monitor
    • WinRM is more secure than DCOM

    Verify WinRM only (without WMI) on a (remote) Windows machine

    If you just want to check if WinRM is enabled or disabled without checking WMI, use the following Powershell command:

    Test-WSMan -ComputerName MYSERVER01 -Credential "MYDOMAIN01\Administrator" -Authentication default

    Verify WMI over WinRM on a (remote) Windows machine

    You can easily check if WMI/WinRM is enabled or disabled by using the following Powershell command:

    Get-WSManInstance -ComputerName MYSERVER01 -Credential "MYDOMAIN01\Administrator" -Enumerate -ResourceURI wmicimv2/* -Filter "SELECT * FROM Win32_UserAccount"

    How to enable WinRM on Windows domain member servers in a Windows Active Directory Domain

    To enable WinRM on Windows member servers in a Windows Active Directory Domain, you can use a Group Policy Object (GPO):

    1. Create a new GPO: Open the Group Policy Management Console and create a new GPO linked to the domain or an appropriate Organizational Unit (OU) that contains your domain member servers.
    2. Configure the GPO: Edit the GPO and navigate to Computer Configuration > Policies > Administrative Templates > Windows Components > Windows Remote Management (WinRM) > WinRM Service. Enable the policy "Allow automatic configuration of listeners".
    3. Apply the GPO: Refresh Group Policy on all target servers or wait for the next Group Policy refresh interval to occur.
    4. Verify WinRM is enabled: Open a command prompt on one of the target servers and run the command:
      winrm enumerate winrm/config/listener".
      This should show at least one listener is configured and ready to receive incoming WinRM requests.

    Note: WinRM is enabled by default on Windows Server 2012 and later, but if it's not enabled on your servers, this process will help you enable it.

    How to enable WinRM on a standalone Windows Server

    To enable WinRM on a standalone Windows Server:

    1. Open an elevated Command Prompt.
    2. Type the following command to enable WinRM:
      winrm quickconfig
    3. Type y when prompted to confirm that you want to enable WinRM.
    4. Type the following command to allow remote access to the WinRM service:
      winrm set winrm/config/service '@{AllowUnencrypted="true"}'
    5. Type the following command to allow remote access to the WinRM listener:
      winrm set winrm/config/listener '@{Hostname="<computer_name>";Port="<port>"}'
      Replace <computer_name> with the hostname of the server and <port> with the desired port number (default is 5985).
    6. Type the following command to add the current user to the WinRM Remote Management Users group:
      winrm set winrm/config/winrs '@{MaxShellsPerUser="<number>"}'
      Replace <number> with the desired number of concurrent connections.
    7. Restart the WinRM service by running the following command:
      net stop winrm' and 'net start winrm

    Note: WinRM is enabled by default on Windows Server 2012 and later, but if it's not enabled on your servers, this process will help you enable it.

    11.4. Service Account

    ActiveXperts Network Monitor Engine runs as a service on the Windows Operating System. The Service Account credentials - as configured in the Windows Services applet - are used to monitor remote Windows Servers/Workstations, unless other credentails are required for a Server/Workstation. If other credentials are required (for instance because the remote machine is member of another domain, or because the server is a standalone server), you need to define alternate Windows Credentials.
    The Service Account is also used for MS SQL Server logging with Windows Authentication enabled on the MS SQ Server.

    Service Credentials are NOT used for non-Windows operations that require authentication. For instance an FTPs check requires authentication. Such Check always requires an explicit Account and Password.

    All Logon credentials to monitor Operating Systems are defined only once and are stored in the global settings of the configuration. This includes credentials for:

    • Windows - only for platforms where the Service Account does not suffice
    • Linux
    • SSH
    • SFTP
    • VMware
    • Citrix

    Windows credentials are defined in a separated tab named 'Credentials - Windows'; all the others are stored in are defined in a tab named 'Credentials - Other'.

    11.5. Credentials

    The ActiveXperts Network Monitor Engine Service Account credentials are used to monitor remote Windows machines. If these credentials do not have administrative permissions on a remote Windows machine, you can need to define alternate credentials. These alternate credentials are administrated globally, and can be used in any Windows check.

    IMPORTANT: If you use a Domain Admin account as Service Account for the ActiveXperts Network Monitor Engine service, there's NO need to specify alternate credentials for your Windows machines that are member of the domain.

    To monitor a Windows machine operates outside a domain, you need to create an Alternate Credentials entry for such Windows machine:

    • From the Tools menu, choose Credentials - Windows;
    • Click on the Add button.

    If Alternate Credentials are defined for a Windows machine, the Engine will try these Alternate Credentials first and will fallback to the Service Credentials if the Alternate Credentials fail. This is the default setting, but can be changed:

    • From the Tools menu, choose Credentials - Windows;
    • In the How to Connect dropdown box, select one of the following:
      - Alternate Credentials first. Fallback to existing connection or service credentials (default)
      - Alternate Credentials only. No fallback
      - Service Credentials first. Fallback to Alternate Credentials
      - Service Credentials only

    An Alternate Windows Credentials entry has the following fields:

    • ID - a unique, Read-only ID. The ID is used in Checks to refer to the Windows credentials
    • Domain/Computer - a display name, usually the name of the Domain or name of the Workstation. The name doesn't have to be a valid NetBIOS name; it is actually a displayname used in the Check's configuration and can be any convenient name;
    • Account - a Windows account. You can use either a User Principle Name (UNC, e.g. MYDOMAIN\Administrator, or mydomain.dom\Administrator), or a User Principle Name (UPN, e.g. administrator@mydomain.dom);
    • Password - a password

    12. Linux and VMware Servers

    12.1. Credentials

    A Credentials entry has the following properties:

    • Host - the Host (or IP) of the server. Must be a unique string;
    • Port - the secure port of the server. Default: 22;
    • Login - the login name;
    • Password - the password if a password is used. If a private key file is used, you leave the password empty;
    • Private Key File - the private key file used to logon to the server. If a password is used, you leave the private key file empty;
    • Timeout - the connection timeout in milliseconds.

    13. Operators and Roles

    13.1. Introduction

    Access to the configuration of ActiveXperts Network Monitor is controlled by Operator Roles. Allow full control to any user on all configuration aspects, or allow only predefined operators to access the configuration and associate permissions to those operators.

    The Microsoft SQL Compact Database Config.sdf file holds ALL the configuration data. In a default installation, it is located in folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Configuration\
    Permissions that Operators have on aspects of the configuration are also stored in this file.

    13.2. Administrator permissions to all

    By default, all users with a valid Windows login on the ActiveXperts Network Monitor server have 'Full Administrator' permissions. This means that they can make any changes to the ActiveXperts Network Monitor configuration. However, if you want to limit permissions to users, you can assign an Operator Role to each individual.

    13.3. Operator Roles

    If you don't want 'Full Administrator' permissions to all users of Network Monitor, you need to select the Active Directory users that you want to grant access to the Network Monitor configuration. To each user, an Operator Role must be assigned.

    A Windows user account can be assigned one of the following Operator Roles:

    • Full Administrator - Manage Operators; Full Access to all Global Settings and all Checks
    • Advanced Operator - Full Access to all Global Settings and all Checks
    • Operator - Read-Only access to all Global Settings; Full access to all Checks
    • Read-Only Operator - Read-Only access to all Global Settings; Read-Only to all Checks
    • No Access - No access to the configuration.

    13.4. Configure Operator Roles

    As mentioned, all users with a valid Windows login on the ActiveXperts Network Monitor server have 'Full Administrator' permissions by default. To have different Operator Rules for operators, you must first enable this option:

    • From the Tools menu, choose Options;
    • Select the Operator and Roles tab;
    • Select the option Only allow predefined Operators to manage ActiveXperts Network Monitor.

    You can associate 'Operator Roles' to one or more Windows accounts. Do do so:

    • Click on the Select from Domain;
    • In the Domain field, enter your domain and press the List Users button;
    • Select one or more Domain users, and select an Operator Role; then press the Select button Role.

    NOTE: You can also enter a valid hostname in the Domain field, in case you want to select local user accounts.

    14. Dependencies

    14.1. About Dependencies

    Dependencies allow you to create a hierarchy of Checks that depend on each other. This hierarchy is independent of the Folder structure of your Network Monitor configuration.

    Dependencies prevent you and your network administrators from being overwhelmed with alert notifications when a central router or server goes down. Without a dependency configuration, the failure of a central server or device would cause a failure of other servers, and as a result many alert notifications would be sent out.

    A dependency will not stop the monitoring of a Check or a set of Checks as soon as a specific Check is in Failure status; it will continue monitoring, but it will show a different status: Dependency Failure, with a orange icon. In Reports and Graphs, the status will also be 'Dependency Failure'.

    There are at least two items involved when configuring dependencies:

    1. Dependee - the server or device that plays a central role. A failure of this 'dependee' device or server would cause failures of other servers and devices (so called 'dependers');
    2. Depender(s) - servers, devices or folders that depend on the 'dependee'.

    There's more information on Dependencies on the ActiveXperts Web Site: activexperts.com/support/network-monitor/online/dependencies. There's a sample included to illustrate how dependencies should be used.

    15. Maintenance

    15.1. Introduction

    Usually there are planned periods of time during which systems undergo maintenance activities that can cause service disruption. During such periods, you don't want Alert Notifications to be generated and Alert Actions to be executed. In addition, you wouldn't like such periods to be taken into account when calculating the Availability report information of your system.

    To avoid such situations, ActiveXperts enables you to define maintenance windows. ActiveXperts enables you to define Maintenance Plans, each one having one or more time schedules. These Maintenance Plans can be assigned to Checks. All Maintenance Plans are managed globally.

    15.2. Configure Maintenance Plans

    In ActiveXperts, there's a default Maintenance Plan that is assigned to a Check when it is created. If you do not have any maintenance activity in your network, you can can have zero schedules assigned to this maintenance plan. Otherwise, configre one or more schedules.

    If you have servers, or groups of servers that need a different maintenance window that the default Maintenance Plan, you can create new Maintenance Plans that you can assign to Checks.

    Configure your Maintenance Plans in the Maintenance tab of the Options menu.

    Create a new Maintenance Plan

    To create a new Maintenance Plan, choose Create New maintenance Plan from the Configure Maintenance Plan tab drop-down box.

    Rename / Delete a Maintenance Plan

    To delete a new Maintenance Plan, select the Maintenance Plan that you want to rename/delete and choose Rename/Delete Maintenance Plan from the Configure Maintenance Plan tab drop-down box.

    Configure a Maintenance Plan

    To configure a new Maintenance Plan, select the Maintenance Plan from the Configure Maintenance Plan tab drop-down box. You can then Add, Remove and Configure zero or more Maintenance Schedules for a Maintenance Plan.

    Maintenance Schedule

    A Maintenance Plan consists of zero or more Maintenance Schedules. No schedules means that there's no maintenance activity defined. A Maintenance schedule can be recurring (once every monday, tuesday, etc), or can be set as one particular date. Furthermore, a maintenance schedule has a time and a fixed number of hours the system will undergo maintenance.

    16. Data Logging

    16.1. Introduction

    ActiveXperts Network Monitor has three different types of Logging:

    1. Statistical Data Logging - Used for statistical purposes, to allow the ActiveXperts statistical tools to produce Reports and Graphs;
    2. Application Logging - To see a history of all operations of the Engine;
    3. Real-Time Activity Logging - To view real-time Activity of the Engine in the ActiveXperts Network Monitor Manager

    This Chapter explains these three Logging topics.

    16.2. Statistical Data Logging

    ActiveXperts Reports and ActiveXperts Graphs make use a database called the Statistical Database. By default, this is an MS SQL Compact Database file named Stats.sdf. In a default installation, it is located in folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Stats\

    The Engine stores data in this database periodically (configrable). This data is used by the both Report and Graph programs to produce the reports and graphs by the use of advanced queries on the Statistical Database.
    There are two tables involved in this Statistical Database:

    • ReportData - used for creating Reports
    • GraphData - used for creating Graphs

    The Engine inserts an entry in the ReportData table for each status change of a check. Once every 5 minutes (configurable), the entry is updated to store the last monitored date/time stamp. As soon as there's a status change, a new entry is written.
    If you want, you can change this value through the registry. See FAQ item #Q7780030.

    The Engine inserts an entry in the Graph table for each status change of a check, and once every 5 minutes by default. If you want the Engine to write more frequent to have a more accurate Graph, use the ActiveXperts Reports and Graphs Configuration Tool:

    • From the Manager application, choose Tools and select the Reports and Graphs Configuration Tool;
    • Select the Graphs tab, and change the value in field Once every x minutes.
    Statistical Data Migration

    It is strongly recommended to migrate the MS SQL Server Compact Database Stats.sdf database to either MS SQL Server or MySQL server, to boost the performance of the creation of reports and graphs.
    MS SQL Server Compact Database is an embedded database; MS SQL Server and MySQL are server-side relational databases. Server-side relational databases are installed as an independent service and run outside of the scope of the ActiveXperts application. That is why they can perform much better because of the intrinsic support for multi-core and multi-CPU architectures, using OS features like pre-caching.

    Migration is easy and seemless; use the ActiveXperts Reports and Graphs Configuration Tool:

    • From the Manager application, choose Tools and select the Reports and Graphs Configuration Tool;
    • Select the Statistical Database tab, and press the Migrate button.
    • A Wizard will guide you through the steps of migrating all Statistical Data to either MS SQL or MySQL. All datastructures will we created, including tables, indices and relationships.
    Statistical Database Maintenance

    The ActiveXperts Network Monitor Engine (service) has a statistical database maintenance job that is performed at the following times:

    • After the ActiveXperts Network Monitor Engine service is started;
    • Once every day.

    During the statistical database maintenance job, there are messages displayed in the Real-Time Activity View (View: 'Activity-System') like:

    • SYSTEM INFO: Statistical Database Maintenance started
    • SYSTEM INFO: Statistical Database Maintenance completed

    The following actions are performed:

    • Checks and Folders are copied from the Configuration Database 'Nodes' table to the Statistical Database 'Checks' table'; this is necessary because Report and Graph queries use JOIN operations that require both tables to be up to date.

    You can force a Statistical Database Maintenance operation using the Configuration API:

    CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\PowerShell\Server Commands\"
    Powershell .\ForceStatsDbMaintenance.ps1

    or

    CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\VBScript\Server Commands\"
    CSCRIPT ForceStatsDbMaintenance.vbs

    The Engine will then perform a Maintenance operation a few moments later.

    Statistical Database Synchronization

    The ActiveXperts Network Monitor Engine (service) has a statistical database maintenance job that is performed at the following times:

    • After the ActiveXperts Network Monitor Engine service is started;
    • Each time a new Check or Folder is added.

    During the statistical database synchronization job, there are messages displayed in the Real-Time Activity View (View: 'Activity-System') like:

    • SYSTEM INFO: Statistical Database synchronization: checks import completed, [x] checks and [y] folders copied.

    You can force a Statistical Database Synchronization operation using the Configuration API:

    CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\PowerShell\Server Commands\"
    Powershell .\ForceStatsDbSync.ps1

    or

    CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\VBScript\Server Commands\"
    CSCRIPT ForceStatsDbSync.vbs

    The Engine will then perform a Maintenance operation a few moments later.

    16.3. Application Logging

    All operations of the ActiveXperts Network Monitor Engine service are logged, to allow administrators to see what happened exactly in the past. The following activities are logged:

    • Monitoring activities
    • Other activities, like Alerts ( e.g. e-mail alerts, SMS alerts), Actions (e.g. a computer restart, a service restart, a custom script execution) and important system information.
    Log to a Plain Text File

    The Log information is stored by default in a text file named Log.txt. In a default installation, it is located in folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Logs\

    The Log.txt file has a configurable maximum size limit. After the limit has exceeded, the Log.txt file is copied to Log00001.txt and a new Log.txt is used. After the log is full, it will be copied to Log00002.txt, etc.

    To change the Log.txt file size limit, use ActiveXperts Network Monitor Manager and do the following:

    • Select Options from the Tools menu. The first tab you see is named Logging;
    • Press the Advanced Log to Text Settings button and change the maximum file size.
    Log to a Database

    Logging to a Plain Text file is the most used option. However, if you prefer to have data logged in a database, you have three choises: MS SQL Compact Database, MS SQL Server database, or a MySQL database.

    To change logging from Plain Text to a database, use the ActiveXperts Network Monitor Manager and do the following:

    • Select Options from the Tools menu. The first tab you see is named Logging;
    • Select the option Log to a Database. It will have the proper connection string to Log.sdf database that ships with the software.
    Application Data Migration

    Once using the MS SQL Server Compact Database Log.sdf, you can migrate it to either MS SQL Server or MySQL if you prefer. However, it will not boost performance like it does with the Statistical Database, because there are no complex queries involved.

    Migration is easy and seemless:

    • From the Manager application, choose Tools and select Options;
    • Select the Statistical Database tab, and press the Migrate button
    • A Wizard will guide you through the steps of migrating all Statistical Data to either MS SQL or MySQL. All datastructures will we created, including tables, indices and relationships.

    16.4. Real-Time Activity Logging

    The ActiveXperts Network Monitor Manager has a Real-Time Activity View on the bottom of the screen. This shows the most recent activities of the Engine. The Real-Time Activity View has of the following tabs:

    • Activity/System - this shows system information, like database operations, license key information, and more;
    • Alerts/Actions - this shows Alerts (e.g. e-mail, SMS) and Actions (e.g. restart of a computer, restart of a server, execution of a custom script)
    • Monitoring (All) - this shows all monitoring activities
    • Monitoring (Warning/Failed) - this shows all monitoring activities with result: Warning or Failure
    • Monitoring (Uncertain) - this shows all monitoring activities with result: Uncertain

    The Real-Time Activity View doesn't use any of the log files described earlier; it has its own internal temporary log files. In a default installation, it is located in:
    C:\ProgramData\ActiveXperts\Network Monitor\Logs\Ipc\Activity

    The above folder location is in fixed location, and cannot be changed. The log files are cleaned periodically, to boost performance.
    You can change the number of entries that you want to see in the view. To do so:

    • From the Manager application, right-click in the Real-Time activity view of the ActiveXperts Network Monitor Manager and change the number of entries.

    17. Configuration API

    17.1. Introduction

    The configuration API enables administrators to read and modify configuration settings programmatically. Use the API to script or automate tasks that need to be performed frequently or in large batches, such as creating new checks, modifying checks, or requesting the engine to immediate monitor a server.

    Execute commands to let the Engine perform specific tasks, like:

    • Reload the configuration because of a modification
    • Put a Check 'On Hold'
    • Immediate monitor a Check
    • Immediate monitor all Checks in a Folder
    • Immediate schedule Database Maintenance, to delete orphan nodes or to delete Nodes from the Configuration Tree that do not exist

    The API is implemented as an ActiveX object, and can be used by a wide variety of programming- and scripting languages. Samples are included in PowerShell and VBScript.

    17.2. Powershell

    The Powershell samples are located in the following Folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\Powershell\

    To run a Powershell Script:

    • Open a new Command Prompt
    • Change Directory (CD) to the Folder where the script resides, e.g.
      C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\Powershell\Checks and Folders\
    • Execute the script using the Powershell interpreter command

    For example:

    CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\Powershell\Checks and Folders\"
    Powershell .\ShowCheck.ps1 10050

    17.3. VBScript

    The VBScript samples are located in the following Folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\VBScript\

    To run a VBScript Script:

    • Open a new Command Prompt
    • Change Directory (CD) to the Folder where the script resides, e.g.
      C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\VBScript\Checks and Folders\
    • Execute the script using the CSCRIPT interpreter command

    For example:

    CD "C:\ProgramData\ActiveXperts\Network Monitor\Configuration API\Powershell\Checks and Folders\"
    CSCRIPT ShowCheck.vbs 10050

    17.4. NMConfig Class

    The ActiveXperts.NMConfig is the main class of the Configuration API. It has all properties and methods to add, delete and modify checks. You can also modify the global configuration settings using this object.

    In Powershell, the class is instantiated in the following way:

    $objNMConfig = new-object -comobject ActiveXperts.NMConfig

    In VBScript, the class is instantiated like this:

    Dim objNMConfig
    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )

    A selection of the most important Properties and methods are described below.

    17.5. NMConfig Properties

    Properties
    Property Type In/Out Description
    Version String Out Version number of the ActiveXperts Configuration API
    Build String Out Build information of the ActiveXperts Configuration API
    Module String Read Module DLL implementing the ActiveXperts Configuration API
    ConfigDatabase String ReadWrite Path of the Config.sdf Configuration Database
    LastError Number Out Result of the last called method
    Version property

    Type:

    String

    Description:

    Version information of the ActiveXperts Configuration API. This property is read-only; you cannot assign a value to it.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" ) 
    WScript.Echo  "Version: " & objNMConfig.Version
    Build property

    Type:

    String

    Description:

    Build information of the ActiveXperts Configuration API. This property is read-only; you cannot assign a value to it.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" ) 
    WScript.Echo  "Version: " & objNMConfig.Version
    Module property

    Type:

    String

    Description:

    Return the module name of the ActiveXperts Configuration API.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" ) 
    WScript.Echo  "Module: " & objNMConfig.Module
    ConfigDatabase property

    Type:

    String

    Description:

    Full path of the Configuration Database. Default path:
    C:\ProgramData\ActiveXperts\Network Monitor\Configuration\Config.sdf

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" ) 
    WScript.Echo "Configuration Database File: " & vbCrLf & objNMConfig.ConfigDatabase
    LastError property

    Type:

    Number

    Description:

    The result of a last called method. Use it to check the result of your last method call. A zero indicates: success. Any non-zero value means an error.
    The GetErrorDescription method provides the error description of an error code.
    For a complete list of error codes, check out the following page: www.activexperts.com/support/errorcodes/.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    WScript.Echo "Open Configuration Database, result: " & objNMConfig.LastError

    17.6. NMConfig Methods

    Functions
    Function Description
    Open Open the Configuration Database
    Close Closes the Configuration Database
    LoadTreeConfig LoadTreeConfig
    SaveTreeConfig SaveTreeConfig
    CountNodes CountNodes
    LoadNode LoadNode
    SaveNode SaveNode
    FindFirstNode Find first node using a Filter
    FindNextNode Find next node using a Filter
    CopyNode Copy an existing Node into a Folder
    ForceMonitorCheckNow Instructs Engine to immediate monitor a Check.
    ForceMonitorFolderNow Instructs Engine to immediate monitor all Checks in a specific Folder.
    ForceConfigDbReload Instructs the Engine and Manager to reload the Configuration.
    ForceStatsDbSync Instructs the Engine to synchronize the Statistical Database with the Configuration Database.
    ForceStatsDbMaintenance Instructs the Engine to execute its statistical database maintenance job.
    GetErrorDescription Get the description of the given error
    Open function

    Description:

    Opens the Configuration Database, pointed to by the ConfigDatabase property.

    Parameters:

    • None

    Return value:

    None. Check the LastError property for the result of the method.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    WScript.Echo "Open Configuration Database, result: " & objNMConfig.LastError & _
                 " (" &  objNMConfig.GetErrorDescription( objNMConfig.LastError ) & ")"
    Close function

    Description:

    Closes the Configuration Database, opened by the ConfigDatabase property.

    Parameters:

    • None

    Return value:

    None.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      objNMConfig.Close
    End If
    LoadTreeConfig function

    Description:

    This method returns a string that holds the Tree Configuration. A sample tree configuration:

    1=nodea0,nodea1,nodea2,nodea3
    nodea1=nodeb1,nodeb2

    If a node has an l-value, it is a Folder. In the above sample, '1' and 'nodea1' are Folders; 'nodea0', 'nodea2',' nodea3', 'nodeb1' and 'nodeb2' are Checks.
    The root folder ID is always 1.

    Parameters:

    • None

    Return value:

    A string representation of the tree configuration.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      WScript.Echo objNMConfig.LoadTreeConfig
      objNMConfig.Close
    End If
    SaveTreeConfig function

    Description:

    Saves a tree configuration.

    Parameters:

    • String representing the new tree configuration

    Return value:

    None

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      objNMConfig.SaveTreeConfig( "1=0" )  ' Saved an emptry tree with just the Root node (ID=1)
      objNMConfig.Close
    End If
    CountNodes function

    Description:

    Count the number of Nodes in the Configuration Database. Use a filter to specify whih types to count.

    Parameters:

    • Filter (String) - A Filter to specify which Nodes to count.

    Return value:

    The number of Nodes.
    Check the LastError property for the result of the method. If the function fails, 0 is returned.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    Set objNMConstants = CreateObject( "ActiveXperts.NMConstants" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      strFilter = "Type=" & objNMConstants.CHECKTYPE_PINGICMP
      WScript.Echo objNMConfig.CountNodes( strFilter )   ' Print the number of ICMP Checks
      strFilter = "Type=" & objNMConstants.CHECKTYPE_FOLDER
      WScript.Echo objNMConfig.CountNodes( strFilter )   ' Print the number of Folders
      objNMConfig.Close
    End If
    LoadNode function

    Description:

    Loads a NMNode object, indicated by the ID.

    Parameters:

    • ID of the Node

    Return value:

    An NMNode object. Check the LastError property for the result of the method. If the function fails, a NULL object is returned.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      Set objNMNode = objNMConfig.LoadNode( 1 )   ' Load the Root Folder
      If( objNMConfig.LastError = 0 ) Then  
        WScript.Echo "Root Folder is named: " & objNMNode.DisplayName
      End If
      objNMConfig.Close
    End If
    SaveNode function

    Description:

    SaveNode a NMNode object, indicated by the ID.

    Parameters:

    Return value:

    None. Check the LastError property for the result of the method.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      Set objNMNode = objNMConfig.LoadNode( 10034 )   ' Load Check #10034
      objNMNode.DisplayName = "New Name for my Check"
      objNMConfig.SaveNode( objNMNode )   ' Save the Check
      objNMConfig.Close
    End If
    FindFirstNode function

    Description:

    Find the first Node using a Filter. Combine with FindNextNode to iterate over all Nodes.

    Parameters:

    • Filter (String) - A Filter to specify which Nodes to query.

    Return value:

    An NMNode object. Check the LastError property for the result of the method. If the function fails, a NULL object is returned.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    Set objNMConstants = CreateObject( "ActiveXperts.NMConstants" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      ' Iterate over all ICMP Nodes
      strFilter = "Type=" & objNMConstants.CHECKTYPE_PINGICMP
      Set objNMNode = objNMConfig.FindFirstNode( strFilter ) 
      While( objNMConfig.LastError = 0 )
        WScript.Echo "Check #" & objNMNode.ID & ": " & objNMNode.DisplayName
        Set objNMNode = objNMConfig.FindNextNode()   
      Wend
      objNMConfig.Close
    End If
    FindNextNode function

    Description:

    Find the next Node using a Filter. Combine with FindFirstNode to iterate over all Nodes.

    Parameters:

    • None

    Return value:

    An NMNode object. Check the LastError property for the result of the method. If the function fails, a NULL object is returned.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    Set objNMConstants = CreateObject( "ActiveXperts.NMConstants" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      ' Iterate over all ICMP Nodes
      strFilter = "Type=" & objNMConstants.CHECKTYPE_PINGICMP
      Set objNMNode = objNMConfig.FindFirstNode( strFilter ) 
      While( objNMConfig.LastError = 0 )
        WScript.Echo "Check #" & objNMNode.ID & ": " & objNMNode.DisplayName
        Set objNMNode = objNMConfig.FindNextNode()   
      Wend
      objNMConfig.Close
    End If
    CopyNode function

    Description:

    Copy an existing Node into a specified Folder. Use this method to create a new Check, by first copying it, then modify it and finally save it using SaveNode.

    Parameters:

    • Source Check ID (Number) - the ID of the Check to copy to the destination Folder
    • Destination Folder ID (Number) - the ID of the Folder to copy to the source Check to

    Return value:

    A new NMNode object. Check the LastError property for the result of the method. If the function fails, a NULL object is returned.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    Set objNMConstants = CreateObject( "ActiveXperts.NMConstants" )
    objNMConfig.Open
    If( objNMConfig.LastError = 0 ) Then
      ' Iterate over all ICMP Nodes
      strFilter = "Type=" & objNMConstants.CHECKTYPE_PINGICMP
      Set objNMNode = objNMConfig.FindFirstNode( strFilter ) 
      While( objNMConfig.LastError = 0 )
        WScript.Echo "Check #" & objNMNode.ID & ": " & objNMNode.DisplayName
        Set objNMNode = objNMConfig.FindNextNode()   
      Wend
      objNMConfig.Close
    End If
    ForceMonitorCheckNow function

    Description:

    Instructs the Engine to immediate monitor a Check, regardless of configured Scan Frequency. The Engine will monitor the check as soon as possible.

    Parameters:

    • ID (Number) - the Check ID of the Check to be monitored

    Return value:

    None. Check the LastError property for the result of the method.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.ForceMonitorCheckNow( 10015 )  ' Monitor Check #10015 as soon as possible
    WScript.Echo "ForceMonitorCheckNow, result: " & objNMConfig.LastError & _
                 " (" &  objNMConfig.GetErrorDescription( objNMConfig.LastError ) & ")"
    ForceMonitorFolderNow function

    Description:

    Instructs the Engine to immediate monitor all Checks in a specific Folder and all of its SubFolders, regardless of configured Scan Frequency. The Engine will monitor the checks as soon as possible.

    Parameters:

    • ID (Number) - the Folder ID of the Folder to be monitored

    Return value:

    None. Check the LastError property for the result of the method.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.ForceMonitorFolderNow( 10923)  ' Monitor all Checks in Folder #10923
    WScript.Echo "ForceMonitorFolderNow, result: " & objNMConfig.LastError & _
                 " (" &  objNMConfig.GetErrorDescription( objNMConfig.LastError ) & ")"
    ForceConfigDbReload function

    Description:

    Instructs the Engine, local Manager and remote Managers to reload the Configuration after a change to the configuration. If you make changes to the configuration through the Configuration API, the Engine and Manager(s) will not reload the configuration until you instruct them to do so through this 'ForceConfigDbReload' command.
    You do not need to call Open prior to this command.

    Parameters:

    • None

    Return value:

    None. Check the LastError property for the result of the method.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.ForceConfigDbReload
    WScript.Echo "ForceConfigDbReload, result: " & objNMConfig.LastError & _
                 " (" &  objNMConfig.GetErrorDescription( objNMConfig.LastError ) & ")"
    ForceStatsDbSync function

    Description:

    ForceStatsDbSync instructs the ActiveXperts Network Monitor Engine service to sync the Statistical Database with the Configuration Database, which means that all Nodes records of the Configuration Database are copied to the Statistical Database. This is necessary because Report and Graph queries use JOIN operations that require both tables to be up to date.
    You do not need to call Open prior to this command.

    Parameters:

    • None

    Return value:

    None. Check the LastError property for the result of the method.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.ForceStatsDbSync
    WScript.Echo "ForceStatsDbSync, result: " & objNMConfig.LastError & _
                 " (" &  objNMConfig.GetErrorDescription( objNMConfig.LastError ) & ")"
    ForceStatsDbMaintenance function

    Description:

    ForceStatsDbMaintenance instructs the ActiveXperts Network Monitor Engine service to execute its statistical database maintenance job, to cleanup records. Records with check id's that do not exist in the configration (anymore), or records older than x months, configurable) will be cleaned.
    You do not need to call Open prior to this command.

    Parameters:

    • None

    Return value:

    None. Check the LastError property for the result of the method.

    Sample (VBScript):

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.ForceStatsDbMaintenance
    WScript.Echo "ForceStatsDbMaintenance, result: " & objNMConfig.LastError & _
                 " (" &  objNMConfig.GetErrorDescription( objNMConfig.LastError ) & ")"
    GetErrorDescription function

    Description:

    GetErrorDescription provides the error description of a given error code.

    Parameters:

    • Error code.

    Return value:

    The error description that is associated with the given error code.

    Example:

    Set objNMConfig  = CreateObject( "ActiveXperts.NMConfig" )
    objNMConfig.Open
    WScript.Echo "Open Configuration Database, result: " & objNMConfig.LastError  _
                 " (" &  objNMConfig.GetErrorDescription( objNMConfig.LastError ) & ")"

    17.7. NMNode Class

    The ActiveXperts.NMNode class is the class representation of a Check or Folder. It only has properties. Some are common, some are specific for the type of Check.

    Nodes are stored in the "Nodes" table of the Configration Database.

    In Powershell, the class is instantiated in the following way:

    $objNMNode = new-object -comobject ActiveXperts.NMNode

    In VBScript, the class is instantiated like this:

    Dim objNMNode
    Set objNMNode  = CreateObject( "ActiveXperts.NMNode" )

    A selection of the most important Properties are described below. The class has only one method named "Clear", to reset all properties of a node.

    17.8. NMNode Properties

    Below is a listing of the most relevant properties of an NMNode object.

    Properties
    Property Type In/Out Description
    ID Number Out ID of the Check or Folder
    DisplayName String In/Out DisplayName of the Check or Folder
    OnHold Boolean In/Out Check is On Hold
    Type Number In/Out Type of the Check or Folder
    ScanInterval Number In/Out Scan Interval of the Check, in seconds
    CheckServer String In/Out Host or IP address
    ID property

    Type:

    Number

    Description:

    The unique record ID in the "Nodes" table of the Configuration Database.

    DisplayName property

    Type:

    String

    Description:

    The DisplayName of the Check or Folder.

    OnHold property

    Type:

    Number

    Description:

    To pause a Check, set this value to True. Otherwise, set it to False.

    Type property

    Type:

    Number

    Description:

    The Type of Check or Folder. For a list of Type-values, click here.

    ScanInterval property

    Type:

    Number

    Description:

    The Scan Interval of the Check, in seconds.

    CheckServer property

    Type:

    String

    Description:

    The Host or IP address of the server/device to check.

    17.9. NMNode Methods

    Functions
    Function Description
    Clear Clear all properties of the NMNode object
    Clear function

    Description:

    Clear all proeprties of the NMNode object. String are set to empty, Numbers are set to 0, Booleans are set to False.

    Parameters:

    • None

    Return value:

    None.

    17.10. NMConstants Class

    The ActiveXperts.NMConstants is the class containing all contant values used in the API. It only has properties.

    In Powershell, the class is instantiated in the following way:

    $objNMConstants = new-object -comobject ActiveXperts.NMConstants

    In VBScript, the class is instantiated like this:

    Dim objNMConstants
    Set objNMConstants  = CreateObject( "ActiveXperts.NMConstants" )

    A selection of the most important Properties are described below.

    17.11. NMConstants Properties

    Below is a listing of the most relevant properties of an NMConstants class.

    CheckType constants
    Name Value Description
    CHECKTYPE_UNDEFINED 0 Undefined
    CHECKTYPE_FOLDER 1 Folder
    CHECKTYPE_PINGICMP 10 Ping (ICMP)
    CHECKTYPE_TRACEROUTE 11 TraceRoute
    CHECKTYPE_PINGTCP 12 Ping (TCP)
    CHECKTYPE_DISKSPACE_WMI 20 Disk Space
    CHECKTYPE_DISKSPACE_NASWIN32 21 Disk Space (NAS)
    CHECKTYPE_TCP 30 TCP/IP
    CHECKTYPE_POP3 31 POP3 Mailserver
    CHECKTYPE_SMTPR 32 SMTP Mailserver
    CHECKTYPE_HTTP 33 HTTP/HTTPs
    CHECKTYPE_FTP 34 FTP
    CHECKTYPE_RSHELL 35 RSH (Remote Shell Script)
    CHECKTYPE_DNS 36 DNS
    CHECKTYPE_SNMPGET 37 SNMP GET
    CHECKTYPE_NNTP 38 NNTP Newsserver
    CHECKTYPE_IMAP 39 IMAP Mailserver
    CHECKTYPE_NTP 40 NTP Timeserver
    CHECKTYPE_SNMPTRAPRCV 42 SNMP Trap Receive
    CHECKTYPE_SSHELL 43 SSH (Secure Shell Script)
    CHECKTYPE_ICA 44 Citrix - ICA
    CHECKTYPE_DHCP 45 DHCP
    CHECKTYPE_CERTIFICATE 46 Certificate Expiration
    CHECKTYPE_SERVICE 50 Service
    CHECKTYPE_FILE 60 File
    CHECKTYPE_REGISTRY 61 Registry
    CHECKTYPE_WINDOWSUPDATE 62 Windows Update
    CHECKTYPE_WINDOWSCERT 63 Certificates
    CHECKTYPE_IISAPPPOOL 64 MS IIS Application Pool
    CHECKTYPE_SVCPROC_AV 70 Anti-Virus/Internet Security
    CHECKTYPE_SVCPROC_MSACTIVEDIR 71 MS Active Directory
    CHECKTYPE_SVCPROC_MSHYPERV 72 MS Hyper-V Server
    CHECKTYPE_SVCPROC_MSEXCHANGE 73 MS Exchange Server
    CHECKTYPE_SVCPROC_MSIIS 74 MS IIS Server
    CHECKTYPE_SVCPROC_MSISASERVER 75 MS ISA Server
    CHECKTYPE_SVCPROC_MSSHAREPNT 76 MS SharePoint Server
    CHECKTYPE_SVCPROC_MSSQL 77 MS SQL Server
    CHECKTYPE_SVCPROC_WINDEFEND 78 Windows Defender
    CHECKTYPE_SVCPROC_MSBIZTALK 79 MS BizTalk
    CHECKTYPE_SVCPROC_MSINDEX 80 MS Index Server
    CHECKTYPE_SVCPROC_CITRIXXENAPP 81 Citrix - XenApp
    CHECKTYPE_SVCPROC_MSFOREFRONT 82 MS Forefront TMG
    CHECKTYPE_SVCPROC_MSDYNAMICSNAV 83 MS Dynamics NAV
    CHECKTYPE_SVCPROC_MSDYNAMICSAX 84 MS Dynamics AX
    CHECKTYPE_SVCPROC_MSDYNAMICSCRM 85 MS Dynamics CRM
    CHECKTYPE_SVCPROC_MSDYNAMICSGPSL 86 MS Dynamics GP/SL
    CHECKTYPE_EVTLOG 90 Event Log
    CHECKTYPE_VBSCRIPT 100 VBScript
    CHECKTYPE_ODBC 110 ODBC Connectivity
    CHECKTYPE_ADOSQL 111 Database Query (Generic)
    CHECKTYPE_ORACLE 112 Oracle Connectivity
    CHECKTYPE_MSTSE 120 MS Terminal Server
    CHECKTYPE_CPULOAD 130 CPU Usage
    CHECKTYPE_FOLDERSIZE 140 Folder
    CHECKTYPE_DISK 150 Disk Drives
    CHECKTYPE_FLOPPY 160 Floppy Drive
    CHECKTYPE_MEMORY 170 Memory Usage
    CHECKTYPE_PRINTER 180 Printer availability
    CHECKTYPE_PROCESS 190 Process
    CHECKTYPE_SCHEDULEDTASKNT 200 Scheduled Task (.txt)
    CHECKTYPE_SCHEDULEDTASKEVTX 221 Scheduled Task (Task Scheduler)
    CHECKTYPE_WINLOGON 230 Windows Login
    CHECKTYPE_SMTPTOPOP3 240 SMTP to POP3
    CHECKTYPE_MSMQ 250 MS Message Queue (MSMQ)
    CHECKTYPE_SERIALDEV 260 Serial Device
    CHECKTYPE_TFTP 270 TFTP
    CHECKTYPE_SPEEDTEST 271 SpeedTest
    CHECKTYPE_REMOTECMD 280 Remote Command
    CHECKTYPE_POWERSHELL 290 PowerShell
    CHECKTYPE_WINCMD 295 Windows Batch (cmd)
    CHECKTYPE_RADIUS 300 RADIUS
    CHECKTYPE_SFTP 310 SFTP
    CHECKTYPE_FTPS 311 FTPS
    CHECKTYPE_WMICOUNTERS 320 WMI Counters
    CHECKTYPE_PERFCOUNTERS 321 Performance Counters
    CHECKTYPE_PERFCOUNTERS 321 Performance Counters
    CHECKTYPE_REMDRV 330 Removable Drives
    CHECKTYPE_SMPP 340 SMPP
    CHECKTYPE_VMWAREESx 350 VMware ESXi
    CHECKTYPE_KVM 370 KVM
    CHECKTYPE_VERDE 371 Nimboxx VERDE VDI
    CHECKTYPE_ENVIRONALL 500 Environmental (Any)
    CHECKTYPE_ENVIRONTEMPERATURE 510 Temperature
    CHECKTYPE_ENVIRONHUMIDITY 520 Humidity
    CHECKTYPE_ENVIRONDEWPOINT 530 Dew Point
    CHECKTYPE_ENVIRONHEATINDEX 540 Heat Index
    CHECKTYPE_ENVIRONPOWER 550 Power
    CHECKTYPE_ENVIRONVOLTAGE 560 Voltage
    CHECKTYPE_ENVIRONSWITCH 570 Switch
    CHECKTYPE_ENVIRONPOWERSTATE 580 PowerState
    CHECKTYPE_ENVIRONLIGHT 590 Light
    CHECKTYPE_ENVIRONMOTION 600 Motion
    CHECKTYPE_ENVIRONSMOKE 610 Smoke
    CHECKTYPE_ENVIRONDOOR 620 Door
    CHECKTYPE_ENVIRONRESISTANCE 630 Resistance
    CHECKTYPE_ENVIRONWETNESS 640 Wetness
    CHECKTYPE_ENVIRONVIBRATION 650 Vibration
    CHECKTYPE_ENVIRONCARBONOXIDE 660 CarbonOxide
    CHECKTYPE_ENVIRONCARBONDIOXIDE 670 CarbonDioxide
    CHECKTYPE_ENVIRONAIRFLOW 680 Airflow
    CHECKTYPE_ENVIRONAIRQUALITY 690 AirQuality
    CHECKTYPE_ENVIRONSOUND 700 Sound
    NM_CHECKTYPE_AGGREGATE 999 Aggregate (combined)
    Result constants
    Name Value Description
    RESULT_NOTPROCESSED 0 Not processed
    RESULT_SUCCESS 1 Success
    RESULT_WARNING 2 Warning
    RESULT_FAILURE 3 Failure
    RESULT_MAINTENANCE 4 Maintenance
    RESULT_ONHOLD 5 On Hold
    RESULT_DEPENDER_WARNING 6 Warning by Depender
    RESULT_DEPENDER_FAILURE 7 Failure by Depender
    RESULT_UNCERTAIN 8 Uncertain

    18. Tuning the System

    18.1. Introduction

    The ActiveXperts Network Monitor Engine service monitors servers, workstations and devices from a central point. It is designed to run multiple checks simultaneously. To do so, it uses multiple sub-processes, so-called threads. Multi-threading gives a program the ability to perform many tasks simulteneously.

    In ActiveXperts Network Monitor, multiple threads are spawned, including:

    • Dispatcher - holds the configuration of the software. It has a queue of checks and decides which checks need to be checked. It determines which threads are busy and which threads are not, and passes a check to a thread that is capable of handling that type of check;
    • Notifications - Notifications can be time consuming, and are therefore assigned to threads to do its job. For instance, an SMS message through an SMSC dial-up provider can take up to 90 seconds. A NetPopup notification message to a non-existing NetBIOS recipient can take up to 10 seconds;
    • Checks - There are many threads for different types of checks, to optimize ActiveXperts Network Monitor's monitoring performance. There are threads for ICMP checks, CPU checks, Database checks, etc.

    The number of threads has a strong influence on the performance of the ActiveXperts Network Monitor Engine (service). If there are only a few threads, the software will not use much CPU and memory resources, but the throughput of checks may be low. By increasing the number of threads, the throughput will increase. However, too many threads will consume too many system resources together (each thread consumes memory and CPU), decreasing the performance of the Network Monitoring engine dramatically.

    18.2. Configuring Threads

    To configure the number of threads:

    • From the Manager application, choose Options from the Tools menu;
    • Select the Performance tab;

    In the Performance tab, you find all different types of threads. You can change the number of threads that are spawned when the ActiveXperts Network Monitor is started. As a result, changes take affect after you restart the service!

    The following threads are used by the ActiveXperts Network Monitor Engine service:

    • Environmental - handles environmental related Checks. Default number of threads: 1.
    • FTP - handles 'FTP' and 'TFTP' checks. Default number of threads: 1;
    • HTTP(s) - handles 'HTTP/HTTPs' checks. Default number of threads: 4;
    • ICMP/Ping - Handles 'ICMP/Ping' checks. Default number of threads: 8;
    • OLE Database - handles generic 'Database' checks, including checks for MySQL and MS SQL. Default number of threads: 2;
    • Oracle - handles 'Oracle' checks. Default number of threads: 1. IMPORTANT: you can configure only 1 Oracle thread;
    • PowerShell - handling (custom) PowerShell based checks. Default number of threads: 4.
    • Remote Command - handles Remote Command checks. Default number of threads: 1.
    • Removable Drives - handles Removable Drives checks. Default number of threads: 1.
    • Serial Communications - handles 'Serial Device' checks. Default number of threads: 1;
    • SMTP/POP3 - handles 'SMTP' and POP3' checks. Default number of threads: 1;
    • SMTP/POP3 (RR) - handles 'SMTP to POP3' Round-Robin checks. Default number of threads: 1;
    • SNMP Trap - handles 'SNMP Trap Receive' checks. Default number of threads: 1;
    • Socket - handles the following checks: 'TCP', 'ICA', 'DHCP', 'RSH', 'SNMP GET', 'NNTP', 'NTP', 'DNS', 'RADIUS' and 'TraceRoute'. Default number of Socket threads: 6;
    • SSH - handles 'SSH' checks. Default number of threads: 4;
    • SFTP/FTPS - handles 'SFTP' checks. Default number of threads: 1;
    • VBScript - handles (custom) VBScript-based checks. Default number of threads: 4;
    • Virtualization - handles the following checks: 'VMware', 'XenServer', 'Hyper-V' and 'Verde VDI'. Default number of threads: 4;
    • Win32 - handles the following checks: 'Directory Size', 'Scheduled Task for NT4' and 'File'. Default number of threads: 4;
    • WinUpdate - handles the following checks: 'Windows Update'. Default number of threads: 2;
    • WMI - handles all WMI based checks, e.g. 'Anti-Virus', 'Active Directory', 'Disk Space', 'Hyper-V', 'CPU', 'Disk Drives', 'Event Log', 'Memory', 'MS BizTalk Server', 'MS Exchange Server', 'MS IIS Server', 'MS Index Server', 'MS ISA Server', 'MS Message Queue', 'MS SharePoint Server', 'MS Performance Counter', 'MS Terminal Server', 'Printer', 'Process', 'Scheduled Task', 'Service' and 'Windows Defender'. Default number of WMI threads: 8.

    18.3. Log files

    ActiveXperts Network Monitor maintains its own Application Log Files. Applicion Logging is enabled by default. In a default installation, it is located in folder:
    C:\ProgramData\ActiveXperts\Network Monitor\Logs

    There more information about Application Logging, see topic Application Logging.

    19. Troubleshooting

    19.1. Introduction

    Visit our website at www.activexperts.com/support/network-monitor/ for a complete FAQ list. You can also send an email to our support staff: support@activexperts.com.

    20. Purchase and Product Activation

    20.1. License Scheme

    For ActiveXperts Network Monitor licensing options and pricing, please check online: ActiveXperts Network Monitor Licensing.

    20.2. Purchase

    To purchase, please visit: activexperts.com/sales

    You can also contact us via email: sales@activexperts.com.

    20.3. Product Activation

    After you purchase the product, you will receive one or more product license keys. These must be entered by using the ActiveXperts Network Monitor Manager application.

    To enter the license key, go to the Help menu, and choose 'License Information'. Press the 'Enter Key' button and enter your license key.

    Appx A. License Agreement

      PLEASE READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY BEFORE 
      DOWNLOADING OR USING THE SOFTWARE.  BY CLICKING ON THE 
      "ACCEPT" BUTTON, OPENING THE PACKAGE, DOWNLOADING THE PRODUCT, 
      OR USING THE EQUIPMENT THAT CONTAINS THIS PRODUCT, YOU ARE 
      CONSENTING TO BE BOUND BY THIS AGREEMENT. IF YOU DO NOT AGREE 
      TO ALL OF THE TERMS OF THIS AGREEMENT, CLICK THE "DO NOT 
      ACCEPT" BUTTON AND THE INSTALLATION PROCESS WILL NOT CONTINUE, 
      RETURN THE PRODUCT TO THE PLACE OF PURCHASE FOR A FULL REFUND, 
      OR DO NOT DOWNLOAD THE PRODUCT.
      
      GENERAL
      In this Software License Agreement:
      (i) "ActiveXperts" means ActiveXperts Software B.V.
      (ii) "Customer" means the individual(s), organization or business entity 
      buying a license of the Software from ActiveXperts or its Distributors 
      or its Resellers.
      (iii) "Software" means computer programs (and their storage medium) 
      supplied by ActiveXperts and known collectively as "Mobile Messaging Toolkit" 
      in which ActiveXperts has property rights and any user manuals, 
      operating instructions, brochures and all other documentation relating 
      to the said computer programs (the expression "Software" to include all 
      or any part or any combination of Software).
      
      1. LICENSE GRANT
      ActiveXperts grants Customer the following rights provided that you 
      comply with all terms and conditions of this License Agreement:
      
      (a) Installation and use. Customer may install, use, access, display and 
      run one copy of the Software on a single computer, such as a 
      workstation, terminal or other device ("Workstation Computer"). A 
      "License Pack" allows you to install, use, access, display and run 
      additional copies of the Software up to the number of "Licensed Copies" 
      specified above.
      
      (b) Reservation of Rights. ActiveXperts reserves all rights not 
      expressly granted to you in this License Agreement.
      
      2. UPGRADES AND SUPPLEMENTS
      To use a product identified as an upgrade, you must first be licensed 
      for the Software as eligible for the upgrade. After upgrading, Customer 
      may no longer use the product that formed the basis for Customer's 
      upgrade eligibility.
      
      This License Agreement applies to updates or supplements to the original 
      Software provided by ActiveXperts, unless we provide other terms along 
      with the update or supplement.
      
      3. LIMITATION ON REVERSE ENGINEERING,DECOMPILATION, AND DISASSEMBLY
      Customer may not reverse engineer, decompile, or disassemble the 
      Software, except and only to the extent that it is expressly permitted 
      by applicable law notwithstanding this limitation.
      
      4. TERMINATION
      Without prejudice to any other rights, ActiveXperts may cancel this 
      License Agreement if Customer does not abide by the terms and conditions 
      of this License Agreement, in which case you must destroy all copies of 
      the Software and all of its component parts.
      
      5. NOT FOR RESALE SOFTWARE
      Software identified as "Not for Resale" or "NFR," may not be resold, 
      transferred or used for any purpose other than demonstration, test or 
      evaluation.
      
      6. LIMITED WARRANTY
      ActiveXperts warrants that for a period of ninety (90) days from the 
      date of shipment from ActiveXperts: (i) the media on which the Software 
      is furnished will be free of defects in materials and workmanship under 
      normal use; and (ii) the Software substantially conforms to its 
      published specifications. Except for the foregoing, the Software is 
      provided AS IS. This limited warranty extends only to Customer as the 
      original licensee. Customer's exclusive remedy and the entire liability 
      of ActiveXperts and its suppliers under this limited warranty will be, 
      at ActiveXperts or its service center's option, repair, replacement, or 
      refund of the Software if reported (or, upon request, returned) to the 
      party supplying the Software to Customer. In no event does ActiveXperts 
      warrant that the Software is error free or that Customer will be able to 
      operate the Software without problems or interruptions.
      This warranty does not apply if the software (a) has been altered, 
      except by ActiveXperts, (b) has not been installed, operated, repaired, 
      or maintained in accordance with instructions supplied by ActiveXperts, 
      (c) has been subjected to abnormal physical or electrical stress, 
      misuse, negligence, or accident, or (d) is used in ultrahazardous 
      activities.
      
      
      7. LIMITATION OF LIABILITY AND REMEDIES.
      Notwithstanding any damages that you might incur for any reason 
      whatsoever (including, without limitation, all damages referenced above 
      and all direct or general damages), the entire liability of ActiveXperts 
      and any of its suppliers under any provision of this License Agreement 
      and your exclusive remedy for all of the foregoing (except for any 
      remedy of repair or replacement elected by ActiveXperts with respect to 
      any breach of the Limited Warranty) shall be limited to the greater of 
      the amount actually paid by you for the Software or U.S.$5.00. The 
      foregoing limitations, exclusions and disclaimers (including Sections 4, 
      5 and 6 above) shall apply to the maximum extent permitted by applicable 
      law, even if any remedy fails its essential purpose.
      
      8. ENTIRE AGREEMENT
      
      This License Agreement (including any addendum or amendment to this 
      License Agreements which is included with the Software) are the entire 
      agreement between you and ActiveXperts relating to the Software and the 
      support services (if any) and they supersede all prior or 
      contemporaneous oral or written communications, proposals and 
      representations with respect to the Software or any other subject matter 
      covered by this License Agreement. To the extent the terms of any 
      ActiveXperts policies or programs for support services conflict with the 
      terms of this License Agreement, the terms of this License Agreement 
      shall control.
      
      This Agreement shall be construed in accordance with the laws of The 
      Netherlands and the Dutch courts shall have sole jurisdiction in any 
      dispute relating to these conditions. If any part of these conditions 
      shall be or become invalid or unenforceable in any way and to any extent 
      by any existing or future rule of law, order, statute or regulation 
      applicable thereto, then the same shall to the extent of such invalidity 
      or enforceability be deemed to have been deleted from the conditions 
      which shall remain in full force and effect as regards all other 
      provisions.
      
      9. Copyright
      The Software is protected by copyright and other intellectual property 
      laws and treaties. ActiveXperts or its suppliers own the title, 
      copyright, and other intellectual property rights in the Software. The 
      Software is licensed, not sold.

    Appx B. ID's

    Check Type ID's and Result ID's can be used in several places in ActiveXperts Network Monitor:

    • In Notification Message Templates - include the check type ID or Result ID in a notification (e-mail, SMS, ...) to have more detailed information of a notification
    • In Report Definitions - include/exclude specific check types and/or results in particular reports
    • In Web Interface Definitions - include/exclude specific check types and/or results in particular web views

    A Check Type ID can hold one of the following values:

    • 10 - ICMP
    • 11 - TraceRoute
    • 20 - Disk Space
    • 21 - Disk Space (Win32 NAS)
    • 30 - TCP/IP
    • 31 - POP3
    • 32 - SMTP
    • 33 - HTTP(s)
    • 34 - FTP
    • 35 - RSH
    • 36 - DNS
    • 37 - SNMP Get
    • 38 - NNTP
    • 39 - IMAP
    • 40 - NTP
    • 41 - Temperature
    • 42 - SNMP Trap Receive
    • 43 - SSH
    • 44 - Citrix ICA
    • 45 - DHCP
    • 50 - Service
    • 60 - File
    • 61 - Registry
    • 62 - Windows Update
    • 63 - Windows Certificates
    • 64 - IIS Application Pool
    • 70 - Anti-Virus/Anti-Spam
    • 71 - MS Active Directory
    • 72 - MS Hyper-V Server
    • 73 - MS Exchange Server
    • 74 - MS IIS Server
    • 75 - MS ISA Server
    • 76 - MS SharePoint Server
    • 77 - MS SQL Server
    • 78 - Windows Defender
    • 79 - MS BizTalk
    • 80 - MS Index Server
    • 81 - Citrix XenApp
    • 82 - MS Forefront TMG
    • 83 - MS Dynamics NAV
    • 84 - MS Dynamics AX
    • 85 - MS Dynamics CRM
    • 86 - MS Dynamics GP/SL
    • 90 - Event Log
    • 100 - VBScript
    • 110 - ODBC
    • 111 - ADO/SQL
    • 112 - Oracle
    • 120 - MS TSE
    • 130 - CPU
    • 140 - Directory
    • 150 - Disk
    • 160 - Floppy
    • 170 - Memory
    • 180 - Printer
    • 190 - Process
    • 200 - Humidity
    • 201 - Power
    • 202 - Light
    • 203 - Motion
    • 204 - Smoke
    • 205 - Door
    • 206 - Resistance
    • 207 - SwitchNC
    • 208 - SwitchNO
    • 210 - Wetness
    • 220 - Scheduled Task (NT)
    • 221 - Scheduled Task
    • 230 - WinLogon
    • 240 - SMTP to POP3
    • 250 - MSMQ
    • 260 - Serial Device
    • 270 - TFTP
    • 271 - SpeedTest
    • 280 - Remote Command
    • 290 - PowerShell
    • 300 - RADIUS
    • 310 - SFTP
    • 320 - WMI Counters
    • 321 - Performance Counters
    • 322 - Network Traffic
    • 330 - Removable Drives
    • 340 - SMPP
    • 350 - Vmware
    • 360 - XenServer
    • 370 - KVM
    • 371 - Nimboxx VERDE
    • 0 - Undefined
    • 1 - a Folder (not a check)

    The Check Type values can be retrieved from the Config.sdf configuration database, and also from the statistical database (either Stats.sdf, an MS SQL Server database or MySQL database).
    Microsoft SQL Server Compact (.sdf) databases can be loaded into Microsoft SQL Server Management Studio 2008 (ships with Microsoft SQL Server) or higher, or Microsoft Visual Strudio 2010 or higher.
    To see all values, perform the following query on the CheckTypes table:

        SELECT * FROM CheckTypes ORDER BY ID;

    A Result ID can hold one of the following values:

    • 0 - Not monitored
    • 1 - Success
    • 2 - Warning
    • 3 - Failure
    • 4 - Maintenance
    • 5 - On Hold
    • 6 - Warning by Depender
    • 7 - Failure by Depender
    • 8 - Uncertain

    The Result values can be retrieved from the Config.sdf configuration database, and also from the statistical database (either Stats.sdf, an MS SQL Server database or MySQL database).
    To see all values, perform the following query on the 'Results' table:

        SELECT * FROM Results ORDER BY ID;

    Appx C. Web Access XML Tags

    The following Web Access XML tags are defined and used by Client Browsers:

    • id - ID of the Check. Each checks has a unique ID. Check ID's start at 10000
    • host - Hostname or IP address of the device/computer being monitored. Same value as in the 'Host' column in the Manager application
    • host-short - Same as the 'host' tag but with a different length.
    • displayname - Display name of the check. Same value as in the 'Display Name' column in the Manager application
    • displayname-short - Same as the 'displayname' tag but with a different length.
    • comments - Additional information about the last monitoring result of this check. Same value as in the 'Last Comments' column in the Manager application
    • comments-short - Same as the 'comments' tag but with a different length.
    • folder - Path of the folder where the check is located
    • type-id - Type of check. . See Appx B. ID's
    • type - Type of check (friendly name)
    • result-id - Monitoring result of the check. See Appx B. ID's
    • result - Monitoring result of the check (friendly name)
    • result-sortorder - Sort order having one of the following values:
      Failure: 1000
      Warning: 1001
      Depender Failure: 1002
      Depender Warning: 1003
      Uncertain: 1004
      Maintenance: 1005
      Success: 1007
      On Hold: 1008
      Not Processed: 1099
    • data - Resulting value (number) of the check. Can be the reply time in milliseconds (ICMP check), number of MB (Memory check), etc.
    • explanation - Additional information about the result of the check. Same value as in the 'Last Response' column in the Manager application
    • explanation-short - Same as the 'explanation' tag but with a different length.
    • processing - Indicates whether the check is being monitored right now.
    • update-secs - Time (in seconds after 1/1/1970) that the check was last processed.
    • update - Time (formatted string) that the check was last processed.
    • update-short - Same as the 'update' tag but with a different length.

    The length of each tag can be defined in the registry. This only applies to string tags, not to numeric tags. The tag lenghts are defined in the following registry key:

    HKLM\Software\ActiveXperts\Network Monitor\Server\WebAccess\XmlTags\

    NOTE: After changing a registry value in the above registry hive, you MUST restart the ActiveXperts Network Monitor Engine service in order for changes to take effect

    Appx D. Report Definition XML Tags

    The following Report Definition XML tags are defined by ActiveXperts Network Monitor. These tags can be embedded inside XSL formatting files to create custom report pages.

    The following XML tags are defined for Incident Reports:

    • monitor/from-secs - Start date and time of the report, in seconds elapsed after 1/1/1970
    • monitor/to-secs - End date and time of the report, in seconds elapsed after 1/1/1970
    • monitor/from-date - Start date of the report, as a friendly string
    • monitor/to-date - End date of the report, as a friendly string
    • monitor/description - Description of the report
    • monitor/check/id - ID of a check
    • monitor/check/host - Host of a check
    • monitor/check/displayname - DisplayName of a check
    • monitor/check/checktype-id - Type of check (number). See Appx B. ID's
    • monitor/check/checktype - Type of check (friendly string)
    • monitor/check/folder - Folder where a check resides
    • monitor/check/event/from-secs - Start date and time of the event, in seconds elapsed after 1/1/1970
    • monitor/check/event/from-date - Start date of the event, as a friendly string
    • monitor/check/event/from-time - Start time of the event, as a friendly string
    • monitor/check/event/to-secs - End date and time of the event, in seconds elapsed after 1/1/1970
    • monitor/check/event/to-date - End date of the event, as a friendly string
    • monitor/check/event/to-time - End time of the event, as a friendly string
    • monitor/check/event/result-id - Result of the event (number). . See Appx B. ID's
    • monitor/check/event/result - Result of the event (friendly string)
    • monitor/check/event/duration-secs - Duration of the event (seconds)
    • monitor/check/event/duration - Duration of the event (friendly string)
    • monitor/check/event/duration-pct - Duration of the event (percentage of total report timeframe)
    • monitor/check/event/reason - Detailed infomration about the result of the check


    The following XML tags are defined for Availability Reports:

    • monitor/from-secs - Start date and time of the report, in seconds elapsed after 1/1/1970
    • monitor/to-secs - End date and time of the report, in seconds elapsed after 1/1/1970
    • monitor/from-date - Start date of the report, as a friendly string
    • monitor/to-date - End date of the report, as a friendly string
    • monitor/description - Description of the report
    • monitor/check/id - ID of a check
    • monitor/check/host - Host of a check
    • monitor/check/displayname - DisplayName of a check
    • monitor/check/checktype-id - Type of check (number). See Appx B. ID's
    • monitor/check/checktype - Type of check (friendly string)
    • monitor/check/folder - Folder where a check resides
    • monitor/check/uncertain-secs - Amount of time that the check was in an 'Uncertain' status, in seconds
    • monitor/check/uncertain-hrsmin - Amount of time that the check was in an 'Uncertain' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/uncertain-pct - Amount of time that the check was in an 'Uncertain' status, as percentage of the total time reported
    • monitor/check/uncertain-secs - Amount of time that the check was in an 'Uncertain' status, in seconds
    • monitor/check/uncertain-hrsmin - Amount of time that the check was in an 'Uncertain' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/uncertain-pct - Amount of time that the check was in an 'Uncertain' status, as percentage of the total time reported
    • monitor/check/success-secs - Amount of time that the check was in a 'Success' status, in seconds
    • monitor/check/success-hrsmin - Amount of time that the check was in a 'Success' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/success-pct - Amount of time that the check was in a 'Success' status, as percentage of the total time reported
    • monitor/check/failure-secs - Amount of time that the check was in a 'Failure' status, in seconds
    • monitor/check/failure-hrsmin - Amount of time that the check was in a 'Failure' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/failure-pct - Amount of time that the check was in a 'Failure' status, as percentage of the total time reported
    • monitor/check/maintenance-secs - Amount of time that the check was in a 'Maintenance' status, in seconds
    • monitor/check/maintenance-hrsmin - Amount of time that the check was in a 'Maintenance' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/maintenance-pct - Amount of time that the check was in a 'Maintenance' status, as percentage of the total time reported
    • monitor/check/onhold-secs - Amount of time that the check was in an 'On Hold' status, in seconds
    • monitor/check/onhold-hrsmin - Amount of time that the check was in an 'On Hold' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/onhold-pct - Amount of time that the check was in an 'On Hold' status, as percentage of the total time reported
    • monitor/check/depfailure-secs - Amount of time that the check was in a 'Dependency Failure' status, in seconds
    • monitor/check/depfailure-hrsmin - Amount of time that the check was in a 'Dependency Failure' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/depfailure-pct - Amount of time that the check was in a 'Dependency Failure' status, as percentage of the total time reported
    • monitor/check/notprocessed-secs - Amount of time that the check was in a 'Not Processed' status, in seconds
    • monitor/check/notprocessed-hrsmin - Amount of time that the check was in a 'Not Processed' status, displayed as 'ddd hh:mm:ss'
    • monitor/check/notprocessed-pct - Amount of time that the check was in a 'Not Processed' status, as percentage of the total time reported

    Appx E. Notification Variables

    The following system variables can be embedded in Notifications (SMS, e-mail, etc.) and Actions (VBScript, PowerShell, etc.):

    • engine - Engine (host or IP address of the Network Monitor server) that processed this check
    • id - ID of the Check. Each checks has a unique ID. Check ID's start at 10000
    • host - Hostname or IP address of the device/computer being monitored
    • displayname - Friendly name of the check
    • notes - Additional custom information for this check
    • type-id - Type of check. See Appx B. ID's
    • type - Type of check (friendly name)
    • result-id - Monitoring result of the check. See Appx B. ID's
    • result - Monitoring result of the check (friendly name)
    • data - Resulting value (number) of the check. Can be the reply time in milliseconds (ICMP check), number of MB (Memory check), etc.
    • explanation - Additional information about the result of the check. It usually explains the reason for failing or the reason for success
    • date - Date this check was processed
    • time - Time this check was processed