InterMapper User Guide PDF
InterMapper User Guide PDF
Version 6.0
April 2016
Table of Contents
Welcome to InterMapper 9
About InterMapper 11
Getting Started 17
Using InterMapper 36
Creating Maps 57
Using Auto-Discover 59
Adding Devices Manually 65
Set Probe Window 66
Adding Networks to the Map 68
Scanning A Network 70
Creating Sub-maps 71
Creating Probe Groups 74
Using Helper Applications 78
Using Double-Click Actions 83
Saving Your Map 85
The Map Settings Window 86
Quick Reference - Editing Your Map 95
AutoMate 293
Overview 343
Viewing Layer 2 Information 343
Understanding the Layer 2 View 344
The Filter Pane 345
Understanding and Using the Endpoints Pane 347
Understanding and Using the Connections Pane 348
Understanding Layer 2 Flags 350
Understanding Fuzzy Devices 352
Mapping With Layer 2 353
Index 742
Chapter 1
Welcome to InterMapper
InterMapper Server and Network Monitoring
Use this manual to learn about how to get InterMapper up and running quickly, and
to get detailed information about specific features of the program.
InterMapper has several components that work together to help you understand
what's happening on your network:
-9-
Chapter 1: Welcome to InterMapper
A GUI application that allows you to view and configure your InterMapper sys-
tem from any location.
In addition, you can customize InterMapper's operation in a number of ways. The
Developer Guide/Software Development Kit is described separately.
HelpSystems LLC
InterMapper Feedback
- 10 -
About InterMapper
About InterMapper
What's New in InterMapper® 6.0?
InterMapper 6.0 includes a number new features and enhancements. Here's a sum-
mary...
InterMapper 6.0 includes a large number of enhancements that allow much more
precise monitoring of links and interfaces. Among these enhancements:
l Set thresholds for an individual interface for Link Utilization, Interface Errors,
and Interface Discards.
l Set default interface thresholds for a server, map, or device.
l Send alerts when thresholds are reached.
l View and acknowledge status for individual interfaces.
l View status of links with new visual indicators.
l View Statistics in a new tab of the Interfaces window.
System requirements for InterMapper are now maintained only online. Please see
the System Requirements page on the HelpSystems website.
Documents versions:
- 11 -
Chapter 1: About InterMapper
LICENSE
Upon receipt of payment for the Product (which includes the software and accom-
panying documentation), the Company grants the licensing party identified in the
applicable final quote, purchase order or invoice (“Customer”) a perpetual, limited,
non-exclusive, non-transferable license to use the Product solely on the system or
partition specified in the Customer's order and solely for the Customer's internal
business purposes, and subject to all the terms and conditions of this Agreement.
The Company reserves all rights, title, interest, ownership, and proprietary rights
in and to the Product, including but not limited to, all copies of the Product and any
patent rights, copyrights, trademark rights, trade secret rights, and any other intel-
lectual property rights. The Product is protected both by United States law and
international treaty provisions.
- 12 -
Software License Agreement
The Company may terminate this Agreement immediately if the Customer fails to
comply with any provision of this Agreement or if the Customer ceases to carry on
its present business or becomes insolvent, makes a general assignment for the
benefit of creditors, or is involved in a bankruptcy or receivership proceeding. The
Company's right to terminate this Agreement is in addition to and not in limitation
of any other available remedies. Upon termination, the Customer agrees to des-
troy the original and all copies of the Product in its possession or control. This
Agreement and any dispute arising from or relating to it shall be governed by and
construed and enforced in accordance with Minnesota law, without reference to con-
flicts of laws principles. Any legal action or proceeding shall be instituted in a state
or federal court in Hennepin County, Minnesota, USA. This Agreement constitutes
the complete agreement between the parties and supersedes all prior or con-
temporaneous agreements or representations, written or oral, concerning the sub-
ject matter of this Agreement including any purchase order or ordering document.
This Agreement may not be modified or amended except in writing and when
signed.
The Company, wholly owned by Help/Systems, LLC, may assign any or all of its
rights under this Agreement at any time without notice.
*Note to customers outside the U.S.: You also agree to be bound by any
additional license terms and conditions presented to you by the author-
ized Company distributor from whom you purchased the Product ("addi-
tional license terms"). The additional license terms are incorporated in
this Agreement to the extent they do not explicitly conflict with any of
the terms set forth above.
MAINTENANCE
The Customer may purchase maintenance for the Product by payment of a main-
tenance fee as set forth by the then current software product price list. Main-
tenance includes the following benefits:
Training services must be used within 6 months of being invoiced and all fees are
nonrefundable.
- 13 -
Chapter 1: About InterMapper
- 14 -
InterMapper and Section 508
elements as the
input focus
changes.
Information about user interface ele- Supports with X
ments Exceptions.
(d) Sufficient information about a user inter- InterMapper
face element including the identity, operation provides "status
and state of the element shall be available to windows" that
Assistive Technology. When an image rep- describe the
resents a program element, the information state of items on
conveyed by the image must also be available a map, however
in text. these status win-
dows are not
available to Ass-
istive Tech-
nology.
Consistent meaning of images Supports. The X
(e) When bitmap images are used to identify InterMapper
controls, status indicators, or other pro- user interface
grammatic elements, the meaning assigned to consistently
those images shall be consistent throughout an uses bitmap
application's performance. images to dis-
play device
status.
Availability of textual information Supports. X
(f) Textual information shall be provided
through operating system functions for dis-
playing text. The minimum information that
shall be made available is text content, text
input caret location, and text attributes.
Contrast and color settings Supports. Inter- X
(g) Applications shall not override user selec- Mapper does not
ted contrast and color selections and other indi- override user
vidual display attributes. selected con-
trast and color
settings when
they are avail-
able in the oper-
ating system.
Animation Does not sup- InterMapper has
(h) When animation is displayed, the inform- port. animated traffic
ation shall be displayable in at least one non- flows that have
animated presentation mode at the option of no presentation
the user. mode that is avail-
able to Assistive
Technology.
Color Coding Supports. X
- 15 -
Chapter 1: About InterMapper
- 16 -
Chapter 2
Getting Started
Installing and Launching InterMapper
When you install InterMapper, the installer also includes InterMapper DataCenter
(Pg 613) and InterMapper Flows (Pg 315). During the trial period, all three are
available. Once the trial license expires, you need a license to run InterMapper
Flows, and the correct InterMapper license to run InterMapper DataCenter.
When you launch InterMapper the first time, a Welcome page appears. Use the
shortcuts on the Welcome page to get you quickly to area of InterMapper that will
best get you started.
l Create a new map - opens the New Map window. After naming your map,
you can start the Autodiscovery process to scan your network for devices. All
discovered devices get placed on your new map. Find out more about this pro-
cess in Using Auto-discover. (Pg 59)
l Try out the Demo maps - opens a Demo map as described below.
l Get help - opens the Getting Started page on the InterMapper website.
l Click Do not show this window again and click Continue to Map List.
- 17 -
Chapter 2: Getting Started
No matter which platform you're using, a set of demo maps becomes available
when installation is complete and the program is launched. Watch them operate,
and experiment with them to see how InterMapper operates. For additional inform-
ation, see With Try Out the Demo Maps (Pg 39).
- 18 -
Installing and Launching InterMapper
Note: although many of the features described in this manual are sim-
ilar between the MacOS, Windows, and Unix/Linux platforms, there
are a few differences. We recommend you read the Readme file
installed with your version.
MacOS X
Windows
l Double-click the InstallShield icon for the installer and follow the instructions.
The InterMapper application starts running when installation is complete.
Unix or Linux
l If you're using Unix or Linux, then read the accompanying ReadMe (also
found on the download page) to get instructions for installing on your par-
ticular platform.
If you don't have a license key, click the Request a trial license key link in the
window shown above. A form appears, allowing you to enter some information,
and request a trial license key. When you click Send Request, a license key
appears in the text box. It allows you to use InterMapper to monitor a limited num-
ber of devices for 14 days. Click Register to activate the key.
- 19 -
Chapter 2: Getting Started
Once you've seen the demo, see Using InterMapper (Pg 36) to guide you as you try
out InterMapper's features.
When you purchase InterMapper, we will send you a license key that unlocks the
software permanently. The license key is associated with a specific piece of hard-
ware, so it will allow InterMapper to run only on a particular machine.
A full license - sent to those who purchase the software - never times out. Once
registered, the application will run forever on that machine. If you want to run
InterMapper on a different machine, you will need to request a new license key for
that machine.
InterMapper also supports trial license keys, which allow you to run InterMapper
for a certain number of days before it requires a new key. This gives you an oppor-
tunity to try the program without obligation. When a license key expires, Inter-
Mapper simply ceases to operate. It never deletes or alters files on your hard
drive.
- 20 -
Registering Your Software
l Enter license key now - if you already have a key, click to paste it now.
l Request a trial license key - if you don't have a key, click to request one.
The Request Trial License window appears as shown below.
l Order now - Allows you to purchase the produce.
l When you click Request a trial license key, the Request Trial License win-
dow appears as shown below:
- 21 -
Chapter 2: Getting Started
The license shows the registered name, type of license, and the number of devices
and other licenses associated with this key.
- 22 -
Registering Your Software
- 23 -
Chapter 2: Getting Started
You can enter multiple serial numbers to unlock additional InterMapper func-
tionality. The Registration pane in InterMapper Server Settings window shows
the licenses that are currently installed.
Use these options, available from the Registration pane, to add, delete or view
information about a license or serial number:
- 24 -
InterMapper Control Center
On Windows, InterMapper installs an icon in System Tray (lower right corner) that
does much the same thing. It also uses presents a window to indicate an inter-
esting change in InterMapper's state.
The System Tray Icon and Menu Bar Application are available only on the machine
hosting the InterMapper Server.
On MacOS X
The InterMapper Server Status window shows the server name and version, as
well as the current state of the InterMapper server. This window also allows you to
start or stop the InterMapper server, or open InterMapper.
- 25 -
Chapter 2: Getting Started
On Windows
You can do most of these same functions from the context menu that appears when
you right-click the InterMapper status icon.
Note: When you stop or start a service from the InterMapper Control Center, that
states of those services are maintained when you restart the machine.
l Right-click the InterMapper Control Center icon in the Windows System Tray
and choose Show InterMapper Control Center.
- 26 -
InterMapper Control Center
- 27 -
Chapter 2: Getting Started
If the check has never been run before, InterMapper presents a dialog you can use
to disable the automatic checking before it takes place. At any time, you can dis-
able the feature, either by choosing Preferences from the Edit menu, then choosing
the Behavior->Version Updates pane, or by opening the InterMapper Control
Center. When a new version is available, a message appears, including a link to
the new version
When you first start up a Windows version of InterMapper, a message asks you
would like InterMapper to check for new versions. This is the only time it will ask
this question. If you answer yes, the check is performed at startup and again every
24 hours.
Upon detecting that a newer version of the software is available, a dialog box
appears, indicating that a newer version is available, and asking if you would like
to download the new version.
l Click "Yes" to launch a browser with the URL to the new version.
- 28 -
Automatic Notifications of Updates
3. You can choose which InterMapper notification messages you want to see, or
alter the appearance of specific messages to match their importance. For
example, you can set up DOWN and CRITICAL notifications to display in large
red text, and ignore all other notifications.
4. You can specify that any or all InterMapper notifications are "sticky", each
remaining on screen until you explicitly click it.
5. There are many more options. For example, you can choose to have Growl
speak notification messages or email them to you.
Note: Neither Growl nor InterMapper's built-in status window is used if this
checkbox is not checked.
Growl Control
Use Growl's System Preference panel to configure Growl's behavior.
- 29 -
Chapter 2: Getting Started
You can individually enable or disable any of these messages. You can also specify
different plugins for different messages or specify that certain messages require
you to click on them to dismiss them (the "sticky" option).
After executing the command, you must reopen the InterMapper Control Center
Settings window for this change to take effect.
- 30 -
Installing InterMapper Flows
- 31 -
Chapter 2: Getting Started
This page lists ten thing you can try with InterMapper to get more familiar with it.
You can also refer to the InterMapper User Guide for more information.
1. Try Out The Demo Maps When you install InterMapper for the first time, a
set of demo maps is installed. On the Welcome page, click Try Out The
Demo Maps and take a couple minutes to try the steps listed in the text
you'll see there. When finished, you can click Disable This Map. You can dis-
able the demo map from the Enabled Maps pane of the Server Settings win-
dow.
l Manual Entry You can also add devices manually by typing or pasting
a list of DNS names or IP addresses into the window that appears.
l Create a new map, give it the name "North America" and click
Next >. Check the Manual Entry button, then click Next >. You'll
see the Add Device(s)... window.
l Type www.helpsystems.com and www.example.com and
click Add. Note that they appear as devices (rectangles) and turn
green a few moments afterward. (InterMapper is already testing
them.)
l You can add a background image to make the map look better.
Drag the NorthAmerica.jpg from the Hands-on Extras folder to
map window and it will appear as the map's background.
l Choose Window > Zoom window to resize the map to the
image.
l Drag the rectangles to the desired location on the background
map.
- 32 -
InterMapper Quick Tour
map.
l Open the North America map and position it and the Map List so
you can see both windows.
l Drag the icon for Unalakleet from the Map List into North America
map.
l Drag the icon for the Local Network map in a similar way.
l Drill down by double-clicking the Local Network icon on the top-
level North America map. You'll see the Local Network map open
up.
3. Making Attractive Maps There are a number of techniques for making the
maps look more attractive, or to convey more information. Things to try:
l Drag items around to match the way you think of your network. Lines
between devices "rubberband" to preserve the interconnections.
l Add a background image to position devices as you like. Simply drag
a PNG, JPEG, or GIF image into the map window to add it, or choose
Edit > Map Settings...
l Select different icons and shapes for devices Choose Format >
Icon... to pick new icons for the devices.
l Change labels on devices The label is the text that appears in/next
to the icon on the map. To edit a device's label, choose Format >
Label... or Ctl/Cmd-L.
l Arrange devices on the map Use different options in the Format >
Arrange... menu .
l Align command The Format > Align (Ctl/Cmd-Shift-K) command
aligns items vertically and/or horizontally.
l Add a link between devices Select two devices, then Insert > Add
link (Ctl/Cmd-E)
l Connect multiple devices to a point Select the devices, then
choose the context menu Attach to... Lines will rubberband, and stick
to the object you next click.
l Automatic This probe uses either Pings or SNMP queries to monitor the
device. If the device speaks SNMP, InterMapper will use the SNMP
Traffic probe to query the device. If not, InterMapper will ping the
device and report if it ever goes down.
l SNMP Traffic The SNMP Traffic probe monitors traffic on routers,
switches, etc. It works with nearly all network gear from different
vendors.
l Network Devices There are many probes for monitoring various
other equipment, such as Cisco, Apple, APC and other UPS vendors, and
other equipment.
- 33 -
Chapter 2: Getting Started
5. Alerts and Notifications InterMapper can put a device into one of five
states: OK, Critical, Warning, Alarm, Down. Each time the device goes into a
new state, InterMapper can trigger a notification/alert.
l Create Notifiers Notifiers are like a robot that watches a device and
performs some action to send an alert when it changes state. Choose
Edit > Server Settings and scroll to the Notifier List at the bottom.
Add an e-mail notifier for yourself.
l Examine various notification types Mail, pager (analog modem and
SNPP), command line, trap, group, syslog.
l Look at schedule Alerts will only be triggered during the selected
schedule, otherwise they are ignored.
l Finally, Attach a notifier to a device To attach a notifier, choose
Monitor > Notifiers window and check the boxes for the states that
should trigger a notification.
- 34 -
InterMapper Quick Tour
9. Edit > Server Settings The server settings shows the preferences for a
server.
10. InterMapper RemoteAccess Allows you to have all this fun, but from any-
where on the Internet
- 35 -
Chapter 3
Using InterMapper
You experience InterMapper through the Map List Window (Pg 46), where you view
a list of available maps. when you open a map, it appears in a Map Window (Pg
41).
If you are using InterMapper RemoteAccess (Pg 373), you may be viewing more
than one map list in the Map List window; one for each server.
You can customize InterMapper by defining Helper Applications (Pg 78) and by spe-
cifying what actions should be taken when you double-click an object on a map (Pg
83). You can also set user preferences (Pg 53) for InterMapper and InterMapper
RemoteAccess.
Creating Maps
Use this section to find out how to start your map (Pg 57), to use Autodiscovery (Pg
59) to find and map each device on your network, and to add devices (Pg 65) and
networks (Pg 68) manually. Once you are familiar with what maps are and how
you can use them, you can add devices to your map by importing them (Pg 637),
and can export data from maps (Pg 635) for use in spreadsheets and databases.
You can even place a physical map image in the background (Pg 104) of your map,
and use geographic coordinates (Pg 640) as you import to place devices auto-
matically at specific locations in relation to the background image.
Use InterMapper's different probe types (Pg 66) to query your devices in spe-
cialized ways to give you more accurate information about the states of those
devices.
As you become more familiar with what InterMapper can do, you can add networks
(Pg 68) and scan them (Pg 70). You can create sub-maps (Pg 71), allowing you to
view large networks through an overview map, "drilling down" to see more detail
as needed.
Once you have created your map, you may want to rearrange devices into logical
groups (Pg 99), change the appearance of devices (Pg 101), change the device
labels (Pg 106), or add text (Pg 409) or a background image (Pg 104). For maps
with large switches, you may want to hide some detail (Pg 128). For tips on arran-
ging your map, see Arranging Tips (Pg 119).
- 36 -
Chapter 3: Using InterMapper
You can set up devices to alert you to problems (Pg 129) in a number of ways.
When a device goes the specified state, a notifier is triggered, and alerts you to the
problem.
You can create your own notifiers (Pg 131) and configure them (Pg 139) to send an
E-mail message (Pg 144), page (through a modem or network (Pg 155)), send a
text message (Pg 151) to a cell phone, or execute a script or system command (Pg
160). You can also open a WinPopup window (Pg 165) on a Windows machine, send
an entry to a Syslog server (Pg 166), or send an SNMP trap (Pg 167).
l For each map, you can define a default set (Pg 86) of notifiers to be attached
to a device.
l You can attach one or more notifiers (Pg 133) to one or more specific devices.
l You can create groups of notifiers (Pg 146) and assign them to a device all at
once.
l You can attach a notifier to one or more interfaces (Pg 164) on a device.
If a device goes down, and other devices are attached to that device, you can set a
Vantage Point (Pg 136). InterMapper can then determine that the attached devices
are dependent on the down device, and will not send notifications for those
devices.
InterMapper begins polling devices as soon as you create your map. A great deal
of information is immediately available by viewing the Status window (Pg 185) for
a device, network, or link. You also view and edit a device or network's inform-
ation from its Info window (Pg 188). For routers, switches, or other devices with
interfaces, you can view status or other information about specific ports through
the Interfaces window (Pg 195).
l For devices, you can set thresholds for packet loss (Pg 200) or network traffic
(Pg 208), and InterMapper alerts you when a behavior is out of range.
l For links, you can set thresholds Error, Link Utilization, and Interface Dis-
cards.
l You can set default thresholds the server, a map, or a device.
You can create charts (Pg 219) that graph one or more data values associated with
a device. You can also view a detailed Event log (Pg 235) and Outage log (Pg 246)
to help you troubleshoot problems accurately. You can even create new log files
(Pg 257) for logging specific data.
If a device or link goes down, you can acknowledge the problem (Pg 202), which
prevents InterMapper from continuing to send notifications. There are several
options for acknowledging problems that allow you to control the resumption of
notifications after acknowledgment.
- 37 -
Using InterMapper
You can collect data from devices (Pg 626) and save it in the InterMapper Database
(Pg 615), through the InterMapper DataCenter. The data can then be retrieved for
use in reporting and analysis. You can set policies (Pg 618) to specify how much
data is retained and how long it is retained.
Server Settings
Use the Server Settings panel (Pg 249) to view information about InterMapper (Pg
251), to set preferences (Pg 253), and to configure (Pg 277) InterMapper's Remote
(Pg 282), Web (Pg 289), Telnet (Pg 291), and Authentication (Pg 623) servers. You
can also maintain InterMapper's firewall (Pg 278) and user (Pg 298) list, enable
and disable (Pg 296) or control access to maps (Pg 305), and create notifiers (Pg
308).
InterMapper Reference
Troubleshooting InterMapper
Use the Troubleshooting section to help you learn about IP addresses (Pg 726),
Domain Name Servers (Pg 730), SNMP (Pg 731), WINS Names (Pg 735), and view
a number of frequently-asked questions.
- 38 -
Chapter 3: Using InterMapper
The image below shows a portion of an example map with a number of devices
(rectangles) connected by various kinds of links (lines).
Here are some tips to help you understand the various items on the map:
l Devices are displayed in green to indicate that the device is up and running.
l Devices that are down blink red when InterMapper cannot communicate with
them.
l Click and hold a device to see a status window of detailed information and
outage history, or Right/Ctrl-click it and choose Status Window from the
dropdown menu.
l You can tear off these status windows to keep them open by dragging the
mouse outside their boundary.
l You'll hear sounds to indicate that there have been failures. (InterMapper
can send e-mail or pages, too!) To silence these alarms, choose Prefer-
ences... from the Edit menu, click the Sounds subcategory of the Behavior
category and clear the Play sound notifications check box.
l Lines (links) show dotted lines (ants) when traffic exceeds a threshold
l Links get a yellow or orange background when traffic exceeds 50% or
90%, respectively.
l Circles at the ends of links (they look like raindrops in puddles) indicate
errors that have been detected by the interface.
- 39 -
Try out the Demo Maps
In addition, there are other things you may note on the map as it operates:
l Some devices become dim from time to time. That's because they're being
shadowed by another failure on the map. We also say that those shadowed
devices depend on all the devices on the path to it. InterMapper can auto-
matically detect this state and will avoid notifying the network manager about
outages if the dependent devices are unreachable because of the other fail-
ure.
l On several of the demo maps, a star appears on a device. That means that
it's the Vantage Point for "shadowing". InterMapper will suppress notifications
for a device if it's not possible to reach the device from the Vantage Point
without going through a failed device. (It's in the "shadow" of a failed
device.")
- 40 -
Chapter 3: Using InterMapper
For an in-depth explanation of the elements that appear in the map window, what
they mean, and how to use them, see Monitoring Your Network (Pg 180).
- 41 -
The Map Window
The Title bar shows the map's title, its state, and has standard controls for zoom-
ing, minimizing, and closing the window.
For a complete reference for each menu, see the Command/Menu Reference (Pg
374).
The Toolbar
The Toolbar contains buttons to toggle the map's edit mode and to switch from one
view to another.
l Click the Lock button at the left end of the tool bar to switch the map between
Monitor mode and Edit mode:
Map view
Shows the map graphically, showing devices, networks, and their inter-
connections.
List view
Shows the devices on the map as a list, with columns for the device's status,
name, address, probe type, and current and previous condition.
- 42 -
Chapter 3: Using InterMapper
l Drag items from one map to another. The source map must be in List
view. The target map must be editable, but can be in another view.
l With a server selected in the map list, choose Device List from the
Map List window's Window menu. A list of all devices on the selected
server appears.
l Select a particular notifier from the dropdown menu; you can see the
checkboxes for all its recipients.
l To set a value for all devices, hold Alt or Option, and set a value. The
value you changes to the selected value for the entire column. This
works on all check boxes, as well as on the Delay, Repeat, and Count
columns.
Link Notifiers view
This view lets you see which notifiers are attached to interfaces on a map.
Attach notifiers to interfaces in exactly the same way as in the Device Noti-
fiers view.
Chart view
Shows the list of charts for the map.
Dataset view
This view shows the datasets available for charting and data collection in
- 43 -
The Map Window
this map. With the map in edit mode, you can choose a retention policy for
any dataset.
The Map legend to the right of the toolbar shows the different states of the map
and the number of devices in each state. It also acts as a filter in list view.
- 44 -
Chapter 3: Using InterMapper
l Click a legend icon to view a list of devices that currently in that state.
l Click the icon again to go back to the previous view.
l Shift-click icons to view devices in more than one state.
Example: Shift-click the Alarm and Warning icons to see any devices in
either of those states.
l Click one of the Acknowledge Filter buttons (to the right of the legend) to list
only acknowledged or un-acknowledged devices.
Note: The filter buttons work with in concert with the legend icons - clicking a
Filter button shows only the devices in the selected state that are acknow-
ledged or un-acknowledged. It is possible to click a filter button and see no
devices.
The Map area is the "canvas" on which you create your map. To get started, take a
look at Creating Maps. It is full of information about starting your map (Pg 57). The
Creating Maps section is full of information for creating (Pg 57), arranging (Pg 99),
and making your map look just the way you want (Pg 99) it to look. You'll also find
a quick reference of editing shortcuts (Pg 95).
For an in-depth explanation of the elements that appear in the map window, what
they mean, and how to use them, see Monitoring Your Network (Pg 180).
The Status bar contains controls for switching in and out of map edit mode, setting
the polling interval, and zooming the map.
- 45 -
The Map List Window
l With InterMapper, you can control all aspects of the InterMapper server run-
ning on your local machine. You can also disable a map by right-clicking it and
choosing Disable Map.
l With InterMapper RemoteAccess, you can access multiple InterMapper Serv-
ers from the same machine. If you have administrator access, you can edit
all server settings on a remote server. You can also disable a map by right-
clicking it and choosing Disable Map.
The menu items available in the File menu differ slightly between InterMapper and
InterMapper RemoteAccess. For more information, see the File Menu (Pg 375) ref-
erence.
Use the Map List window to view a list of maps. If you have InterMapper RemoteAc-
cess, you can also view a list of other available InterMapper servers, to log into
one or more servers, and to view a list of maps currently running on each server.
Here are a few tips for getting the most out of the Map List window:
- 46 -
Chapter 3: Using InterMapper
Quick Menus
Use the quick menus at the bottom of the map list window to access frequently
used functions.
You can arrange your maps into folders as shown above, using the Server Con-
figuration>Enabled Maps pane of the Server Settings window. For more inform-
ation, see Enabled Maps (Pg 297).
From the Map List window, you can view a list of all devices on a particular server.
l With a server selected in the map list, choose Device List from the Map List
window's Window menu. A list of all devices on the selected server appears.
- 47 -
The Device List Window
List View
Use the Device List view to see a global list of devices used in all of the
maps on the InterMapper Server.
- 48 -
Chapter 3: Using InterMapper
dition:
Date & Time: Shows when the device entered the previous condition
Probe Type: Shows the probe type for the device
Address: Shows the network address of the device
Map Name: The name of the map in which the device appears
- 49 -
The Device List Window
l Double-click an entry in the Device List to switch to the proper map, and high-
lights the particular device with zooming rectangles.
l Sort the list by clicking a column heading. Click again to re-sort in the oppos-
ite order.
l Resize columns by dragging the separator between the columns to the proper
size.
l Re-order the columns by dragging a column to a new position in the Device
List window.
Notifier View
Use the
Notifier
List
view to
view a
list of
devices
attache-
d to the
selec-
ted noti-
fier,
and all
set-
tings
for that
noti-
fier-
/device
com-
bin-
ation.
- 50 -
Chapter 3: Using InterMapper
Using the Notifier List view, you can quickly attach a notifier to a device or check
to see which devices are attached to a given notifier. You can set delay and repeat
parameters to control escalation of a problem.
Layer 2 View
Use the Layer 2 List view to view a list of switches, VLANs and NIC
manufacturers, with a list of devices connected to each.
For more detailed information on the Layer 2 view, see The Layer 2 View.
- 51 -
Understanding the Layer 2 View
l The Endpoints pane (Pg 347) - the upper right pane lists all switch ports
and the devices connected to them. It contains only those ports and devices
that match the filter criteria in the Filter pane.
l The Filter pane (Pg 345) - the left pane provides criteria for showing or hid-
ing endpoints based on their presence on a particular switch, VLAN, or the end-
point's manufacturer. lists available switches, the VLANs in which they
appear, and manufacturers of network interface cards of the devices con-
nected to them. Use the check boxes to select or hide endpoints in the End-
points pane, and type additional criteria to help select the endpoints you want
to view.
l The Connections pane (Pg 348) - the lower right pane provides details
about switch-to-switch connections.
- 52 -
Chapter 3: Using InterMapper
InterMapper
RemoteAccess
- 53 -
InterMapper User Preferences
Us-
e
the
InterMapper
Pr-
eferences command, available from the Edit menu, to set user preferences for
the InterMapper user interface. These settings affect only the copy of the Inter-
Mapper or InterMapper RemoteAccess you are running - it does not affect other
users' settings.
Map Style
Use the Map Style panel to set your preference for the style in which your maps
are displayed.
- 54 -
Chapter 3: Using InterMapper
Sounds
Use this panel to enable or disable sound notifications. Select or clear the Play
sound notifications check box to turn sounds on or off.
Language
Use this panel to specify the language you InterMapper to use in its user interface.
To change the language from the system default, choose your language from the
Language Options dropdown menu. All available language options are listed.
Double-Click
Use this panel to specify a default action to take for a device or network that
doesn't have an action assigned. Use the Action dropdown menu to choose from
these options:
Windows
Use this panel to specify whether charts and status windows are hidden when a
map becomes inactive. You can also reset the state of "Ignored" windows.
l Hide charts and status windows when Map is inactive - Click to select
this check box to hide charts and status windows for any map that is not the
active window. If the box is not checked, any open charts and status windows
remain open.
l Reset Ignored Windows - a number of alert messages provide the option
not to show the message again. Click this button to reset the state of all
Ignored windows.
Use this panel to specify whether or not to search for InterMapper servers on the
local LAN.
- 55 -
InterMapper User Preferences
Version Updates
Use this panel to enable or disable the Automatic Update function by selecting or
clearing the Automatically check for updates box and select Daily, Weekly,
or Monthly from the dropdown menu. This function is also available from the Inter-
Mapper Control Center (Pg 25). To check for updates immediately, use the Check
Now button on the InterMapper Control Center.
Logs
Use this panel to control the amount of information saved in the server log and
whether to save it to disk.
l Log Line Count - Specify the number of lines of the server log that appear in
Debug, Event or Outages Log window. This can reduce the amount of memory
required to display a log window.
l Client Debug Log - Select the Store Client Debug Log on disk check box
to save the debug log to your local disk.
Animation
Use this panel to specify your preference for animation settings. Faster animation
looks better, but may use more CPU power than you would like, if you are running
a slower CPU or have some very large maps.
l Select or clear the Display Animations check box to turn animations off or
on. (They are off by default.) This turns off traffic indicators (ants) and trans-
ition effects (scale changes, scrolling to found devices, effects when windows
opening or closing, etc.)
l Animation rate - Choose an animation rate by moving the slider left for
slower rates or right for higher ones. The selected rate appears in the upper
right above the slider.
Graphics
Use the Anti-aliasing controls to smooth the jagged look of diagonal and curved
lines. Some users find that anti-aliased text or lines are blurry or fuzzy. Select or
clear the check boxes to apply anti-aliasing to text or graphics.
Note: The Anti-aliasing settings are "hints" to help the graphics system render the
graphics. The settings may be ignored by some systems.
Use the Image Scaling slider to choose level of quality to use when viewing maps
at a zoom level other than 100%. The algorithm you choose may affect application
performance.
Use this panel to specify whether to show a task bar icon for the InterMapper Con-
trol Center.
l Show status in task bar - Select this checkbox to show the status icon in
the task bar (Windows) or menu bar (Mac).
- 56 -
Chapter 4
Creating Maps
Starting Your Map
When you launch InterMapper, a Map List window appears. It contains several
demo maps, which show examples of network maps, and contains brief descrip-
tions of the elements appearing on the maps. Double-click a map to open it.
After you have explored the demo maps, you are ready to use the Auto-discover
function to create your first map.
To create a new map, choose New Map... from the File Menu. The New Map Con-
structor window appears:
Enter a map name, and click Next >.The second page of the New Map Constructor
appears.
- 57 -
Chapter 4: Creating Maps
For information on using the Auto-discover function, see Using Auto-discover (Pg
59).
You can also create a map by importing data in a text file. For more information,
see Importing Data Into Maps (Pg 637).
InterMapper Labels
InterMapper places a label on each device it finds. By default, it uses the device's
full DNS name. Networks are labeled with both an IP address and the number of
bits in the subnet mask (indicating the network range). For example, the network
labeled 192.168.1.0/24 indicates that the IP devices are in subnet 192.168.1.0,
with a subnet mask of 24 bits (255.255.255.0).
Note: You can change the label that appears for each device using the Label...
command, available from the Format menu (Pg 411).
- 58 -
Using Auto-Discover
Using Auto-Discover
You can use Auto-Discover to create a new map. If your network contains Layer 2-
enabled switches, you can also use Layer 2 information to increase the accuracy of
a map's representation of your network topology. For more information, see Map-
ping With Layer 2 (Pg 353).
For existing maps, you will need to use the manual technique (Pg 353) for con-
verting the map. For new maps you create with Auto-Discovery, use the automatic
technique (Pg 353).
To Auto-Dis-
cover to cre-
ate an initial
network map:
1. From the
File menu,
choose
New... The
New Map
Con-
structor win-
dow
appears.
2. Enter a map
name and
click Next.
3. Click to
choose
Auto-dis-
covery,
then click
Create.
The Auto-
matic
Device Dis-
covery win-
dow
appears, as
shown
below.
- 59 -
Chapter 4: Creating Maps
4. Enter a host
name or IP
address you
want to use
as the start-
ing point for
auto-dis-
covery.
A name is
suggested for
you. It is the
DNS name or
IP address of
a router, or if
there's no
router, the
computer InterMapper is running on. Use the default value, or enter any of
the following:
l A DNS name
l An IP address (if you want to create a map of another part of a net-
work.)
If you enter the name or address of an SNMP-speaking router, Inter-
Mapper draws interconnections to other routers in the network more
quickly.
5. If you have SNMP-speaking devices in your network, specify an SNMP Com-
munity (Pg 731) string.
6. Select your Discovery Options, as explained in The Auto-Discovery Window
(Pg 61) below.
7. Click the Filter button to set a filter for the discovery.
8. Click OK to start the Auto-discovery process. A Discovery Status bar appears
as shown. The status bar shows progress statistics for subnets, queued
routers, and addresses remaining to be scanned:
9. As the network is scanned, discovered devices appear in the current map (or
in a list if you have cleared the Automatically Layout check box.) When
InterMapper has found all the devices within the specified subnet, the Dis-
covery Status bar disappears.
l Click the Map View button near the upper left corner of the Map window to
view your network as a map, showing devices and networks as icons, with
the interconnections between them.
l Click the Cancel button. The discovery process is stopped, and no new
devices or networks are added. All devices added before you stopped the pro-
cess remain in the list.
- 60 -
Using Auto-Discover
You control the starting point, the SNMP Community string (Pg 731), the breadth of
the network search, and the kinds of devices that are automatically added to the
map using this window.
l Starting
host name -
The DNS
name (Pg
730), IP
address (Pg
726), or
WINS name
(Pg 735) of a
device to use
as a starting
point for the
auto-dis-
covery.
l Specify an
SNMP com-
munity -The SNMP Read-only community string to be used to interrogate all
devices. (InterMapper attempts to read SNMP information using the specified
community string. It is set to 'public' by default.)
l Stay within NN hops of starting device - Stops autodiscovery after Inter-
Mapper has searched the specified number of hops from the starting device.
l Scan for devices on all networks - Specify which kinds of devices should
be automatically added to the map. Click to check this box, or click Edit Fil-
ters... to open the Network Scanning window.
l Click Automatically layout to let InterMapper layout the map auto-
matically.
l Click Start Discovery to initiate a scan of the specified host.
- 61 -
Chapter 4: Creating Maps
l Active - Inter-
Mapper per-
forms a
complete IP
address scan for
each network. A
device is added
for each IP
address that
responds.
l Named - Each
IP address in the
subnet is looked
up in the DNS. If
a corresponding
name is present,
the device is added to the map.
l SNMP - InterMapper sends an SNMP GetRequest to each address in the
range. Any device that responds is added to the map and uses the SNMP Basic
Traffic probe. If the device does not respond to SNMP, the probe is set to
Ping/Echo.
l HTTP - If the device responds to an HTTP request, an HTTP probe is added to
the device (along with SNMP Basic Traffic or Ping/Echo probe), and the device
becomes a probe group.
- 62 -
Using Auto-Discover
To create your maps more quickly, you can type or paste one or more
host DNS names (Pg 730), IP addresses (Pg 726), or WINS names (Pg
735) into the Add Devices... window (Insert menu). (WINS names must
be preceded by "\\".) InterMapper immediately adds them to the map
and connects them to the proper network.
You can also import a list of devices from a text file. For more inform-
ation, see Importing Data Into Maps (Pg 637) .
- 63 -
Chapter 4: Creating Maps
- 64 -
Adding Devices Manually
Note: If you enter a DNS name, the device is added to your map only if a DNS
entry can be found.
Note: If any of the device names cannot be resolved (if a device name is not con-
figured in your domain name system server) or if a device cannot be tested with
the selected probe, don't worry; you'll get a chance to correct the entry.
IPv6 Note: To ensure that when possible, host names are resolved to IPv6
addresses rather than IPv4 addresses, enclose the host name in square brackets
([]) as shown in the example.
- 65 -
Chapter 4: Creating Maps
l The left pane contains a hierarchical list of probes, divided into sections and
subsections.
l The right pane shows the description and configuration options for the selec-
ted probe.
For a comprehensive list of probes with descriptions, see the Probe Reference
(Pg 438).
1. Choose a section - In the left pane, click plus (+) to expand the section and
subsections to view the probes. Click minus (-) to collapse an expanded sec-
tion or subsection.
- 66 -
Set Probe Window
2. Choose a probe - In the left pane, click a probe within a section or sub-
section to select it. The description and options for the probe appear in the
right pane.
3. Set the probe's options - In the right pane, enter or select the options you
want to use with the selected probe. These options vary, depending on the
probe. Click Default to reset the probe's options to the default settings.
4. Click OK to choose the probe.
Import a probe - click this button and select from a standard file dia-
log to import a probe file.
Reload probe list - click this button to reload the list of probes found
in the InterMapper Settings/Probes folder.
More Click this button to launch your browser and view a list of probes con-
Probes... tributed by InterMapper users.
- 67 -
Chapter 4: Creating Maps
Note: Adding a subnet does not automatically initiate the discovery process.
To scan the new network, right-click the new network oval and choose Scan
Network... For more information, see Scanning a Network (Pg 70).
- 68 -
Adding Networks to the Map
InterMapper may not connect devices to the proper network in every case. In such
a case, you can make the connection manually.
4. Click the object you want to connect to. A link is created between the two
objects:
- 69 -
Chapter 4: Creating Maps
Scanning A Network
InterMapper can scan an IP address range to discover all the devices on that net-
work. It then adds those discovered devices to the map, and connects them to the
proper network.
To scan a network:
or
- 70 -
Creating Sub-maps
Creating Sub-maps
Another way to hide detail is to create a top-level map that gives an overview of
many individual maps. Each icon on the top-level map shows the status of another
map (a "sub-map"). The color of the icon indicates the most serious condition (the
"worst thing") on its sub-map. These sub-maps can be on the local computer, or
could even be on another InterMapper server.
The example below shows the Atlanta map that opens when you double-click the
Atlanta icon on the National map. Notice that on the National map, the Atlanta icon
is "down". The Atlanta map shows that the LDAP server is the reason.
- 71 -
Chapter 4: Creating Maps
Creating a Sub-Map
Use the Map Status probe to create an icon that represents a sub-map. To do this,
you add a device with the address of the InterMapper server on which the map is
running, (127.0.0.1 if it's on the local computer) with a Probe Type of Map Status.
The color of the icon for a map item using a Map Status probe indicates the most
serious condition (the "worst thing") on sub-map.
1. The easiest way to add a submap is to drag the desired map from the Map List
window to the map. In certain special cases, the Set Probe window appears,
with the Map Status Probe selected.
2. Click OK to accept the default settings. A new device is added, using the cur-
rent map and user account information.
- 72 -
Creating Sub-maps
Note: if your map is nested in a sub-folder, you must enter the full path to
the map. For example, "/MySubFolder/MyMap.map". If you add the submap
by dragging it into the map from the Map List window, the path is entered
automatically.
6. Enter the User Name and Password of an account on that server. This
account must have read-access to the map.
7. Click OK. The new icon appears on the map, and its color reflects the state of
everything on the sub-map.
l Double-click the sub-map's icon. The map opens, and you can see and modify
(if you have been granted permission) the settings on the sub-map.
Try to follow these best practices when setting up a map status probe:
For example, let's assume you have access to map status probes on server S,
and that we have MapB and MapC on server S that you don't have access to.
When you double click a map status probe for MapB, the InterMapper client
will log you in as user B (you are logged in twice on server S). You will not be
able to open MapC before you log off the connection to MapB. This restriction
is only for one server, if you are using map status probes to monitor maps on
multiple InterMapper servers, you can use a different username for each
server.
- 73 -
Chapter 4: Creating Maps
Use a probe group to include multiple probes targeting the same IP address into a
single icon on a map. A probe group shows the worst status among the probes in
the group. A probe group counts as a single device against your license count.
Note: Only those devices that reference the same IP address can be added to a
group.
Each probe group can contain a control probe. Setting a control probe affects the
probe group as follows:
l When a control probe is defined, no notifications for the other probes in the
group are sent if the control probe is down.
l The group's interfaces match those of the control probe.
Here are some important facts about how devices are probed after grouping.
l Each member probe is polled at its own rate, with its own settings.
The settings in place when the device is added to a probe group are used,
including poll rate, attached notifiers, and probe parameters. You can edit the
settings for any probe - see Editing Settings for a Probe Within a Probe Group
(Pg 76).
l The device icon's state reflects the most serious condition of its
member probes. When the state of one of the member probes becomes the
most serious state, the device icon's state changes to reflect it.
l By attaching a notifier to the device, you can get notifications whenever
any probe in the group has a problem.
l By attaching a notifier to a member of the group, you can get noti-
fications when that member probe has a problem
l If the control probe is down, no notifications are sent for any other mem-
ber of the group.
l Interface information is shown based on the selected control probe.
Use the Group command to create a probe group from a set of selected devices.
- 74 -
Creating Probe Groups
Before grouping
After grouping
Note: When you group a selection of probes, the
resulting group uses the first line of the first
device as its label. You can change the label
before or after grouping.
Creating one or more empty Probe Groups
You can create an empty probe group, then add probes to the group as needed.
1. From the Insert menu, choose Empty Probe Group... The Add Probe Group
(s) dialog appears.
2. For each probe group you want to add, enter a host name or IP address.
3. Click Add. A probe group icon appears for each host name or address you
entered.
- 75 -
Chapter 4: Creating Maps
1. Select the group and the devices you want to add to it.
2. Choose Group from the Insert menu. If all selected devices use the same IP
address or host name, the selected devices are added to the existing probe
group.
1. From the probe group's Info window, click the plus (+) button. The Set
Probe window appears.
2. Choose the probe you want to use, set its parameters, then click OK. The
probe is added to the group.
From the List view, you can also drag a probe out of a probe group.
Each probe in a probe group can be polled at its own rate, can have its own set-
tings, and can be edited while part of the group.
1. Double-click the probe group's device icon. The Info window opens, showing
the list of probes in the group.
2. Double-click to open the Info window for the selected probe, or right-click-
/Ctrl-click the probe, and choose an option from the context menu.
- 76 -
Creating Probe Groups
You can set the control probe for a probe group. If the control probe is down, no
notifications are sent for any other member of the group, and the group's inter-
faces match those of the control probe.
1. With the map editable, double-click the probe group icon. The Info window
appears.
2. Click Probes in the left panel. The probes in the group appears.
3. In the left column of the probe list, click the star icon for the probe you want
to use as the control probe. The color of the star changes to indicate that the
probe is the control probe.
- 77 -
Chapter 4: Creating Maps
1. Control-click or right-click
on a device.
2. Select one of the helper
The Helper apps context menu
applications to launch it
using the device as its tar-
get.
For example, the 'Ping' helper application invokes the system's ping utility:
generally /sbin/ping on Unix, Linux or MacOS X, or ping on Windows. Includ-
ing a URL as the helper application will invoke the system's tool configured to
handle the URL.
Notes:
l You can specify the same helper application for several devices at the same
time if more than one device is selected. The helper app is invoked for each
selected device.
l The helper application that is invoked is platform-dependent: generally, Inter-
Mapper will open a terminal program and issue a command to run the helper.
l You can choose to invoke a Helper Application by double-clicking a device.
See Using Double-Click Actions (Pg 83) for more information.
- 78 -
Using Helper Applications
or
This window shows the list of built-in helper apps and any user-added helper applic-
ations. To add, edit, or remove a helper application, see Adding or Editing Helper
Apps below. It also describes the Launcher, a platform-specific tool used to launch
a helper app.
- 79 -
Chapter 4: Creating Maps
To add a new
helper applic-
ation:
l In the Helper
Apps window,
click the Plus-
button (+).
The Create
Helper App win-
dow appears,
showing
default values
for the new
helper.
To edit an exist-
ing helper:
l In the Helper
Apps window,
click the helper
you want to
edit.
l Click the Pencil
tool. The Edit
window
appears, show-
ing the current
values for the
selected
helper.
Finally, the Command Line is the actual string that will invoked. You can con-
figure this string using the ${TITLE}, ${PATH}, ${ARGS}, and ${LAUNCHER} mac-
ros that will be substituted when the command is invoked. In addition, you may
use the ${ADDRESS}, ${PORT}, ${LABEL}, or ${DEVICENAME} macro.
- 80 -
Using Helper Applications
You can remove any helper application definition you have created. Built-in helper
apps cannot be removed.
1. In the Helper Apps window, click the helper you want to remove.
2. Click Remove...
The Launcher
The Launcher is a
platform-specific
program that allows
you to invoke
another program
from InterMapper.
- 81 -
Chapter 4: Creating Maps
You can export your current Helper Application settings and import them to
another instance of InterMapper.
1. From the Helper Apps window's Tools menu, choose Export... A standard file
dialog appears.
2. Specify a file name and location, and click Save.
1. From the Helper Apps window's Tools menu, choose Import... A standard file
dialog appears.
2. Navigate to the Helper Apps definitions file you want to use, and double-click
it or click it and click Open. The Helper Apps definitions are replaced with the
definitions in the selected file.
For each platform, there is a default value for each built-in helper app. You can
reset a helper app to its default values.
l Click the Default button. The launcher string is reset to the default value for
that platform.
Note: You don't have to use the launcher for any helper, but it's often the easiest
way to invoke another program on your computer.
- 82 -
Using Double-Click Actions
To change a double-click action, right-click on the device, and select the proper
choice from the sub-menu:
Helper App
URL
- 83 -
Chapter 4: Creating Maps
intermapper://Host:Port/MapName
l Host is the address or DNS name of the InterMapper server hosting the map .
Use $SAMEHOST$ to get to a map on the same InterMapper server.
l Port is the port for the specified InterMapper server
l MapName is the name of the map, URL-escaped (%20 for a space, %3D for
a slash,etc)
Example
The Example.com demonstration submaps have links back to the Example.com par-
ent map that look like this:
intermapper://$SAMEHOST$:8181/Example.com%20National%20Map
Built In
- 84 -
Saving Your Map
When you make a change to a map, the change is saved immediately, auto-
matically, every minute or so.
If for some reason you want to make changes to your map, but you want to be able
to get back to your original version if necessary, you can make a backup of your
map.
When you make a backup file, it stores references to your original chart data. If
you decide to restore a previous version, your chart data remains available.
To make a backup:
1. From the File menu, choose Backup... The Backup Map window appears,
showing a list of previous backups of the current map.
2. In the Backup Name box, enter the name you want to use for the backup
file.
3. Click OK. A backup of the current map is created.
Use the Restore... command, available from the File menu, to restore a previous
version of a map.
1. From the File Menu, choose Restore.... The Restore from Backup window
appears, showing a list of previous backups of the map.
2. Click the backup you want to use to restore the map.
3. Click Restore. The map is restored to the backup version.
Backup Types
- 85 -
Chapter 4: Creating Maps
- 86 -
The Map Settings Window
From the Appearance section of the Map Settings window, choose Colors... The
current colors for the map appear.
InterMapper has a default color scheme that is controlled by the default map colors
(Pg 265) window. This color scheme applies to all new maps, and to those maps for
which the Use server defaults box is checked.
For an explanation of each color you can change, see Colors you can change (Pg
266), which explains the meaning of each default color.
- 87 -
Chapter 4: Creating Maps
3. Click to choose a color, then click OK. The new color appears in the color box
you clicked.
4. Repeat steps 2 and 3 for each color you want to change.
5. Click OK.
You can define a background image for any map. The background image appears
behind the map contents - the devices, icons, and links on the map.
You might use a background image containing a floor plan of an office, and move
the items on the map to show the locations of each device in the office. You might
use an image containing street map of a city or topographic map of a county or
state.
- 88 -
The Map Settings Window
InterMapper can provide warnings or alerts when interface errors, packet loss, or
round-trip times get too high. You can set default thresholds for all of these met-
rics from the Map Settings window.
l Use Server Defaults - check this box to override the map settings and use
the server default settings.
l Down Thresholds - Enter the number of lost packets required to generate a
Down state.
l Other Thresholds - For each metric, in each column enter a value required
to generate the a Warning, Alarm, or Critical state.
- 89 -
Chapter 4: Creating Maps
Use the Interface Thresholds pane of the Map Settings window to set Error, Link
Utilization and Discard thresholds for a specific map. These settings are applied to
interfaces on each new device added to the map.
1. Clear the Use server defaults check box for the threshold type you want to
make specific to this map.
2. Set the thresholds for the selected threshold type, as shown below.
3. Click OK.
Note: You can also set thresholds for an individual link. For more information, see
XXX.
- 90 -
The Map Settings Window
Use traffic indicators to help you view network activity on a map. You can set the
traffic levels at which "moving ants" appear to show you the level and direction of
activity on a particular link.
You can set the following values to control the appearance of traffic indicators:
l Traffic units - choose bytes or frames per second from a dropdown menu.
This unit is used for traffic thresholds.
l Some traffic - enter the number (of bytes or frames per second) that rep-
resents some traffic.
l High traffic - enter the number (of bytes or frames per second) that rep-
resents high traffic.
l Large Frames - enter the number of bytes per frame that represents a large
frame.
l Errors per minute - enter the number of errors per minute that represents
a clear sign of trouble.
1. In an editable map, choose Map Settings from the Edit menu. The Map Set-
tings window appears.
2. In the left pane, click Traffic Indicators. The current traffic indicator set-
tings for the map appear in the right pane.
3. Enter the settings you want to change, and click OK. The map uses the new
settings.
- 91 -
Chapter 4: Creating Maps
Use the Map Settings window to specify the notifiers you want to attach to new
devices in this map by default.
l For each map state, select the check box for each notifier you want to attach
to that state. For more information, see Working With Notifiers (Pg 131).
l Click Edit Notifiers... The Notifier List pane of the Server Settings window
appears, showing the available notifiers. For more information, see Working
With Notifiers (Pg 131).
If you have changed the default notifier, or have edited its settings, you can reset
all of the devices on the map to have the current default notifier or updated set-
tings.
To reset the default notifier or its settings for all devices on the map:
- 92 -
The Map Settings Window
l Click Reset All. All devices on the map now use the current version of the
default notifier.
If you are using InterMapper Database to collect device and network data, you can
specify a default retention policy for a map. This setting overrides any default
policy set in the Server Settings window.
Use the Map Settings window to specify the Retention Policy you want to use with
new devices in this map. Data Retention Policies are defined from the Retention
Policy pane (Pg 274) of the Server Settings window.
Use the Retention Policy panel to choose the retention policy to be applied to new
devices added to the map.
- 93 -
Chapter 4: Creating Maps
Use the Layer 2 Settings panel to turn on Layer 2 features for a map and to choose
how Layer 2 connections should appear.
Notes:
l To use the Layer 2 features, you must enable Layer 2 collection in the Layer 2
Features pane of the Server Settings window.
l One option allows InterMapper to make changes to the map based on Layer 2
data. This can cause significant changes to your map. Help/Systems recom-
mends that you back up the map before activating Layer 2 features.
l Enable Layer 2 features for this map - select this check box to turn on
Layer 2 mapping for this map.
l Change Now - click this button to initiate the visual arrangement of con-
nections on the map to reflect the most recent topology using Layer 2 data.
l Automatically change this map to show Layer 2 connections - select
this box to allow InterMapper to edit the map automatically to show Layer 2
connections.
l Show interfaces when a connection is made - select this box to show
Layer 2 interfaces when a connection is made.
l Hide interfaces that have nothing connected - select this box to limit
the interfaces shown to those that have something connected to them.
l Hide propVirtual interfaces - select this box to hide interfaces whose
ifType is propVirtual.
- 94 -
Quick Reference - Editing Your Map
Note:
l Press Tab, or
l Right-click in the map and choose Edit Map. or
l Click on the lock in the upper left-hand corner to unlock the map for edit-
ing.
l With a map editable, drag items from another map's List View window to
copy them to the new map.
l Select the node and choose the appropriate command from the Format
menu.
l Control-click the background of the map. The point you click is centered in
the map window.
l Control-drag the background of the map. The window scrolls the map con-
tents within the map window.
l Press Alt+[arrow key] (or Option+[arrow key], Mac) scrolls the map in
the direction of the arrow.
To zoom in or out:
- 95 -
Chapter 4: Creating Maps
- 96 -
Configuring PowerShell For Use With InterMapper
Note: This topic assumes you know how to launch PowerShell, and that the Inter-
Mapper machine and the machines you want to connect to are running Microsoft
Windows.
To enable PowerShell remoting, open a PowerShell window, and run the following
command (also known as a "cmdlet") on all the machines you want to connect to:
Enable-PSRemoting -Force
The command starts the WinRM service, configures it to start automatically, and
creates a firewall rule that permits incoming connections. The -Force attribute
accepts the default settings.
Notes:
Configuring TrustedHosts
TrustedHosts is a list of trusted resources for your computer. The TrustedHosts list
consists of a comma-separated list of computer names, IP addresses, and fully-
qualified domain names. For a given computer, only administrators can change the
TrustedHosts list.
Before you can connect to a remote computer, your TrustedHosts list must contain
the IP address of that computer.
If your computers are not on a domain, you need to configure the TrustedHosts set-
ting on the InterMapper server for all the computers you want to connect to.
Execute these commands, providing an IP address, or use wildcards to specify an
IP range (see below). Separate entries with commas.
- 97 -
Chapter 4: Configuring PowerShell For Use With InterMapper
When configuring TrustedHosts, PowerShell accepts only a single asterisk (*) for a
wild card.
Test-WsMan [COMPUTER]
A successful test shows a several lines of information. The last line is most inter-
esting, as it shows the version of Windows Management (WsMan) running on the
target machine.
Executing a Command
You are now ready to try a command. To determine the versions of PowerShell and
several other related systems, try this command:
This returns a list of versions of PowerShell, WsMan, and several other systems.
If the command above works successfully, you are ready to try running PowerShell
probes and notifiers.
- 98 -
Chapter 5
You can use InterMapper's layout tools to arrange your maps in ways that are most
useful to you.
One strategy:
1. Find one or more clusters of related items and move them close together.
2. Once you have created clusters, you can move them to different parts of the
map.
For example, an Ethernet or FDDI backbone with its attached routers might
make a good cluster. Similarly, a central router or switch with its attached
networks might serve as a cluster.
3. If networks or ports are not important for a map, hide them from the Inter-
faces Window (Pg 195).
4. See Using the Arrange Commands (Pg 114) for more information about using
the commands from the Format menu.
5. For other information related to arranging your maps, see Arranging Tips (Pg
119).
InterMapper has many tools for enhancing your map's appearance. These include:
l Setting Custom Icons: InterMapper comes with a set of icons derived from
Cisco's Icon Library. Use these industry standard icons, or import your own
PNG, GIF, or JPEG images. For more information, see Custom Icons (Pg 101).
l Setting a Map Background: You can use a graphic as a "background" to the
map. The devices being monitored will appear above this background image.
For more information on using background images, see Background Images
(Pg 104).
l Adding text objects: You can add text objects your map to label groups of
objects, or simply to provide information to the viewer. For more inform-
ation, see Text... (Pg 409) in the Insert menu reference topic.
l Importing Device Descriptions: InterMapper allows you to import descrip-
tions of the devices on a map directly from a tab-delimited file. This
- 99 -
Chapter 5: Arranging Your Map
simplifies the creation of a new map, and makes it easy to add new devices
as your network grows. For more information, see Importing Data Into Maps
(Pg 637).
l Setting the Geographic Coordinates of the Map: InterMapper allows
you to indicate the latitude and longitude for benchmarks - known positions
on the map. If, for example, you are using an actual geographic map as a
background image, you can use geographic coordinates to place a device in
the correct location on the map. For more information, see Using Geographic
Coordinates (Pg 640).
Create a new map, and then save it. You can scan your own map, or obtain an
image that covers the right area from one of the sites listed in Using Geographic
Coordinates (Pg 640). InterMapper can use PNG, GIF, or JPEG image files as back-
grounds for maps. You can obtain suitable images by scanning or creating your
own maps, or use one of the many map sites listed in Sources of Maps (Pg 643).
To add a background image to a map, simply drag the image file into the map win-
dow. It will be added to the map and become visible.
If you use a geographic map for a background, you can associate specific points on
the map with geographic coordinates (latitude and longitude) by adding bench-
marks. For more information, see Using Geographic Coordinates (Pg 640). Once
you have specified the coordinates, you can specify geographic coordinates for
devices as you import them to the map, and they are automatically placed at the
correct location.
- 100 -
Icons and Images on Maps
A large number of built-in icons are provided with InterMapper. It is also very
straightforward to import your own icons.
To set an icon, select one or more items on the map, then choose Format >
Icon... This opens the Select an Icon window. This window has several com-
ponents:
l A drop-down menu
lists collections of
icons called Icon
Sets. There are sev-
eral built-in icon sets,
including Traditional
and Default icons
sets, and various
Cisco-themed icon
sets..
l A scrolling list on the
left shows icons from
the selected icon set.
These icons appear at
a uniform size in the
list. Click one of
these icons to use it
for the selected
device(s) on the map.
Note: Grayscale cus-
tom icons appear Select an Icon window - Built-in Shapes
shaded with the color
of a device when it is
in the UP state (the default is green.)
l A preview pane of the icon, showing the selected icon in the size it will appear
on the map.
l Color preview buttons. The green, yellow, orange, and red buttons cor-
respond to the different device states. Click a colored button to view the
icon's appearance when it is in the indicated state.
- 101 -
Chapter 5: Arranging Your Map
- 102 -
Icons and Images on Maps
Clicking the color preview buttons changes the color to show how the icon appears
on the map in a given status.
Other graphics file formats may work for you, but aren't guaranteed to appear
properly on all platforms.
The recommended file format is a PNG file, saved at 72 pixels per inch, with 256
colors. You should use transparency for the area surrounding the icon, so the back-
ground color shows through properly.
If the icon's filename has a suffix of "_##" where "##" is a number representing
the size in pixels, the icons are grouped automatically, and the icon size slider
appears.
Any icon or image can be placed in a map. Before you can place an image in a
map, you must import it as an icon.
1. If the image has not yet been imported as an icon, import it now.
2. From the Insert menu, choose Icon... The Select an Icon window appears.
3. Choose the icon or image you want to insert and click OK. The icon or image
appears in the map.
4. Move the icon or image to a desired location on the map.
Note: When you place an icon on a map, a network oval is added to the map, and
the icon assigned to it. You can edit the network as you would any other network,
changing the icon or label, or adding a comment or subnet list.
- 103 -
Chapter 5: Arranging Your Map
l You might use a background image containing a floor plan of an office, and
move the items on the map to show the locations of each device in the office.
l You might use an image containing a street map of a city or topographic map
of a county or state.
The figure below shows a map after placing an image in the background.
or
1. From the Appearance section of the Map Settings (Pg 86)window, available
from the Edit menu, choose Background. The Background pane appears,
showing the current background image, if there is one.
2. Click to select Use background image.
- 104 -
Adding Background Images To Your Map
The background image retains its height and width, and is not scaled (stretched or
shrunk) when you resize the window. If the background image is smaller than the
current window size, the image will be centered in the map, and the map's back-
ground color will show around the edges. If a large image is placed, its dimensions
determine the full size of the window.
Contrasty images may make it difficult to see the devices and links against the
background. To make the image more suitable as a background image, you may
use a graphics program to increase the brightness and/or decrease its contrast
before placing it in a map. We regularly use GraphicConverter, an inexpensive
shareware graphics program from http://www.lemkesoft.com, to do this task. It
has a Brightness/Contrast adjustment facility to simplify this task.
Large images consume large amounts of memory and slow InterMapper's redraw-
ing of the window, especially when viewed over a remote connection. You should
balance the image quality against the size of the map. Larger maps may look bet-
ter, but they may consume large amounts of memory.
Note: Use of a compressed image file format such as JPG does not necessarily
translate into less memory use.
Decreasing contrast can decrease the size of an image, so that decreasing the con-
trast as described above may help decrease the size of the background image as
well. Use compressed formats, such as JPG and GIF, to further decrease the over-
all size of the image file.
- 105 -
Chapter 5: Arranging Your Map
Editing Labels
Use the Label... command, available from the Format menu (Cmd/Ctrl-L) to edit
the labels for the selected map objects. You can edit the label for a single device or
network from the Device or Network Info window.
Every item on a map has its own descriptive label. InterMapper creates a default
label showing the device's full DNS name or IP address(es).
For example, the device in the Edit Device Label window uses the short, smart
name (the leftmost part of the full domain name). The network shown in the Edit
Network Label window has a static (unchanging) label of "Our ISP", and a list of all
the subnets in the network shown on the next line.
Note: You can also use InterMapper variables and Javascript to insert information
dynamically into a device label. For more information, see Dynamic Label & Alert
Text (Pg 108).
The Edit Device Label window The Edit Network Label window
- 106 -
Editing Labels
You can hide the label for any device or network unless the icon is set to:
l Rectangle
l Oval
l Cloud
l Text
1. From the Format menu, choose Icon... The Select an Icon window appears.
2. Choose an icon other than one mentioned above and click OK. The icon
appears for the selected device or network.
3. From the Monitor menu, choose Label... The Edit Device Label or Edit Net-
work Label window appears.
4. Select the Hide Label check box and click OK. The label for the selected
device or network disappears.
- 107 -
Chapter 5: Arranging Your Map
When editing a device label, you can show probe parameters, probe variables, and
device export attributes in the label.
l Probe parameters - any field in the selected probe's Set Probe pane, spe-
cified in the <parameters> section of the probe.
l Probe variables - variables defined in the probe. In SNMP probes, specified
in the <snmp-device-variables> section of the probe.
l Device attributes - any attribute of a device (Pg 656) exported using the
Data File... command (Pg 635) (available from the File menu's Export sub-
menu.)
For example, to show the connect time in a device label corresponding to a TCP
probe, your label might look like this:
<Smart Name>
Time to establish connection: ${param:_connect} msec.
Notice, there is no space after the param: and the name of the variable. (The
underscore is part of the variable name. Most names do not have the underscore. )
Any variable that can be shown in the <snmp-device-display>, <script-
output>, or <command-display> section of the probe can be used in a label using
this syntax. You can show a parameter of the Basic OID probe just as well:
You can also use JavaScript in a device label or notifier. Use this to collect inform-
ation, process it programatically, and include the results in the label or notifier.
The syntax in a label looks like this:
The markers <? and ?> indicate the beginning and end of the JavaScript.
- 108 -
Dynamic Label and Alert Text
Important: JavaScript in labels and notifiers runs in the global scope within Inter-
Mapper. If you declare a variable within the global scope, rather than within a func-
tion, the variable is accessible for reading and writing by JavaScript running in any
other device label within InterMapper. This may produce unexpected results if you
attempt to run the same script in multiple devices.
JavaScript functions are supported, and you can store values within devices and
notifiers; these are remembered between polls. These techniques are recom-
mended when you need to protect a variable from being overwritten. Setting vari-
ables in devices is described in Remembering Values from One Poll to the Next (Pg
111).
<Smart Name>
<?
for (var i=1; i<=3; i++) {
writeln( "Hello World #" + i);
}
?>
The displayed label for the above would be something like this:
l The function write sends its output to the label without a line break.
l The function writeln sends its output to the label, and appends line break at
the end, so you do not need to explicitly append the "\n" in your JavaScript
code.
- 109 -
Chapter 5: Arranging Your Map
The self object refers to the device whose label you are setting. The self object
is always available when using JavaScript to generate a label. Use the same syn-
tax to get access to a probe variable as well:
<?
var connTime = self.get( "_connect");
writeln( "Time to establish connection: " + connTime);
?>
If you misspell the name of your variable, (by using "_conect" in the previous
example) the label looks like this:
If you look in the debug log, you see the following message:
The error message tells you the map, device, and probe in which the error
occurred, and details about what caused the problem.
The debug log contains the exception message, but give details about the syntax
problem.
The execution time of a script is limited to between 50 and 100 msec. This is a pre-
vents the script from monopolizing the CPU. This is more than adequate time to
produce a complex label or notifier output.
<?
for (var i = 0; i < 1000000; i++) {
if(i%10000 == 0) {
writeln( "testing the timeout " + i);
}
}
?>
- 110 -
Dynamic Label and Alert Text
There are two different techniques you can use to achieve this:
To read the value stored in the device's variable “MyInformation” into myinfo:
The function self.set(...) actually returns the value that is being stored. If the value
cannot be saved, (for instance, if you try to save to an existing probe parameter or
probe variable) the returned value is the actual value of the parameter or variable,
not the one you tried to save.
- 111 -
Chapter 5: Arranging Your Map
Here is a way to implement a counter that increments each time the label is
drawn. Note that the first time the script runs, the counter variable does not yet
exist.
This script below gets the value of “Count”, displays it, increments it, and saves it.
The first time the script runs, self.get() returns the string “BAD ARG, see debug
log”. Since JavaScript cannot turn this value into a number, you can use the
JavaScript isNaN() function to determine that n is NaN (Not a Number), and thus
has not been initialized.
<?
var n = Number( self.get( "Count"));
if (isNaN(n)) n = 0;
writeln( "Count is " + n);
n++;
self.set("Count", n);
?>
A similar technique would also work for JavaScript global variables as well.
You can also use JavaScript to access device attributes. The syntax is different
than for accessing probe parameters and variables. It still uses the self object,
but the attribute names are simply properties of the self object. The syntax looks
like this:
<?
var rtt = self.RoundTripTime;
writeln( "Round-trip time is \n" + rtt + " msec");
?>
The above JavaScript reads the last round-trip time into rtt, and displays it:
If you misspell a device attribute, the error shows up as a JavaScript syntax error
because the misspelling is not JavaScript data, but actual language syntax. You
would see “JS EXCEPTION, see debug log” in the label, and a detailed explanation
in the debug log.
Any device attribute can be used in a label. For a list of device attributes, see
Device Attributes (Pg 656).
Devices connect to networks through interfaces. Each device has a property called
interfaces. In JavaScript, this property appears as an array of Interface objects.
The example below lists all down interfaces:
- 112 -
Dynamic Label and Alert Text
<?
var downInterfaces = 0;
for (var i =0; i < self.interfaces.length; i++) {
var ifc = self.interfaces[i];
if ((ifc.Enabled == "TRUE") && (ifc.Status == "down")) {
downInterfaces++;
write( ifc.Index + ". ");
write(ifc.Alias.length > 0 ? ifc.Alias : ifc.Name );
writeln( " : " + ifc.Status);
}
}
writeln();
writeln(downInterfaces + "/" + self.interfaces.length + " interfaces
down");
?>
Any interface attribute can be used in a label. For a list of interface attributes, see
Interface Attributes (Pg 670).
- 113 -
Chapter 5: Arranging Your Map
- 114 -
Using the Arrange Commands
Use the Organic command, available from the Format menu's Arrange submenu,
to arrange the objects on a map so that crossed lines are minimized, and objects
are not overlaid on each other. This is the method used to arrange devices during
auto-discovery.
To the right is a complex map. Notice that there are many overlapping links.
- 115 -
Chapter 5: Arranging Your Map
Use the Tree command to arrange the current selection in a tree. A sub-menu con-
trols whether the tree structure should be drawn to the right, down, left, or up.
Arrange items in a tree structure. Choose which direction the branches of the tree
should go. Shown below are Tree > left and Tree > right.
- 116 -
Using the Arrange Commands
The Star command arranges connected items in a circle around the selected item,
similar to the Organic command.
- 117 -
Chapter 5: Arranging Your Map
Use the Cycle command to spread out the items in the map, and make the rela-
tionships more clear. The Cycle command moves all devices and networks near
the edge of the window as shown below.
The Cycle command moves all devices and networks near the edge of the window
as shown below.
- 118 -
Other Tips for Arranging Your Maps
l Move one or more items around the window - Drag them to a new pos-
ition. Use shift-click to add or remove items from the current selection before
dragging.
l Automatically select connected items - Alt/Option-click an object to
select all the leaves connected to it. (A leaf is an object that has no other con-
nections.) A second Alt/Option-click selects all the objects (leaves and non-
leaves) connected to the current selection.
Subsequent Alt/option-clicks continue to expand the selection, choosing
first the leaves, then the non-leaves that are attached to the current set of
selected objects.
l Use the Format menu commands to affect placement of items in the map.
In addition to the Cycle, Bus, and Star commands described above, use
these menu commands to change the orientations or sizes of the items in the
map.
Align... modify the alignment of items
Rotate... rotate the selected items around their center
Scale... increase or decrease the separation of the selected items
l Use these Format menu commands to affect the appearance of individual
items:
change the item's shape to a rectangle, oval, wire, cloud,
Icon:
text, or other icon
Label: modify a text label for an item in the map
Label pos- change the location of a text label relative to its item
ition:
l Right-click (or Ctrl-click) to set the Font, text Size and text Style from the con-
text menu for all selected items.
l If networks or ports are not important for a map, hide them from the Inter-
faces Window (Pg 195).
l See Editing Labels for Devices and Networks (Pg 106)and Connecting Devices
to Switch Ports (Pg 121) for more tips on arranging the map.
l InterMapper periodically scans routers and switches and displays newly dis-
covered interfaces. If you delete the interface/oval from the map, Inter-
Mapper rediscovers it and displays it again. You can hide them from the
Interfaces Window (Pg 195). For more information, see Hiding and Un-hiding
Detail (Pg 128).
l If you use a switch's VLAN capabilities to segment your network, you may
want to show which equipment is connected to each VLAN segment. Do this by
manually dragging device links to the proper port to indicate the correct con-
- 119 -
Chapter 5: Arranging Your Map
nection point. See Connecting Devices to Switch Ports in the Switches (Pg
121).
l If the layout of the network as discovered doesn't match your conceptual net-
work layout, you can copy a network oval and move device links to the new
network oval. For more information, see Copying Network Ovals (Pg 123).
- 120 -
Connecting Devices to Switch Ports
Auto-discovered switches have all their ports shown in a map. This can add clutter,
and can make it difficult to see the real structure of the map. In addition, an inact-
ive (i.e., unused) switch port will cause the switch itself to be placed in alarm.
Note: You can also convert your map to Layer 2. Using Layer 2 information, your
map is automatically updated to match the topology represented by the switch's
Layer 2 information. For more information, see Mapping with Layer 2 (Pg 353).
Use the Interfaces window to select and remove these switch ports.
1. With the map editable, right-click/CTRL-click the switch and choose Inter-
faces Window. The Interfaces window appears, showing the switch's available
interfaces.
2. Select or clear the checkboxes to enable or disable switch ports. The disabled
interfaces disappear from the map.
InterMapper does not connect devices to the proper port of a switch. Instead, it
connects all the devices of a subnet to the first switch port it discovers (usually the
port with ifIndex=1).
You can manually move a device's link to the proper port by dragging the link from
the central oval (labeled "192.168.1.0/24" in the figures below) to the proper port,
as shown below:
- 121 -
Chapter 5: Arranging Your Map
- 122 -
e Copying Subnet Ovals
You can make a copy of a subnet oval and reconnect your devices to it. This allows
you to create visual arrangements that more closely match your concept of a
logical map layout.
1. With the map editable, click to select the subnet oval you want to copy.
2. From the Edit menu, choose Copy.
3. From the Edit menu, choose Paste. The copy of the subnet oval appears on
the map.
4. Move the subnet oval to preferred location.
5. From the Format menu, choose Label... or press Ctrl/Cmd+click. The Edit
Network Label window appears.
6. Add a meaningful label to distinguish it from original label. For more inform-
ation, see Editing Labels (Pg 106)
7. For each device you want to connect to the new oval, drag the link from the
old oval to the new oval. The device is connected to the new oval.
Before copy
- 123 -
Chapter 5: e Copying Subnet Ovals
To do this, you can create a placeholder icon, and then manually drag the links
from the appropriate devices to this new icon. Although InterMapper cannot test or
monitor this "fake" equipment, it will appear on the map and display the inter-
connections of your network as a tool to diagnose problems.
Here is a step-by-step description of the process. Note that this description works
equally well for either switches or hubs.
In the starting map, notice that InterMapper has automatically connected a num-
ber of devices to the network oval labeled "192.168.1.0/24". We happen to know
that the top three devices --IP addresses 192.168.1.91, .89, and .79-- are in fact,
connected to a dumb (e.g., unmanaged) hub on the floor above. This page shows
how to create a placeholder icon to represent the hub and connect those three
devices to it.
The problem
We want to create a
placeholder icon that
represents the hub, and
then move the con-
nections for those
devices to the place-
holder.
Step 1: Create a
placeholder to rep-
resent your hub
- 124 -
Adding Unmanaged Hubs and Switches to a Map
2. Enter a subnet
number that's the
same as the
device's current
subnet (oval) as
shown in Adding
Networks to a Map
(Pg 68).
Step 2: Tidy up
- 125 -
Chapter 5: e Copying Subnet Ovals
Attach To from
the device's con-
text menu.
3. Click the network
oval below the
rectangle. The
"hub" is connected
to the network
To connect the
devices to the "hub":
1. Click on a link
(line) for the first
device, and drag it
toward the
"Upstairs Hub"
rectangle.
2. Let go of the
mouse when it's
over the rect-
angle.
- 126 -
Adding Unmanaged Hubs and Switches to a Map
The result
- 127 -
Chapter 5: e Copying Subnet Ovals
l Use the Delete command to delete one or more networks. Select the net-
works you don't want to see, then choose Delete from the Edit menu, or
press the Delete key. InterMapper does not poll interfaces for deleted net-
works.
l Create sub-maps (Pg 71) - If you want to hide detail, but still want to mon-
itor its state, and view it occasionally, you can create separate maps con-
taining the detail you want to hide, then make a new map with devices which
use the Map Status probe (Pg 448). Each device represents a "sub-map." .
l Use the Interfaces window (Pg 195)to hide or show interfaces. When you
hide an interface, it is no longer polled, and alerts are not sent.
- 128 -
Chapter 6
What is a Notifier?
Think of a notifier as a little "robot" that watches the state of one or more devices,
and performs a specified action when the device changes to a certain state. The
action is called a notification.
You can attach notifiers to a device, and then specify which states (down, up, warn-
ing, alarm, critical) should trigger the notifier. When a device changes to that
state, the notifier triggers, and InterMapper sends the notification.
For example, you can create a notifier that sends an e-mail message. You then
attach that notifier to a device. You might also specify that it should be triggered
when the device goes down or comes back up. When the device goes into either of
those states, the e-mail would be sent.
Notifier Types
There are several types of notifiers; each uses a different method to send a noti-
fication:
l The Notifier List (Available from the Server Configuration section of the
Server Settings window) is a library of notifiers you have created.
- 129 -
Chapter 6: Notifiers and Alerts
l You create a notifier (Pg 131) from the Notifier List, the Default Notifiers
dialog, or the Notifiers window.
l You configure the notifier (Pg 139), then test it (Pg 141)to make sure
it's working properly.
l You attach a notifier (Pg 133) to a device using the Attach Notifier dialog.
l You remove a notifier (Pg 131) using the Notifier List.
l You define a set of default notifiers (Pg 132) using the Default Notifiers
dialog. When you add a new device to a map, the default notifier set is
attached to the new device automatically. (You can also create and attach noti-
fiers to individual items.)
l You attach notifiers only to devices, not to networks.
Parts of a Notifier
Notifier This is a human-readable description of the notifier. It's useful to
Name include the type and recipient in the name, e.g., "Network Techs
via email" or "Syslog to Main Logger"
Notifier There are many notifier types - e-mail, sounds, traps, etc. - as
Type listed above. Each notifier you create will cause some kind of
notification or alert, depending on its parameters.
Notifier Each notifier has a schedule associated with it. The schedule spe-
Schedule cifies the days of the week, and the hours of each day during
which a notifier should send notifications. If the event happens
outside the schedule, no notification will be sent.
The Notifier list is a library of notifiers that you can attach to different devices on
your map. It is available from the Server Settings window. You create, configure,
edit, remove, and disable notifiers from the Notifier list. Once you have created
and configured the notifiers you want to use, you can attach them to devices.
Occasionally, you may be about to attach a Notifier, and discover that you need to
create a new one before you can attach it. You can quickly open the Notifier list
from the Notifiers window, and create a new notifier.
When an event occurs, for example, when a device changes to a new state (Up to
Down, Warning to Alarm, Alarm to OK) InterMapper triggers the attached notifiers
that apply to that new state. The notifier then sends a notification, as defined in its
parameters, to the specified target users as defined by the notifier schedule.
- 130 -
Working With Notifiers
l From the Server Settings window's Server Configuration section, choose Noti-
fier List. The Notifier List appears.
To add a notifier:
To remove a notifier:
- 131 -
Chapter 6: Notifiers and Alerts
l Select or clear the check box to the left of the notifier's name in the notifier
list. When deactivated, the notifier never triggers. This is useful for vacation
periods or other times when you don't want the notifier to be used.
You can create one or more notifiers that, by default, are attached to every new
device you create. When the status of the device changes to a specified state, the
notifier sends a notification automatically.
InterMapper ships with one default notifier, called "Default Sounds." It plays a
default sound when a device goes down, and another sound when the device comes
back up.
1. From the Edit menu, choose Map Settings... The Map Settings window
appears.
2. In the left pane, click Default Notifiers...The Default Notifiers pane
appears, showing a list of defined notifiers, with a column containing a check
box for each possible device state.
3. For each notifier you want to attach to new devices on the map, select the
check box for each state you want to trigger that notifier.
4. When finished, close the click OK. The specified notifiers are automatically
attached to each new device added to your map.
5. To attach the default notifier set to all the devices on the map, click Reset
All. Any attached notifiers are removed, and replaced with the default notifier
set.
Note: Changing default notifiers does not change notifiers already attached to
existing devices; it applies only to newly added devices. To attach the default noti-
fier set to all devices on the map, click Reset All. Any attached notifiers are
removed, and replaced with the default notifier set.
l Select all items on the map, then open the Notifiers window from the Monitor
menu. Any changes you make apply to all selected map items.
- 132 -
Attaching a Notifiers to Devices and Interfaces
You can attach one or more notifiers to any device. For each notifier, you can
choose which states trigger a notification to be sent. For example, a particular
device might have a notifier send an e-mail when a device goes down, but can
have a second notifier that plays sounds when the same device goes down, comes
up, or enters an alarm state. You might also send an e-mail to an on-site system
administrator during the day, and to a different administrator outside business
hours.
Notes:
l You can create a new notifier from the Notifier Settings window. The "Edit
Notifiers..." button is a shortcut to the Notifier List in the Server Settings
page.
l You can also attach notifiers to devices from the Device Notifiers list view of
the Map window.
You can also attach notifiers to a device's interfaces, so that alerts are sent for a
link when that link goes down.
- 133 -
Chapter 6: Notifiers and Alerts
1. Select the device containing the interfaces you want to attach notifiers to.
2. View the Interfaces window, either from the Monitor menu or from the
device's context menu. The Interfaces window appears, showing the device's
interfaces .
3. Select the interfaces you want to attach notifiers to, using Click, Shift-click,
and Ctrl-click. Use Ctrl-A to select all of the device's interfaces.
4. Right-click (or Ctrl-click) one of the selected interfaces and choose
5. Notifiers Window from the context menu. The Notifier Settings window
appears, containing the notifiers currently attached to the selected interfaces.
6. Choose the notifier you want to attach from the dropdown menu.
7. Select or clear the check boxes for the device states you want to trigger the
notifier. Set Delay, Repeat, and Count values as appropriate. A notification
is sent when any of the interfaces' states change to one of the selected states.
Note: You can also attach notifiers to interfaces from the Link Notifiers list view
of the Map window.
If you change the default notifier or any of its settings after attaching it to devices ,
you can reset all of the devices in a map to use the new notifier or settings:
1. With the map window open for the map you want to reset, choose Map Set-
tings... from the Edit menu. The Map Settings window appears.
2. In the left pane, click Default Notifiers. A list of notifiers appears.
3. From the Context menu (Right-click/Ctrl-click one of the devices) or from the
Monitor menu, choose Notifiers Window. The Notifiers winow appears as
shown below.
4. Click Reset All. The selected devices are now attached to the default notifier.
For each notifier, you can specify Delay, Repeat, and Count parameters. These
parameters can be used to control how quicky and how frequently notifications are
sent. For example, to avoid unnecessary pages you might configure a notifier to
wait until a device has been down for two minutes before sending the first page.
You might also choose to re-send a notifier every 10 minutes forever. Notifications
are sent until the count is reached, or the device has been acknowledged.
- 134 -
Attaching a Notifiers to Devices and Interfaces
Notification Escalation
You can use notifiers to implement a problem escalation system by creating two or
more notifiers for a device. The first notifier can fire quickly to alert someone
immediately. A second notifier can be delayed for a period of time, perhaps 30
minutes or an hour, before notifying a second person. If the problem remains
when the second notifier's delay time is reached, the second notification is sent. As
soon as a problem is acknowledged, no further notifications are sent, even if the
outage lasts a long time.
- 135 -
Chapter 6: Notifiers and Alerts
When one device is dependent on another, you can use this dependency to sup-
press the notifications for devices that depend on the failed device.
To enable dependencies, you set a Vantage Point (Pg 137). The Vantage Point indic-
ates the position from which InterMapper views the network. You usually set the
Vantage Point on the actual device where InterMapper is running. Once you've set
the Vantage Point, InterMapper can determine which devices are dependent on
which other devices.
The example below shows a map with several interconnected routers. The yellow
star on the InterMapper icon shows that it is the map's vantage point.
In this example, Router2 has failed. InterMapper will send the normal notifications
for Router2, but it will suppress notifications for any of the devices that depend on
it. Those dependent devices' icons are dimmed on the map to show they're being
shadowed by the failure.
- 136 -
Using Vantage Points
or
l Control-click the item to which the Vantage Point is currently assigned, then
choose Remove Vantage Point from the dropdown menu's Set Info sub-
menu.
A star next to the item disappears, and no Vantage Point is set. Notifications are
sent for all map items.
When a device goes down (when no response has been received from it),de-
pendencies are used to determine whether to suppress the notification.
Starting at the Vantage Point, InterMapper follows the links toward the device in
question. If the only path to that device passes through a device, a link, or an inter-
face that's already down, InterMapper knows that the device is shadowed, dims its
icon, and suppresses the notifications.
If there is no failure along the path, or if there is no path at all (functional or not)
to the device, InterMapper allows the notification to go through.
Even though a device is shadowed (and its notifications are suppressed), Inter-
Mapper continually probes the device to show its status.
- 137 -
Chapter 6: Notifiers and Alerts
You can define only one Vantage Point per map. Even if a map does not show the
machine on which the server is running, you can use the Vantage Point to indicate
the communication path from the InterMapper server to the devices on the map.
If a device fails but has not yet been polled, it is possible for notifications for
dependent devices to be sent even though the failed device is responsible for the
failure. This can result in a number of unnecessary and inaccurate alerts being
sent.
In this situation, configure the notifiers for the dependent devices to have a delay
that is longer than a single polling cycle of the device on which they depend. In this
setup, the dependent devices do not send an alert if the device on which they
depend goes down. An alert is sent only for the failed device.
- 138 -
Configuring Notifiers
Configuring Notifiers
A notifier has four attributes:
l A notifier name.
l The type of notification to send
l A schedule of hours during which the notification should be sent
l A set of parameters determined by the notification type. This is the inform-
ation required to allow the notification to be sent. For example, an E-mail noti-
fier requires a valid E-mail address.
To configure a notifier:
l Use the left side of the window to choose the type of notification, and to set
the notifier parameters.
l Use the right side of the window edit the schedule during which the noti-
fication can be sent.
- 139 -
Chapter 6: Notifiers and Alerts
When you select the type of notifier from the Notifier Type dropdown menu, the
left pane changes to show the parameters required for the selected notifier type.
Removing a Notifier
To remove a notifier:
1. From the Edit menu, choose Server Settings... The Server Settings window
appears, with a list of settings in the left pane.
2. From the Server Configuration section of the settings list, choose Notifier
List. The Notifier List window appears.
3. Click to select the notifier you want to remove.
4. Click Remove... A confirmation dialog appears.
5. Click Yes. The selected notifier disappears from the Notifier List.
Enter a name in the Name box. The name can be any can be any descriptive text
string.
Tip: If the notifier is active only at certain times of the day or week, you may want
to include a description of the time period as well. For example, you could assign
names like "Weekend Pager" and "Second Shift Pager" to notifiers that had those
time schedules.
Notifier Type
From the Configure Notifier window's Notifier Type dropdown menu, choose a
notifier type. For more information, see Notifier Types (Pg 129) at the top of this
topic.
Scheduled Hours
l Double-click the Active Hours legend to activate all hours in the schedule.
l Double-click the Inactive Hours legend to de-activate all hours in the sched-
ule.
- 140 -
Configuring Notifiers
l Click Edit Message... The E-mail Notification page (Pg 129) shows the edit-
ing interface.
Note: You can also use InterMapper variables and Javascript to insert inform-
ation dynamically into a notifier message or subject. For more information,
see Dynamic Label & Alert Text (Pg 108).
Test Notifier
l In the Configure Notifier window, click Test Notifier. The notification is sent
immediately, with the state defined as "Test."
Once you have created notifiers, you may attach them to all devices (the default
notifier is used for all new devices) or to one or more devices.
- 141 -
Chapter 6: Notifiers and Alerts
The Configure Notifier window for Sound notifier type. For each device state,
you can select a different sound.
Notes:
- 142 -
Configuring a Sound Notifier
Bear in mind that large sound files may affect system performance for
remote users.
l Sounds are queued up for playing. One sound does not start until the pre-
viously queued sound is completely finished playing. Relatively short sound
files are recommended.
Device States
You can use sounds in many different ways to help give you audible indicators the
condition of your network. Here are two possible uses for sound notifiers.
l Create different sound sets for different times of day, or for dif-
ferent days - create different sound notifiers, each having a different noti-
fier schedule. This can be helpful if you need to, for example, use certain
notification sounds during working hours in a busy office, and have louder,
more easily distinguishable sounds outside working hours, when you are work-
ing away from your computer.
l Create different sound sets for certain devices - create sound notifiers
for certain kinds of devices, and use different sounds. You can tell without
looking if, for example, a certain machine or router goes down. It is also use-
ful if you been having trouble with a particular device.
Sound files must be placed in the InterMapper Settings/Sounds folder before they
can be made available in the Server Configuration Notifier List panel of the Server
Settings window.
- 143 -
Chapter 6: Notifiers and Alerts
1. In the Configure Notifier window, choose "Electronic mail (SMTP)" from the
Notifier Type drop-down menu.
2. In the Address box, enter the e-mail address you want to receive the noti-
fication. You can enter multiple addresses, separated by commas, spaces,
tabs, newlines, or carriage returns.
Note: E-mail is sent using an outgoing SMTP mail server. Before InterMapper can
send e-mail notifications, you must specify the SMTP host you want to use for send-
ing e-mail notifications. For more information on how to specify your outgoing
SMTP mail server (and a backup server) see E-mail Preferences (Pg 264).
- 144 -
Configuring an E-Mail Notifier
Double-click an item to
insert it into the message text. When the notification is sent, the inserted item is
replaced with its current value in the message text.
Subject :
<Event>:
<Device Name>
Message:
<Timestamp>:
Message from InterMapper <Version>
Event: <Event>
Name: <Device Name>
Document: <Document Name>
Address: <Device Address>
Probe Type: <Probe Type>
Condition: <Device Condition>
Time since last
reported down: <Last Down>
Device's up time: <SysUpTime>
Note: You can also use InterMapper variables and Javascript to insert information
dynamically into a notifier's subject or message text. For more information, see
Dynamic Label & Alert Text (Pg 108).
- 145 -
Chapter 6: Notifiers and Alerts
To create a Group notifier, select Group from the Notifier Type dropdown menu.
A set of currently-defined notifiers appears, with a check box next to each. To cre-
ate the group notifier, check the appropriate boxes in the list.
How it works
When the Group notifier is invoked, InterMapper first checks the time schedule. If
the time is applicable, InterMapper invokes each of the checked notifiers. They in
turn check their schedules, and send the notification if desired.
Notes:
- 146 -
Configuring a Pager Notifier to use an Analogue Modem
A notification that uses the built-in modem paging facilities. The page will be sent
to the person specified by the Subscriber menu.
Warning: Many paging services limit the length of a message. Sending a longer
message can cause multiple pages per event, and can considerably increase your
pager bill.
Before you can use the paging options, you need to:
- 147 -
Chapter 6: Notifiers and Alerts
The window above assumes that you have already configured InterMapper for your
pager service.
1. Choose Edit List... from the Subscriber drop-down menu. The Paging Set-
tings window appears.
2. Click the Paging Services tab. A list of paging services appears, if any are
defined.
3. Click a service to edit, or click Add. The information for the paging service
appears.
4. Enter dialup information in the boxes provided. Use the information about
your paging service to enter the service name, telephone number, and pass-
word, the port to which your modem is attached, and the modem con-
figuration.
5. In the Bits dropdown menu, choose values appropriate to your modem. Open
the menu repeatedly to set the data bits, stop bits, and parity. By default, the
values are set to 7 data bits, 1 stop bit, and Even parity.
6. In the Retries box, set the number of times you would like the page to be
sent if it fails. The default is 2.
7. In the Retry Interval box, set the number of seconds to wait between
retries. The default is 10 seconds.
8. When finished, click Done.
- 148 -
Configuring a Pager Notifier to use an Analogue Modem
1. Choose Edit List... from the Subscriber drop-down menu. The Paging Set-
tings window appears.
2. Click the Paging Subscribers tab. A list of paging subscribers appears, if
any are defined.
3. Click a service to edit, or click Add. The information for the paging service
appears.
4. In the Name box, enter the name of the person you want to receive the page.
5. From the Service dropdown menu, choose the user's Paging Service. If the
user's paging service doesn't appear, you need to create it as described
above.
6. In the Pager ID box, enter the person's pager ID. (This may be different
from the Service phone number that you entered when creating the user's
Paging Service definition above.)
7. When finished, click Done.
- 149 -
Chapter 6: Notifiers and Alerts
The paging log file is a special file which will receive logging of all paging traffic
and messages, including the details of the modem commands and text written and
read. The information in this log may help you or InterMapper Technical Support to
troubleshoot paging if it is not working correctly.
To start logging this traffic, use the Log Files server settings panel to create a log
file named Paging (The log file name will be "Paging<date>.txt") Logging will con-
tinue until the log file is removed through the Log Files panel.
Modem Compatibility
With Mac OSX
InterMapper has been tested with Mac OSX using various built-in modems, an
external USB modem (MultiTech MT5634ZBA-USB), and an older external modem
connected via a KeySpan Twin Serial adapter (using KeySpan's current OSX driver)
on a beige G3. With the KeySpan serial adapter, InterMapper lists both serial ports
in the Modem Page Settings dialog and you are responsible for choosing the correct
one.
With Windows and Unix
A number of modems have been tested with InterMapper. While we cannot guar-
antee that a particular modem works, we believe that most modems that support
V.34 or a later specification will work well.
- 150 -
Sending SMS/Text Alerts to a Cell Phone
Note: The methods described below depend on an analogue modem dialing a TAP
service or a cell phone. You can also use a cell modem to send SMS message dir-
ectly to another cell phone. For more information, see Configuring an SMS Notifier
(Pg 157). This may be preferable at this point.
InterMapper can send SMS or Text Messages using TAP, the Telelocator Alpha-
numeric Protocol, with an internal or external analogue modem. It will connect to a
paging service and deliver a notification or alert to your cell phone
If your paging service provides a TAP paging terminal that forwards pages as SMS
or text messages to your wireless phone, you can follow the instructions below to
configure InterMapper to send alerts to your phone.
1. Add a new Notifier. To do this, click Add in the Server Settings>Notifiers List
window. The Configure Notifier window appears.
2. From the Notifier Type drop-down list, choose Alpha-numeric Pager (Dia-
lup).
3. Click Edit Subscriber List.
4. Add a new paging service. To do this, click Add button in the Paging Services
tab. Enter the name of the service, the phone number to dial (including any
numbers you may need to access an outside line), and a password, if
required. Use the default values for data bits, stop bits, parity and speed
unless your paging service has provided you with different values.
5. Add a new subscriber. To do this, click Add button in the Paging Subscribers
tab. Enter the subscriber name, then select the paging service you created
in step 4 from the drop-down list. Enter the subscriber's cell phone number in
the Pager ID field.
6. When you have finished adding the new paging service and subscriber, click
OK to return to the Configure Notifier window.
7. Click Edit Message if you want to change the data included with the text mes-
sage. Edit the message, then click OK when finished.
8. Edit the notifier schedule, if required.
9. Click Test Notifier to confirm that the message can be sent and received.
10. When finished, click OK.
Note: This procedure has been tested using Verizon's TAP access to their
SMS/Text Message system. The access number is 866-823-0501. Other cell pro-
viders may offer a gateway to their text/SMS message service.
- 151 -
Chapter 6: Notifiers and Alerts
If your cell phone provider does not provide a TAP interface for text messages, you
can use an e-mail-based service to deliver the message. You should contact your
cell phone provider for details on sending alerts and notifications via e-mail. Note:
Remember that sending an alert through e-mail fails if your connection to the Inter-
net is down. See below for a low-tech workaround.
If your Internet connection is down, but your cell phone provider doesn't offer
access to their text/SMS message system via an analogue modem, you can still
get notified about problems. Simply create a new Alpha-numeric Pager (Dialup)
notifier and enter the cell phone number as the paging service number. It dials the
phone directly. There won't be any voice or text/SMS message, but the CallerID
will let the recipient know that it's InterMapper calling.
If you encounter any problems, InterMapper can create a log file that shows the
details of the paging mechanism. This is useful to review or send to tech support.
To do this:
l Open the Server Settings>Log Files window and click Add to create a new log
file. Name the log file 'paging' and click OK.
l Test your notifier again from the Configure Notifier window. The paging.txt
file contains detailed logging for the test notification. You can find the
paging.txt file in the InterMapper Settings>InterMapper Logs folder on the
server. If the information contained in the paging log isn't helpful to you,
please send the file with a description of the problem to sup-
[email protected].
- 152 -
Notification Using a Numeric Pager
12. Click the Paging Subscribers tab and create the paging subscriber(s) who
will use numeric paging.
13. Set the service field to use the service created in the steps above.
14. Set the pager id to be the phone number used to dial the pager. To the pager
id/phone number, append enough of your modem's pause characters (for
most modems, this is a comma) to make sure that InterMapper waits until
the call has been answered and any introductory message played to send the
tones with the numeric message. This varies from service to service.
- 153 -
Chapter 6: Notifiers and Alerts
When creating a notifier based on numeric pager subscribers, edit the message as
you normally would, using the InterMapper macros if you so desire. When the page
is sent, all non-numeric characters will be removed. So, the message:
DOWN: 192.168.1.132
becomes
1921681132
Future versions of InterMapper may contain new macros to provide numeric codes
for common events.
The paging log file is a special file which receives logging of all paging traffic and
messages, including the details of the modem commands and text written and
read. The information in this log may help you or InterMapper Technical Support to
troubleshoot paging if it is not working correctly.
To start logging this traffic, use the Log Files panel of the Server Settings window
to create a log file named Paging (The log file name will be "Paging<date>.txt")
Logging continues until the log file is removed through the Log Files panel.
- 154 -
Configuring a Page Notifier to Send a Page Using SNPP (Network)
To configure:
Contact your pager provider for IP address, domain name, and SNPP port
information.
6. Click Edit Message... to edit the message that is sent to the pager.
7. In the Notifier Schedule panel, choose the hours during which the page will
be sent.
8. When finished, click OK.
Note: InterMapper may not be able to reach your SNPP-based paging service via
the Internet if your WAN circuits or routers are down. Be sure that you have a
- 155 -
Chapter 6: Notifiers and Alerts
backup notification mechanism for failures to critical services. See the workaround
in Alerts Via Cell Phone (Pg 152) for a possible approach.
- 156 -
Configuring an SMS Notifier
Note: To state the obvious, the modem used to send SMS messages must be able
to connect to a cellular network. If there is no coverage at the location of the SMS
modem, the server will not able to send the notification.
1. In the Configure Notifier window, choose "SMS" from the Notifier Type drop-
down menu.
2. In the Recipient box, choose the recipient from the dropdown menu. If
there are no recipients in the list, click Edit Recipient List... to configure
connection to an SMS modem and to add and configure SMS recipients. See
Adding and Removing SMS Modems (Pg 158) and Adding and Removing
SMS Recipients (Pg 159), below.
3. If you want to edit the message, click Edit Message... For more information
on editing messages, see Editing the Text of an E-mail Notification Message
(Pg 145).
- 157 -
Chapter 6: Notifiers and Alerts
Before you can send SMS messages, you must set up at least one SMS modem
through which SMS messages are sent.
1. From the Configure Notifier window, with SMS selected as the Notifier Type,
click Edit Recipient List... The SMS Settings window appears.
2. In the SMS window, click the SMS Modems tab. A list of available modems
appears on the left.
3. Click Add. A new modem configuration form appears.
4. Enter a Name and PIN, choose a Modem Port, connection Bits and Speed,
and enter a modem initialization string in the Init String box.
5. If you want to change the default retry specifications, set the Retries and
Retry Interval values.
6. When finished, click OK. The specified modems appear in the recipient's
Modem dropdown menu.
- 158 -
Configuring an SMS Notifier
Before you can send SMS messages, you must set up at least one SMS recipient to
receive the message.
1. From the Configure Notifier window, with SMS selected as the Notifier Type,
click Edit Recipient List... The SMS Settings window appears.
2. In the SMS window, click the SMS Recipients tab. A list of available recip-
ients appears on the left.
3. Click Add. A new recipient configuration form appears.
4. Enter a Name, choose a Modem, and enter the number of the recipient's
phone in the Phone # box.
5. When finished, click OK. The specified recipients appear in the notifier's drop-
down menu. The recipient's specified modem appears when you choose the
recipient from the notifier's Recipient dropdown menu.
- 159 -
Chapter 6: Notifiers and Alerts
Command-line Notifiers
Use a command-line notifier specify a command (executable, shell script, batch
file, etc.) to be executed as a notification.
1. In the Configure Notifier window, choose "Command Line" from the Notifier
Type drop-down menu.
2. In the Command box, enter the command to be executed. Include any argu-
ments, exactly as you would type them on the command line.
3. Click Test Notifier to send a test notification.
Specify the executable you wish to run, including any arguments. Note that you
need to specify the exact name, including any extensions such as .exe or .cmd.
To include the message escaped for use in an HTTP query string, use ${ESCAPED_
MESSAGE} instead. You are responsible for supplying quotes if it is necessary.
Note: InterMapper allows an expanded command line (that is, the command line
with the path added and the message inserted) up to 65535 characters, but you
may find that your host platform limits the command-line size to only 255 char-
acters. Windows users, to work around this limitation try converting your com-
mand-line script to a PowerShell script and use a PowerShell notifier (Pg 173).
- 160 -
Command-line Notifiers
Note: The command box must refer to an executable which resides in the Tools
subdirectory of the InterMapper Settings directory, or a subdirectory thereof. No
other executables may be referred to. However, the executables in this directory
may be links, shortcuts, or aliases to an executable elsewhere; they will be
resolved and executed.
See the Examples page (Pg 162) for an example of a command line notifier.
- 161 -
Chapter 6: Notifiers and Alerts
However, iPing also has an API, one method of which allows more control over
how the notification is carried out. This method, putnotification, is invoked via http.
With a command-line tool like "curl" and InterMapper's command-line notifiers,
you can create a powerful and tailored iPing notifier for InterMapper.
The curl utility is already available on many Unix systems. If it is not available on
yours, or if you are using Windows, you can find out more about it and download a
copy from http://curl.haxx.se/. You can find out more about the putnotification API
method for iPing from http://www.iping.com/ipingv2/PutNotification.aspx. The
rest of this command-line notifier tutorial assumes that curl is installed and that
you have an iPing account.
First, make sure that curl or an alias or soft link to it is in the Tools directory on
the InterMapper server. The Tools directory is a subdirectory of the InterMapper
Settings directory. If you do not have a Tools directory, you will need to create
one. For security reasons, only executables in this directory may be executed as
notifiers.
Open the Server Settings dialog box and click on the Notifier List entry. Click on
the Add... button and choose a type of Command Line. Give it a name.
In the "Command" field, enter the iPing notification command you want to use. A
simple example to send a message to a phone number immediately would be:
curl
"https://www.iping.com/services/iping.asp?method_name=putnotification
&user_name=testdriver
&password=12345
&phone_number=8448675309
¬ification_dt=now
&msg_text_body=${ESCAPED_MESSAGE}"
Note: All the text above should be on a single line, with no blank spaces in the
URL.
- 162 -
Example Notification from a Command Line Program
"now"
l msg_text_body The text of the message to be spoken.
l ${URLESCAPE: xxxxx} This macro returns a string that contains the text
("xxxxx") with all the URL special characters escaped properly.
l ${ESCAPED_MESSAGE} This macro is a special case facility that performs
the URL escaping function on the notifier's ${MESSAGE} string, as entered by
the user. Click the "Edit Message" button to modify the default message. The
default message is fairly short, as is appropriate for command-line noti-
fications.
Note 2: The curl command generally exits with a code of zero. This avoids Inter-
Mapper log messages warning of unsuccessful notifications.
- 163 -
Chapter 6: Interfaces & Notifiers
1. View the Interfaces window (Pg 195) for the device containing the interfaces
you want alerts from. The Interfaces window appears, showing all interfaces
for the selected device.
2. Click the row containing the interface you want to attach notifiers to. The row
is highlighted. Select additional rows using Ctrl+click or Shift-click.
3. Right-click (or Ctrl-click) the selected row, and choose Notifiers Window...
The Notifiers window, showing the notifiers currently attached to the selected
interface(s).
4. For each notifier, select or clear check boxes for status levels. Alerts are sent
from the selected notifiers when a link status changes to the selected status.
- 164 -
WinPopup (Windows Only)
To configure:
1. In the User Name or Server: text box, enter the user name or server name
of the person to contact.
2. Click Edit Message... to edit the message that will be sent.
3. In the Notifier Schedule panel, choose the hours during which the page is
sent.
4. When finished, click OK.
- 165 -
Chapter 6: Interfaces & Notifiers
InterMapper can send a syslog message as a notification. That is, when an event
occurs, InterMapper can write the data to a specified syslog server on the network.
Send syslog messages to: - the IP address or DNS name of the syslog server
that should receive the message
Facility: - The syslog server administrator may specify that messages from a par-
ticular source be tagged with a certain facility code. Select the facility requested
by your administrator.
Severity: - Syslog messages can be tagged with a severity, so that the syslog
files can be scanned for entries with different priority. Set the desired severity to
Edit message... - You may enter the format of the syslog message. See Editing
the text of an E-mail Notification Message (Pg 145), where this process is
described. Newline characters will be converted to spaces, so the message will
appear as a single line. Syslog messages will contain "InterMapper" as the syslog
tag.
- 166 -
Notification by SNMP Trap
InterMapper sends a SNMP Trap as a notification when a device goes into a par-
ticular state.
Configuring a Trap Notifier. Enter the IP Address or DNS name for the device to
receive the trap, along with the SNMP Trap Community String.
In the notification Schedule window, select "SNMP Trap" from the dropdown menu,
and fill in the IP address or DNS name of the device to receive the trap, and the
SNMP Trap Community string.
InterMapper sends six pieces of information in the trap. All are encoded as OCTET
STRING. This information is also available in ASN.1 format. in the Dartware MIB
(Pg 177).
- 167 -
Chapter 6: Interfaces & Notifiers
InterMapper's traps contain the following MIB variables, taken from the Dartware
MIB (described in detail in The Dartware MIB (Pg 177)):
intermapperTimestamp = 1.3.6.1.4.1.6306.2.1.1.0
intermapperMessage = 1.3.6.1.4.1.6306.2.1.2.0
intermapperDeviceName = 1.3.6.1.4.1.6306.2.1.3.0
intermapperCondition = 1.3.6.1.4.1.6306.2.1.4.0
- 168 -
AutoMate Notifier
AutoMate Notifier
Use the Automate Notifier to run an Automate task when specified conditions are
met.
Before you can create an AutoMate notifier, you need to enable the connection to
an AutoMate Server. The AutoMate Server must be running on the same machine
as the InterMapper Server. For more information see the section on configuring
AutoMate (Pg 293) in the Server Settings.
1. From the Notifier Type dropdown menu, choose AutoMate. The AutoMate
Notifier configuration window appears.
2. Click Edit Task... The Notifier Task window appears:
- 169 -
Chapter 6: AutoMate Notifier
4. In the Run By section, choose whether to execute the task by Path or ID.
HelpSystems recommends that you select ID, because it reduces the traffic
between InterMapper and AutoMate.
5. Enter a Password if one is required by the AutoMate task's security con-
figuration.
6. Click OK. The task is selected.
7. Set Retry and Consolidation settings as described below and click Test to
run the notifier and execute the task.
Note: If a task is disabled in AutoMate, the task still appears in the available task
list, but will not run when the notifier is triggered.
Use the Retry and Consolidation settings to specify when to run or retry a task.
l Retry limit - Enter the number of times the task will be re-attempted upon
failure. By default, the value is 0, and the task is not re-tried.
l Retry interval - Enter the number of seconds between retries.
l Consolidation limit - Enter the maximum number of notifications sent
before the task is executed. If it is set to 1, a task is executed each time the
notification is sent. If it is greater than 1, the task is executed when the num-
ber of notifications reaches the Consolidation limit or the Consolidation period
is reached.
l Consolidation period - Enter the number of seconds to wait for additional
notifications before running the task, when the Consolidation limit is non-
zero. Once a notification has been sent by the notifier, the task is run when
either the Consolidation limit or the Consolidation period is reached.
Note: An AutoMate notifier is not run again until the selected AutoMate task is com-
plete.
When an AutoMate notifier is run, InterMapper writes data about the triggering
device to a CSV file, and grants the AutoMate task access to it. Through this file,
AutoMate can access InterMapper variables, which can be used by the task in a
wide variety of ways.
In order for AutoMate to access this data from an AutoMate task, the
task should include these steps:
A sample task that completes these steps is supplied with InterMapper. The file,
called NotifierTest.aml can be found at:
%Installation Folder%\InterMapper\docs\samples\automate\
- 170 -
AutoMate Notifier
In the AutoMate task editor, you can access these parameters with this syntax:
- 171 -
Chapter 6: AutoMate Notifier
- 172 -
PowerShell Notifier
PowerShell Notifier
Use the Powershell notifier to execute a PowerShell script when a device meets
specified conditions.
Note: Before you can run a PowerShell Notifier, you must configure PowerShell to
work with InterMapper (Pg 97) on the local machine and any target machines you
want to access with PowerShell. Use PowerShell probes to test the connectivity.
Notes:
- 173 -
Chapter 6: PowerShell Notifier
l Parameters to the command are passed through STDIN, and thus are not
bound by the character limit. If you encounter the limit, you can use message
variables as arguments, including sending the entire contents of the notifier
message as an argument ("${MESSAGE}"). If you choose to use one of these
variables, be sure to enclose it in quotes, in case it contains whitespace.
l Relative paths to PowerShell scripts must be relative to the InterMapper Set-
tings\Tools folder.
l You can create additional folders hierarchy within the Tools folder if you find
it useful.
l In the Command Text box, the path to the Tools folder is
"./yourscript.ps1". PowerShell also accepts a backslash, but it must be
escaped: ".\\yourscript.ps1."
l Signed scripts must be run from the InterMapper Settings\Tools folder or in a
folder it contains.
Available Variables
You can use many InterMapper variables, including ${address}, ${User}, ${Pass-
word*}, as well as any of the other information available to Command-Line noti-
fiers.
Three methods of execution are available. Each one determines how the script will
be executed, and what device it is executed on.
When you choose an execution method, the PowerShell command text box is
preloaded an appropriate command.
l Local
./MyPowerShellNotifier.ps1 "${MESSAGE}"
l Alerting Device
l Other Device
- 174 -
PowerShell Notifier
Change the name of the .ps1 script and change or add parameters as needed.
The specified command text is executed on the machine that triggered the alert.
- 175 -
Chapter 6: PowerShell Notifier
The specified command text is executed on the machine specified in the Com-
puterName box.
- 176 -
The Dartware MIB
-- *****************************************************************
-- DARTWARE-MIB for InterMapper and other products
--
-- May 2007
--
-- Copyright© HelpSystems, LLC
-- All rights reserved.
-- *****************************************************************
DARTWARE-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, enterprises
FROM SNMPv2-SMI
DisplayString
FROM SNMPv2-TC;
dartware MODULE-IDENTITY
LAST-UPDATED "200507270000Z"
ORGANIZATION "Dartware, LLC"
CONTACT-INFO "Dartware, LLC
Customer Service
Postal: PO Box 130
Hanover, NH 03755-0130
USA
Tel: +1 603 643-9600
E-mail: [email protected]"
DESCRIPTION
"This MIB module defines objects for SNMP traps sent by Inter-
Mapper."
REVISION "200705300000Z"
DESCRIPTION
"Updated descriptions to show timestamp format, correct strings
for intermapperMessage."
REVISION "200512150000Z"
DESCRIPTION
"Added intermapperDeviceAddress and intermapperProbeType."
REVISION "200507270000Z"
DESCRIPTION
"First version of MIB in SMIv2."
::= { enterprises 6306 }
- 177 -
Chapter 6: PowerShell Notifier
intermapperTimestamp OBJECT-TYPE
SYNTAX DisplayString (SIZE(0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current date and time, as a string, in the format 'mm/dd
hh:mm:ss'."
::= { intermapper 1 }
intermapperMessage OBJECT-TYPE
SYNTAX DisplayString (SIZE(0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of event - Down, Up, Critical, Alarm, Warning, OK,
or Trap - as a string."
::= { intermapper 2 }
intermapperDeviceName OBJECT-TYPE
SYNTAX DisplayString (SIZE(0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The (first line of the) label of the device as shown on a
map, as a string."
::= { intermapper 3 }
intermapperCondition OBJECT-TYPE
SYNTAX DisplayString (SIZE(0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The condition of the device, as it would be printed in the
log file."
::= { intermapper 4 }
intermapperDeviceAddress OBJECT-TYPE
SYNTAX DisplayString (SIZE(0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The device's network address, as a string."
::= { intermapper 5 }
intermapperProbeType OBJECT-TYPE
SYNTAX DisplayString (SIZE(0..255))
MAX-ACCESS read-only
STATUS current
- 178 -
The Dartware MIB
DESCRIPTION
"The device's probe type, as a human-readable string."
::= { intermapper 6 }
END
- 179 -
Chapter 7
l Click the lock button at the left end of the toolbar in the Map win-
dow, or press Tab as a keyboard shortcut. The tool switches
between locked and unlocked as shown.
Note: You can also change the poll interval for one
or more individual devices, using the Set Poll Inter-
val (Pg 400) command, available from the Monitor
menu. The map's poll interval value affects only those devices that are using
the default poll interval.
The Map Zoom drop-down menu sets the zoom factor for the map. If
you choose Auto, the map zooms automatically when you resize the
window.
- 180 -
Chapter 7: Monitoring Your Network
Color Codes
Devices turn different colors depending on the magnitude of the problem detected.
Links may be "haloed" with yellow or orange as utilization reaches 50 and 90 per-
cent respectively. These are coupled with status badges, described below.
These are the default color assignments. You can redefine the colors from the
Server Settings (Pg 265) window.
Status Badges
- 181 -
Understanding the Map
InterMapper draws dotted lines ("ants") next to a link to indicate that its current
traffic flow is above a user-settable threshold value. Use the Thresholds>Traffic
panel of the Map Settings window, available from the Edit menu, to change the set-
tings and to view a legend of the different varieties of ants. You see the ants only
in Monitor mode (as opposed to Edit mode.) To toggle between the two modes,
click lock in the upper left corner or press Tab.
InterMapper regularly polls all the visible interfaces for packets, bytes, errors and
discards.
- 182 -
Chapter 7: Monitoring Your Network
The boxes represent the physical equipment of your network. The ovals represent
the networks which link the routers together. The numbers in the bubbles are "net-
work identifiers". For IP networks, the number is the network and the subnet por-
tion of the IP addresses of all devices on it. For example, "192.0.16.0/24" is a
network where IP addresses are in the range 192.0.16.0-192.0.16.254, and the sub-
net mask has 24 bits (it is a Class C network.) This is described in detail in the Sub-
net Mask (Pg 727) FAQ.
Click and hold on a router or network to see a status window with information
about that item. (This only works in "browse" mode -- press Tab, or click the lock
in the upper left corner to lock it).
Line styles
As with the networks and devices, you can click and hold a link to see a Status win-
dow, containing information about the interface type and traffic statistics.
Link States
Badge State Meaning
Red Link Down - No response has been
X received from the interface within the
specified timeout period.
Blue Basic Acknowledge - The link is
X down, and has been set to Basic
Acknowledge
Clock, Timed Acknowledge - The link is
Blue link down, and has been set to Timed
Acknowledge
Wrench, Indefinite Acknowledge - The link is
Blue down, and has been set to Indefinite
link Acknowledge (Maintenance)
Yellow link Warning - The link is working, but has
reached one of the specified warning
thresholds
- 183 -
Understanding the Map
- 184 -
Chapter 7: Monitoring Your Network
1. Make sure your map is in Monitor mode (click the lock at the upper left of
map window to lock the map, or press the Tab key.)
2. Click and hold a device, network, or link on the map, or right-click the device,
network, or link, then choose Status Window. The Status window for the
selected device appears.
3. Release the mouse button to hide the Status window.
If you are using a custom TCP or SNMP probe, you can override the default con-
tents of a Status window. For more information, see Custom Probes and Cus-
tomizing Status Windows in the Developer Guide.
- 185 -
Viewing Status Windows
l Click and hold the mouse on a device to open its device status window, or
right-click the device and choose Status Window.
l Click and drag to tear the window off and leave it open.
l Click the underlined Reset link to set Packet Loss to zero. This also resets the
device's availability measurement.
Note: The map must be in Edit mode to reset the Packet Loss value.
The window shows the device name, network address, device status, the probe
used to poll it, up-time (i.e., SNMP sysUptime, if available), availability (the per-
centage of the time the device was available based on the number of packets lost
while testing), round-trip time (in msec), and spanning tree status (if available).
When the device reports a problem, the reason for the most important error is
shown in red at the bottom of the Status window.
l Click and hold the mouse on a network oval to open its network status win-
dow, or right-click the network and choose Status Window..
l Click and drag to tear the window off and leave it open.
The network status window shows the network's IP address and subnet mask, (if
available) and information about the amount of traffic flowing on that network seg-
ment. This data comes from all the SNMP devices attached to that network
oval.
Note: The traffic statistic shown are only for devices connected to this network
that speak SNMP: Ping/Echo, or TCP-based devices (such as HTTP, FTP, etc.
probes) do not have this information and are ignored when computing the sums
and maximums displayed in the Status Window.
- 186 -
Chapter 7: Monitoring Your Network
Tip: Certain devices do not report their link speed accurately in their SNMP
responses. This causes InterMapper to report a value which is not actually correct.
To work around this, switch the map to Edit mode, then right-click the link and
choose Set Link Speed... The Set Link Speed window appears, allowing you to set
Transmit and Receive speeds.
- 187 -
The Info Window
The appearance and content of an info window varies, depending on whether the
selected object is a device or network.
l For details on viewing and editing device info, see The Device Info Window
(Pg 189).
l For details on viewing and editing network info, see The Network Info Window
(Pg 193).
Click the device or network whose info you want to view and do one of the fol-
lowing:
l Click the lock icon (lower left) to change the map to Edit mode.
l Click a info section on the left to view or edit that info type.
l Click Apply to save your changes.
l Click OK to save your changes and close the Info window.
- 188 -
Chapter 7: Monitoring Your Network
- 189 -
The Device Info Window
General Pane
Use the Device Info window's General pane to edit general information about the
device.
l Address - view or edit the device address. This is the address that is used
when the device is polled.
l Host Name - view or edit the device's host name. This is the host name that
is used to resolve the address
l Resolve - choose address to set name, name to set address, or
neither.
l Select Use as Map's Vantage Point to use this network as the map's Vant-
age Point (Pg 136).
l IMID - view InterMappers internal device ID. (This info is read-only.)
l Kind - choose from the dropdown menu to specify the type of device.
l Retention Policy - choose a Retention Policy to specify how data for this
device is saved.
l Latitude - set the device's latitude.
l Longitude - set the device's longitude.
l Comment - enter text in the Comment box to add a comment to the device.
SNMP Pane
Use the Info window's SNMP pane to view available SNMP information. This is a
read-only pane, so there are no options to edit.
Probes Pane
Use the Device Info window's Probes pane to view and edit the device's probes.
From the Probes pane, you can add and remove probes, and edit a probe's inform-
ation.
1. Make the map editable by clicking the Lock icon at lower left.
2. To change the probe, right-click (or Control-click) the probe you want to edit,
and choose Set Probe... from the context menu. The Set Probe window
appears.
3. Choose the probe you want to use and edit the settings as needed.
4. Click OK to close the Set Probe window.
To add a probe:
1. Click the plus icon (+) at the bottom of the Probes pane. The Set Probe win-
dow appears.
2. Click to choose a probe from the probe list on the left.
3. Edit the probe settings as needed.
4. Click OK to close the Set Probe window.
Note: When you add a probe, the device becomes a probe group.
- 190 -
Chapter 7: Monitoring Your Network
Thresholds Pane
Use the Device Info window's Thresholds pane to view and edit threshold settings
for the device.
1. Open the Info window for the device you want to edit.
2. Make sure the map is in Edit mode.
3. Click Thresholds to view the Thresholds pane.
4. Select the Ignore Outages check box to suppress alerts for the device when
it goes down or comes up.
Note: The Ignore Outages check box suppresses alerts only with respect to
outages, not to other state changes, thresholds, or to any alerts triggers by
probes attached to the device. This is useful if a device such as a laptop or
mobile device goes up or down (or leaves the network completely) as part of
its normal operation.
Icon Pane
Use the Device Info window's Icon pane to change the icon for the device.
1. From the dropdown menu at the top of the pane, choose an icon set.
2. Scroll through the set and choose an icon. You can see what it looks like by
clicking on it. You can see what it looks like in different states by clicking the
colored buttons below the preview area.
3. When you have found an icon you want to use, click Apply to activate the icon
without closing the window or OK to activate the icon and close the window.
Label Pane
Use the Device Info window's Label pane to edit the device's label.
Editing a Label
A label can contain any combination of text, variables, and JavaScript. For detailed
information on editing labels see Editing Labels (Pg 106) and Dynamic Label and
Alert Text (Pg 108).
- 191 -
The Device Info Window
Advanced Pane
Use the Advanced pane to choose the mapping behavior of a device, and whether
to collect Layer 2 information.
Mapping Behavior
Layer 2
l Poll this address for Layer 2 information - clear this box to prevent this
device's IP address from being polled for Layer 2 information. This is equi-
valent to the Remove switch from Layer 2 database command, available
when you right-click a switch in the Layer 2 view's Filter pane.
l Allow Layer 2 connection - clear this box to prevent InterMapper from
making a connection from this device to other devices on the map using Layer
2 information.
- 192 -
Chapter 7: Monitoring Your Network
General Pane
Use the General pane to view a list of subnets that appear on the map, to control
which subnets appear, to add and remove subnets, to set the network as the map's
Vantage Point, or to add a comment.
l Add a subnet - Click plus (+) at the bottom of the General pane to add a sub-
net.
l Remove a subnet - Select a subnet from the Subnets list, and click minus (
- ) at the bottom of the General pane to remove the subnet from the list and
the map.
l Add a Comment - enter text in the Comment box to add a comment to the
network.
l Click Use as Map's Vantage Point to use this network as the map's Vant-
age Point (Pg 136).
l After making a change, click Apply to save the change without closing the
Info window. Click OK to save the change and close the Info window.
- 193 -
The Network Info Window
Icon Pane
Use the Network Info window's Icon pane to change the icon that appears on the
map for the selected network.
The Icon pane operates exactly as the Device Info window's Icon pane (Pg 191).
Label Pane
Use the Network Info window's Label pane to edit the network's label.
The Label pane operates exactly as the Device Info window's Label pane (Pg 191).
- 194 -
Chapter 7: Monitoring Your Network
Interfaces Window
InterMapper can show the interfaces of a particular router or switch. This is con-
venient for viewing the specifics of those interfaces (for example, the Name or
ifAlias assigned to each individual port) or for viewing the status of the port.
1. Right-click the router or switch for which you want to view the Interfaces Win-
dow.
2. From the context menu, choose Interfaces Window.
or
Note: You may open as many interfaces windows as you like. Each window is
updated at the device's poll interval.
The Interfaces window displays one row for each port or interface on the device. It
shows the following information in columns:
- 195 -
Interfaces Window
and receive speeds are different (for example, in asymmetric DSL links). You
can change both the RX Speed and TX speed using the Set Link Speed... com-
mand, described below.
l VLAN - Contains the VLAN ID that has been assigned to the interface (if any).
l Ignore Errors - Select or clear this box to choose whether to ignore inter-
face errors.
l Ignore Discards - Select or clear this box to choose whether to ignore inter-
face discards.
l Ignore Utilization - Select or clear this box to choose whether to ignore
interface errors.
l Display unnumbered interfaces - Select or clear this box to choose
whether to see all the unnumbered interfaces on a switch. By default, Inter-
Mapper does not display unnumbered interfaces.
l Allow periodic reprobe - Select or clear this box to choose whether or not
a device is to be automatically reprobed every 12 hours.
Note: The Display unnumbered interfaces and Allow periodic reprobe func-
tions are also available from Interfaces menu's Behavior... dialog box, available
from both the Monitor menu and context menu. The setting applies a device or to
all selected devices.
Use the Statistics view of the Interfaces window to see various statistics for all
interfaces on a device:
- 196 -
Chapter 7: Monitoring Your Network
To hide an interface:
l Clear the check box next to the interface. If you hide an interface, a network
associated that interface disappears from the map, and remains that way.
The interface is no longer polled, and data is no longer collected.
To delete an interface:
l Click the line for the interface you want to delete and press Delete.
or
l Right-click the interface line and choose Delete from the context menu.
Use the following information to help you decide whether you want to hide or
delete an interface:
l Probe rediscovery - When you hide the interface, it does not reappear
unless you "unhide" it. When you delete an interface, InterMapper redis-
covers it and displays it again the next time it re-probes the device unless you
clear the Allow periodic reprobe check box.
l Data Collection - When you hide the interface, data collection stops. It
starts when you re-enable it. When you delete an interface, data collection
resumes when the interface is rediscovered.
l Polling - When you hide the interface, polling for that interface stops. It
starts when you re-enable it. When you delete an interface, it is polled, and
thus reappears when rediscovered.
l Layer 2 Discovery - When you hide the interface, Layer 2 discovery for that
interface stops. It starts when you re-enable it. When you delete an interface,
the interface is rediscovered, and Layer 2 information is collected.
- 197 -
Interfaces Window
You can acknowledge one or more down interfaces from the Interfaces window.
1. In the Interfaces window, select the rows for the interfaces you want to
acknowledge.
2. Right-click one of the selected interfaces and choose Acknowledge... The
Acknowledge window appears.
3. Create an acknowledgement as described in Acknowledging Device Problems.
You can copy data from the Interfaces window for use in spreadsheet or other
application.
1. Select the rows you want to copy. Shift-click to select contiguous rows, Ctrl-
click to select non-contiguous rows.
2. Press Ctrl/Cmd-C. The selected rows are copied to the clipboard in tab-
delimited format.
You can set the retention policy for an interface from the Interfaces window.
1. Right-click the interface and choose Set Data Retention from the context
menu.
The Set Retention Policy window appears.
2. Choose a retention policy from the Data Retention Policy dropdown menu.
Data is collected as specified by the selected policy.
- 198 -
Chapter 7: Monitoring Your Network
l 1000000
l 1000 K
l 1M
- 199 -
About Packet Loss
The Long-term Packet Loss is displayed in the device's Status Window, along with
the total number of packets sent and responses received. It is possible to reset this
value using the Reset link in the device's Status Window.
InterMapper measures Short-term Packet Loss by counting the number of lost pack-
ets in the last 100 sent. To do this, each device retains the history of the last 100
packets sent/received.
The short-term packet loss is displayed in the device's Status Window as a per-
centage of the number of dropped packets in the last 100. This value can be reset
via the Reset link in the Status Window(which resets all the device's statistics), or
by selecting one or more devices and choosing Monitor -> Reset Short-term
Packet Loss.
InterMapper can send alerts/notifiers when the short term packet loss statistics
exceed certain thresholds. That is, when short term packet loss exceeds a warn-
ing, alarm, or critical threshold, the device will turn to the appropriate color and
InterMapper will send the appropriate alert. These thresholds can be set in several
places:
To disable alerts/notifications for high packet loss, set the packet loss thresholds
to 100%.
When a device goes down, InterMapper stops updating the packet loss history
(both short and long term) for the duration of the outage. This prevents the packet
loss statistics from continuing to increase during an outage. (If InterMapper con-
tinued to count lost packets while a device was down, the statistics would incor-
rectly indicate there was high packet loss when it was likely the problem was
something else.)
- 200 -
Chapter 7: Monitoring Your Network
In addition, InterMapper ignores the packets lost when determining that a device
has gone down. For example, the default is that three successive lost packets will
indicate that the device is down (no longer responding). However, these three
dropped packets would be shown (incorrectly) as a 3% packet loss. Consequently,
InterMapper removes those dropped packets from the history, so that it shows an
accurate accounting.
When the device subsequently responds (after the problem has been corrected),
InterMapper begins counting successful and lost packet responses again.
- 201 -
Acknowledging Device & Link Problems
l Changes the device's icon or link color to blue to show that the problem has
been acknowledged.
l Stops further notifications of the problem, either for the duration of this out-
age, or for a specified time period.
l Writes any comment you enter into to the Event Log file, along with the name
and IP address of the user who acknowledged the problem.
l Displays the comment in the device or link's Status Window.
Acknowledgments allow the network administrator to see the state of the network,
as well as the responses that have been made to the current set of problems.
Acknowledging a problem
To acknowledge a
problem with a
device:
1. For devices,
click or Right-
click (or Ctrl-
click) the device
(s) you want to
acknowledge.
For interfaces,
Right-click (or
Ctrl-click) the
- 202 -
Chapter 7: Monitoring Your Network
link.
2. From the Monitor menu or Context menu, choose Acknowledge... (Cmd-' or
Ctrl-'). The Acknowledge window appears.
3. If you want keep the device or link in Acknowledgment mode for a specific
period of time, or for an indefinite period, choose Indefinite or Timed... in
the Ack column.
4. If you want to suppress notifications for devices that depend on this device,
click to select the Block notifications for dependent devices check box.
5. Enter a comment, then click Acknowledge. The selected device's icon
changes to blue, and your comment is written to the Event Log file. Noti-
fications are cancelled for the selected device for the duration of this outage.
- 203 -
Acknowledging Device & Link Problems
Notes:
l When you acknowledge an interface outage, the interface's link turns blue,
rather than the device itself, and an X, wrench, or clock appears on the link,
depending on whether it is a Basic, Indefinite, or Timed Acknowledgment.
l With timed and indefinite acknowledge, you can acknowledge a device even
when it is up and okay (i.e., green). This is useful if you know that there may
be future outages (for example, planned maintenance) with the device, and
you want to avoid extraneous notifications. You cannot do this with Basic
Acknowledge.
l The presence of the wrench badge is a safety measure. When you scan the
map visually, the wrench indicates devices whose notifications are currently
being blocked.
When you acknowledge a device, use the Block notifications for dependent
devices check box to specify whether the acknowledged device should be con-
sidered in finding dependencies. Checking the box suppresses notifications for any
device "on the other side" of the device being acknowledged.
To suppress notifications for all devices that are dependent on the selec-
ted device:
For more information on dependencies and dependent devices, see Using Noti-
fication Dependencies (Pg 136).
Use the Unacknowledge command to restore the device to its current notification
state.
- 204 -
Chapter 7: Monitoring Your Network
- 205 -
Outage Alarms on Interfaces
Use the the Set devices to Alarm status on down link check box, available
from the Device Thresholds pane (Pg 269) of the Server Settings window to con-
trol the behavior of alarms when an interface goes down.
You can:
You can right-click an affected interface's link, and select "Acknowledge". The inter-
face link gets a blue "X", and no further notifications for that interface are sent.
InterMapper also writes a line in the Event Log file for these events. The format of
the Event Log entries is:
If two interfaces go down at the same time, a set of alarm notifications is sent for
each interface. No further notifications are sent.
Once acknowledged, a link's Status Window show the interface's status as ACK
(down).
You can acknowledge and unacknowledge multiple interfaces from the device's
Interfaces window.
- 206 -
Chapter 7: Monitoring Your Network
You can Un-acknowledge... one or more links using Right-click (or Ctrl-click) in
the same way you acknowledge. This replaces the blue "X" with a red one, and re-
enables any repeated notifications for that device.
Note: The red "x" in a circle in the image above shows a link whose status as sup-
plied by the router is ifAdminDown. To see all of the available states for devices
and links, see Understanding the Map (Pg 181).
- 207 -
Setting Thresholds
Setting Thresholds
You can set a number of thresholds in InterMapper:
l Devices - set thresholds for lost packets, interface errors, and short-term
packet loss.
l Interfaces - set thresholds for interface errors, link utilization, and interface
discards.
Device Thresholds
Interface Thresholds
For interfaces, you can set Warning, Alarm, and Critical thresholds for:
As stated above, these statistics can be seen in the device's status window.
- 208 -
Chapter 7: Monitoring Your Network
Use the Monitor menu or the device's context menu to set thresholds for a device.
l Set thresholds for each link separately, using the interface link's context
menu.
l Set thresholds for all of the device's links at once, using the device's context
menu.
l Set thresholds for some, but not all, of the device's links using the Interfaces
window. In this case, use the Interfaces window to select the interfaces
whose links you want to set, then use the context menu to set them all at
once.
1. Right-click (or Ctrl-click)the link and choose Interfaces > [the threshold
set you want to set] from the context menu. The link's selected Threshold
window appears.
2. Set the thresholds as needed and click OK. New thresholds are used to
determine the link's status starting with the next poll.
You can set thresholds for some (but not all) of a device's links. You can also use
this method to set thresholds for an individual link.
- 209 -
Setting Thresholds
2. Click to select the first interface you want to set. The interface line is selec-
ted.
3. Shift-click (for contiguous lines) or Control-click (for non-contiguous lines) to
select additional interfaces you want to set.
4. Right-click (or Ctrl-click)the the selected interfaces and choose Interfaces >
[the threshold set you want to set] from the context menu. The
Thresholds window appears, showing the values that are common among the
links. Any values that are not the same show <mixed>.
5. Set the thresholds as needed and click OK. New thresholds are used to
determine the status of the selected links starting with the next poll.
You can set thresholds for several links at once. If you have already set thresholds
for one of the links, then select multiple links and open the thresholds window, the
conflicting are shown as <<mixed>> as shown:
The image above shows that the Tx Utilization threshold for one or more of the
selected interfaces is different from the others. You can resolve the issue by mak-
ing the settings the same for the selected interfaces. Hover your mouse over the
conflicting value to see the value of the parent device's threshold setting.
Use the same techniques as above to attach notifiers to links, sending alerts based
on the status of one, some, or all links on a device.
1. Right-click (or Ctrl-click)the link and choose Interfaces > Notifiers win-
dow from the context menu. The link's Notifiers window appears, showing a
- 210 -
Chapter 7: Monitoring Your Network
list of notifiers, with check boxes for each of the link's status levels. If any
notifiers are attached to the link, check boxes are selected.
2. Click status level check boxes to indicate which notifiers should be run. When
finished, closed the window. Alerts are sent as specified when link thresholds
reach the status associated with a notifier's checked box.
Set default thresholds for a server or a map. Default thresholds set for a server
are applied by default. You can override those settings, and use default thresholds
for a map instead. You can also override those thresholds for an individual device
or interface.
You can set default device and traffic thresholds for a map. Use the Map Settings
window, available from the Edit menu, to set default thresholds.
Use the Device Thresholds section of the Map Settings window to set default
device thresholds for a map so that errors for all devices are reported at the same
levels.
- 211 -
Setting Thresholds
1. In an editable map, choose Map Settings from the Edit menu. The Map Set-
tings window appears.
2. In the left pane, click Device. The default thresholds for the map appear in
the right pane.
3. Enter the settings you want to change, and click OK. The map uses the new
threshold settings.
For devices that have multiple interfaces, such as switches and routers, you can
also set thresholds for individual interfaces.
Use the Traffic section of the Map Settings window to set traffic thresholds for a
map. You cannot set traffic thresholds for a specific device.
You can set default interface thresholds for the server, or for an individual map.
l To set defaults for the server, choose Interface Thresholds in the Server
Settings window.
l To set defaults for the map, choose Interface Thresholds in the Map Set-
tings window.
You can set device thresholds for a specific device, with different values than the
default map settings. You cannot set traffic thresholds for a specific network or
link. You do this from the Info window.
Note: When setting thresholds for a probe group, you can set the thresholds only
for an individual probe, or use the Map's default settings. For more information,
see Setting Thresholds for Probe Groups (Pg 213) below.
- 212 -
Chapter 7: Monitoring Your Network
Note: Only SNMP probes have thresholds for all three parameters (response time,
packet loss and interface errors); a ping/UDP-based probe monitors only response
time and packet loss, and a TCP probe monitors only response time.
1. With the map in Edit mode, right-click a device and choose Info window,
or choose Info window from the Monitor menu. The Info window
appears.
2. In the left pane of the Info window, click Thresholds. The Thresholds pane
appears.
3. Clear the Use Map Defaults check box.
4. If you want to suppress alerts for the device when it goes down, select the
Ignore Outages check box.
Note: The Ignore Outages check box suppresses alerts only with respect to
outages, not to other state changes, thresholds, or to any alerts triggers by
probes attached to the device. This is useful if a device such as a laptop or
mobile device goes up or down (or leaves the network completely) as part of
its normal operation.
5. Enter new values in the boxes you want to change, and click OK or Apply.
The selected device uses the new values.
When setting thresholds for a probe group, you can set the thresholds only for an
individual probe, or use the Map's default settings.
1. Double-click a probe group. The Info window for the probe group appears.
2. In the left pane of the Info window, click Probes. A list of probes in the probe
group appears.
- 213 -
Setting Thresholds
3. Right-click (or Ctrl-click) the probe for which you want to set thresholds, and
choose Info Window. The Info window for the selected probe appears.
4. In the left pane, click Thresholds. The threshold settings for the selected
probe appear.
5. Clear the Use Map Defaults box, then set the thresholds as needed and
click OK. The thresholds for the selected probe are set.
6. Continue setting thresholds for each probe as needed, then click OK in the
probe group's Info window.
- 214 -
Chapter 7: Setting Traffic Indicators
Use traffic
indicators to
help you view
network activ-
ity on a map.
You can set the
traffic levels at
which "moving
ants" appear
to show you
the level and
direction of
activity on a
particular link.
Use the
Traffic sec-
tion of the Map Settings window (Pg 91) to turn on and configure traffic indicators
for a map. You cannot set traffic indicators for a specific device or link.
- 215 -
Sending Feedback
Sending Feedback
Use the Send Feedback... and Send a Screenshot... commands, available from
the Help menu, to send comments or report bugs. You can also use the Send Feed-
back window to submit updates for an existing ticket.
To send feed-
back:
1. From the
Help menu
choose Send
Feedback...
The Send
Feedback
window
appears.
2. Enter or edit
contact
information
as needed,
and enter a
Subject for
the feed-
back. This
should be a
short descrip-
tion of the
comment or
bug. If you
are updating
an existing
support
ticket, you
can simply
enter the
ticket num-
ber, and the
content of
your feedback submission is added to that ticket. See To Update an Existing
Support Ticket for more information.
- 216 -
Chapter 7: Setting Traffic Indicators
3. If you are reporting a bug, enter the steps required to reproduce the bug or
condition into the Steps to Reproduce box. If you are making a comment or
suggestion, enter it in the box.
4. If you want to include a screenshot, click Include screenshot.
5. To include additional information, click the System, Files, or Logs tab. See
additional information below.
6. When ready, click Submit.
l From the Help menu choose Send a Screenshot... The Send Feedback win-
dow appears, with a note that a screenshot is included. Enter information as
appropriate as described above.
1. From the Help menu choose Send Feedback... The Send Feedback window
appears.
2. Enter the ticket number in the Ticket box.
3. Enter additional information in the Summary tab, attach additional files on
the Files tab, or and send additional logs on the Logs tab.
System Tab
- 217 -
Sending Feedback
Files Tab
Logs Tab
l Select or clear
the check boxes
to choose the
log files you
want to send.
l Expand the More
list to view addi-
tional log files
you can choose
to send.
- 218 -
Chapter 7: Setting Traffic Indicators
Creating Charts
InterMapper charts display the history of one or more variables. This information
can also be saved to a log file for further analysis.
To create a chart:
1. Open one of the status windows as described in Viewing Status Windows (Pg
185).
2. Tear the status window off to create a new window.
3. Click on any of the underlined values. If the underlined value appears any
existing charts, a list of charts appears, along with a Create Chart option.
For more information about charts, see Using Charts. (Pg 220)
- 219 -
Using Charts
Using Charts
InterMapper displays historical information in a chart. Charts can hold an unlimited
number of datasets for an unlimited time period. These data can also be written to
a tab-delimited text file.
A chart is a persistent window that belongs to a particular map. All the data that is
displayed in a chart must come from devices or links of that map.
You can also specify the file that logs the chart's data, and control options for cre-
ating new chart log files. For more information, see Chart Log Files (Pg 232).
- 220 -
Chapter 7: Setting Traffic Indicators
You view and hide charts using the Charts command in the View menu or by select-
ing options from the Charts menu at the bottom left of the chart's window. (Pg
223).
l From the Windows menu, choose the chart you want to view by selecting it
from the Charts submenu.
or
l Click the button in the tool bar to view a list of charts associated with the
map. Double-click a chart to view it.
or
or
To hide a chart:
l Click the chart's close box. The chart is hidden, but the chart's data is pre-
served, and continues to be collected.
- 221 -
Using Charts
To create a chart:
1. Open one of the status windows as described in Viewing Status Windows (Pg
185).
2. Tear the status window off to create a new window.
3. Click on any of the underlined values. If the underlined value appears any
existing charts, a list of charts appears, along with a Create Chart option.
4. Click Create Chart. A new chart appears.
Note: To see what device a dataset belongs to, right-click (or Ctrl-click) the data-
set's legend in the Chart window, and choose Show Device. If you are viewing
the Map window in Map view, the device is highlighted momentarily. In List view,
the device is selected in the list.
Editing Charts
Edit the parameters that control a chart's content and appearance from the Chart
Options window (Pg 226), available from the Chart menu (Pg 223).
Deleting Charts
Use the Delete Chart... command, available from the Chart menu (Pg 223) to
delete a Chart.
- 222 -
Chapter 7: Setting Traffic Indicators
Chart Menus
InterMapper provides three menus you can use to view and edit charts.
From the Charts submenu of the Windows menu, choose the chart you want to
show. When the chart is visible, a checkmark appears in the submenu next to the
chart name, as shown at the right.
Note: From the Charts list window, select one or more charts, then right/Ctrl-click
a selected chart line and choose Show Chart.
- 223 -
Chart Menus
To view the
Chart menu:
l Click the
icon in the
lower left
to access
the Chart
dropdown
menu.
or
l Right/Ctrl-
click in the
chart's
data area.
Chart Options... - Choose this option to view and edit parameters for the current
chart. For more information, see Chart Options (Pg 226).
Delete Chart - Choose this option to delete the current chart and its data.
Log File... - Choose this option to create a log file to receive the data for the cur-
rent chart.
Show Legend - Choose an option from the Show Legend submenu to place the
chart's legend at the top, bottom, or to hide the legend completely.
- 224 -
Chapter 7: Setting Traffic Indicators
Edit Chart - If the map is not in edit mode, this is the only option available.
Choose this option to edit the chart and view the Chart dropdown menu.
- 225 -
Chart Options
Chart Options
Use the Chart Options window to view and edit the parameters that define a chart's
appearance and content.
The Chart Options window is available from the Chart menu (Pg 223). or by right-
clicking within the chart window.
Use the Apply button to apply changes to a chart. Here are some things you should
know about using the Apply button:
l Click Apply to apply changes you have made on any of the tabs, without clos-
ing the Chart Options window.
l Click Cancel to undo any changes you've made and applied.
l Click OK to apply any changes and close the window.
l Close the window to save any changes you've already applied.
The chart's title appears in the Charts menu and in the chart's title bar. Enter a title
in the Title box.
- 226 -
Chapter 7: Setting Traffic Indicators
Example: To divide a chart into 10 parts, you'll need eleven dividers. You can
do either of the following:
- Set the number of dividers to 11, with no sub-dividers.
- Set the number of dividers to 3, and the sub-dividers between each divider
to 4.
- 227 -
Chart Options
Example: To create a log scale with labels of 3000, 300, 30, and 3:
- Set the upper bound to 3000
- Set the lower bound to 3
- Set the number of dividers to 4
l Show Date, Show Day of Week, Show Time, 24 Hour Time - Check or
clear these boxes to specify which labels appear on a chart's horizontal axis
by default.
l Sub-Dividers - Click the up- and down-arrows to specify the number of
unlabeled vertical sub-dividers to draw between data points.
- 228 -
Chapter 7: Setting Traffic Indicators
Data Tab
The Data tab shows a lists of datasets used in the current chart. Use the Data tab
of the Chart Options window to export a dataset, to remove it from the chart, or to
edit the appearance of a dataset's legend.
1. In the list of datasets, click the dataset you want to remove from the chart.
2. Click Remove. The dataset disappears from the list.
To export a dataset:
- 229 -
Chart Options
In the list of datasets, double-click the data for the set whose legend you want to
edit. The edit window for the dataset's legend appears:
1. Click the Color rectangle and choose a color for the dataset.
2. Choose a line style for the dataset from the Style drop-down menu.
3. Choose a highlight icon for the dataset from the Highlight drop-down menu.
4. Edit the chart's title in the Title text box.
5. Click OK to save your changes.
1. In the list of datasets, click to select the dataset containing the data you want
to delete.
2. Click Delete... The Delete Data window for the dataset appears.
3. Set the date and time. Data before this date and time are deleted from the
dataset.
4. Click OK. The specified data is deleted from the dataset.
- 230 -
Chapter 7: Setting Traffic Indicators
Colors Tab
Use the Colors tab of the Chart Options window to define the colors for various
parts of the chart.
l Exterior - Click to set the color of the chart's background, outside the data
area. Click the check box to use the color.
l Interior - Click to set the background color for the data area of the chart.
l Frame - Click to set the line color for the frame of the data area.
l Text - Click to set the color for the chart's text.
l Horizontal Dividers - Click to set the line color for the chart's horizontal
dividers. Click the check box to use the color.
l Vertical Dividers - Click to set the line color for the chart's vertical
dividers. Click the check box to use the color.
To change a color:
l Click a color box in the window above to set the color. Use the system color
picker to select a new color.
- 231 -
Chart Log Files
1. From the Server Settings window, choose the Log Files (Pg 257) panel of the
Server Preferences section. The Log Files panel appears.
2. Click to select the file for which you want to stop logging data.
3. Click Remove. The file disappears from the list, and chart data is no longer
written to that file.
- 232 -
Chapter 7: Purging Chart Data
Note: before running the purge command, HelpSystems recommends that you
back up the InterMapper Settings folder (especially the Chart Data folder.)
Stopping and starting the InterMapper Server varies depending on your platform.
For Mac, Unix, and Linux, the command includes the location of the InterMapper
daemon configuration file. Here's the syntax those platforms:
/usr/local/bin/intermapperd -f /usr/local/etc/intermapperd.conf --
chart-purge [# of days]
#of days specifies the number of days of chart data to retain, while purging the
rest.
Purge Notes
l Server must not be running - The InterMapper Server must not be running
when you executed the command.
l Enabled maps only - Only charts from devices on enabled maps are
purged.
l Administratrative rights and write-access - You must have admin-
istrative rights, and write-access to the InterMapper Settings folder.
- 233 -
Log Windows
Log Windows
InterMapper writes information about interesting events into log files (Pg 257).
These streams of information can be viewed in the Log window. This allows you to
review log files without the need for an external text editor.
You create and control the preferences for log files from the Log Files panel of the
Server Settings window. For more information on creating, viewing, and con-
trolling the events that appear in log files, see Server Preferences - Log Files. (Pg
257)
Note: Debug log and Event log are encoded in UTF-8 format. To edit those files,
your text editor must support UTF-8 encoding in order to view foreign characters
correctly.
- 234 -
Chapter 7: Purging Chart Data
l From the Windows Menu, choose Event Log from the Logs submenu. The
Event Log window appears, as shown below.
The main Event Log window. It can show information about device ups and downs,
high traffic on links, web, telnet, and InterMapper RemoteAccess server con-
nections, as well as error messages.
As entries are written to the Event Log file, (stored in the InterMapper Set-
tings/InterMapper Logs" folder) they are also placed at the bottom of this window.
If the window is scrolled to the very bottom of the Event Log, it scrolls auto-
matically as new events are appended to the log.
- 235 -
Event Log Messages
l "[0-9]+ seconds?"
l "[0-9]+ minutes?, [0-9]+ seconds?"
l "[0-9]+ hours?, [0-9]+ minutes?, [0-9]+ seconds?"
l "[0-9]+ days?, [0-9]+ hours?, [0-9]+ minutes?"
- 236 -
Chapter 7: Purging Chart Data
This page lists all log messages that InterMapper writes to a log, with a description
of each. Items shown in italics are variable names that are substituted with the
proper value when the log message is created.
Note: Debug messages are not documented by Help/Systems, because they are
subject to change, and do not follow a specified format.
General Messages
These messages describe InterMapper's actions as it starts up, enables and dis-
ables servers, and opens and closes the map files. These messages always go to
the Event Log window.
- 237 -
Event Log Messages
DNS-Related Messages
**** Address Change: "www" changed from x.x.x.x to y.y.y.y. (DNS z.z.z.z)
The Device named www changed its IP address from x.x.x.x to y.y.y.y accord-
ing to the DNS server at z.z.z.z
**** No IP address for "www". (DNS z.z.z.z)
InterMapper was not able to determine an IP address for the device named
www from the DNS server at z.z.z.z
**** Name Change: "w.w.w.w" changed from "xxx" to "yyy". (DNS z.z.z.z)
The IP address w.w.w.w changed its DNS name from xxx to yyyy according to
the DNS server at z.z.z.z
**** No domain name for x.x.x.x. (DNS z.z.z.z)
InterMapper was not able to determine a DNS name for x.x.x.x from the DNS
server at z.z.z.z
**** "No response from DNS x.x.x.x when resolving 'yyy' to an address.
The DNS server at x.x.x.x did not respond when attempting to resolve the DNS
name yyy to an address.
**** "No response from DNS x.x.x.x when resolving 'y.y.y.y' to a name.
The DNS server at x.x.x.x did not respond when resolving the address y.y.y.y
to a name.
dbug "DNS packet with bad format from y.y.y.y"
InterMapper received a DNS response with an invalid format.
dbug "Error ### while processing DNS reply from y.y.y.y"
InterMapper received an error while processing a DNS response.
**** Connected to > InterMapper DataCenter at 127.0.0.1
InterMapper connected successfully to InterMapper DataCenter
**** Disconnected from > InterMapper DataCenter at 127.0.0.1
InterMapper was disconnected from InterMapper DataCenter
- 238 -
Chapter 7: Purging Chart Data
These messages describe problems with the Custom Probe files. Many of them are
self-explanatory.
dbug "MyProbe: Probe definition does not contain a valid <description> section.",
cFileName
dbug "xxxx: Probe definition does not contain a valid <snmp-device-display> sec-
tion."
The xxxx probe file does not contain a valid <snmp-device-display> section.
dbug "MyProbe: Probe definition does not contain a valid end tag for <MyProbe>.",
cFileName, endTagStr
- 239 -
Event Log Messages
Trap-Related Messages
trap "y.y.y.y (not on map) :: text-msg"
InterMapper received a trap from device y.y.y.y containing the text-msg
trap "An error occurred while processing a SNMP trap from y.y.y.y. (err = ###)"
InterMapper encountered an error processing a trap from y.y.y.y
- 240 -
Chapter 7: Purging Chart Data
Notification Messages
ntfy "Silenced e-mail notification to "username"."
InterMapper suppressed an e-mail notification to the listed user because of the
Snooze Alarm
ERR! "Failed to send e-mail notification to "username" for "message: devicename"
event. Check e-mail configuration. (err = ###)"
InterMapper was unable to send an e-mail notification to the named person
because of the error code ###
ntfy "Sent e-mail notification to "username" for "message: devicename" event. (n
of m)"
InterMapper sent an e-mail notification as indicated. The "n of m" indicates
that the n'th repeated message has been sent
ntfy "Silenced pager message notification to "username"."
InterMapper suppressed a page to the listed user because of the Snooze Alarm
ERR! "Failed to send pager notification to "username" for "message: devicename".
(err = ###)"
InterMapper was unable to send a page to the named person because of the
error code ###
ntfy "Sent pager message notification to "MyProbe" for "MyProbe: MyProbe".",
itsUserName, eventMesg, deviceName
ERR! "Failed to send SNMP trap notification to "MyProbe" for "MyProbe: MyProbe".
(err = %d)", itsUserName, eventMesg, deviceName, err
ntfy "Sent SNMP trap notification to "MyProbe" for "MyProbe: MyProbe".", itsUser-
Name, eventMesg, deviceName
ERR! "Failed to send pager notification to MyProbe. (err = %d)", itsUserName, err
- 241 -
Event Log Messages
ERR! "SMTP Failure: Can't connect to "MyProbe". Error = %d", itsMailServer, err
ERR! "SMTP Failure: Server connection to "MyProbe" idle for more than 4 minutes.
Disconnecting...", itsMailServer
ERR! "SMTP Failure: Server "MyProbe" won't accept mail from MyProbe. (Reply =
%d)", itsMailServer, reversePath, replyCode
ERR! "SMTP Failure: Server "MyProbe" rejected recipient MyProbe. (Reply = %d)",
itsMailServer, emailAddr, replyCode
ERR! "SMTP Failure: Server "MyProbe" failed when sending mailto MyProbe. Mail
not sent. (%s Reply = %d)", itsMailServer, emailAddr, cmdName, replyCode
- 242 -
Chapter 7: Purging Chart Data
- 243 -
Event Log Messages
- 244 -
Chapter 7: Purging Chart Data
- 245 -
The Outages Log
l From the Windows Menu, choose Outages from the Logs submenu. The Event
Log window appears, as shown below.
The Outages window shows the start and end time and the duration of outages.
The controls in the Outages Log window are identical to those of the other Event
Log (Pg 235) windows, and are described on that page.
- 246 -
Chapter 7: Purging Chart Data
Debug Logs
InterMapper maintains two debug logs:
l The Server Debug Log - available from the Window menu's Logs submenu.
l The Client Debug Log - available from the Help menu's Diagnostics sub-
menu.
The Server Debug Log contains details of the InterMapper Server's operations that
can be valuable for troubleshooting various configuration problems. It stores mes-
sages generated by the server.
l From the Window menu's Logs submenu, choose Client Debug Log.
- 247 -
Debug Logs
The Client Debug Log shows details of InterMapper's operations that can be valu-
able for debugging problems with the program. If you have trouble with Inter-
Mapper, the support staff may ask you to Send Feedback (Pg 216). The Send
Feedback form sends the Client Log by default.
The Client Log Window shows the contents of the Client Log.
l From the Help menu's Diagnostics submenu, choose Client Debug Log.
Windows:
Control + Alt + Shift + Z
Linux/Unix:
The Client Debug Log window opens, and Debug and Misc menus appear in the
menu bar at the top of the window.
In general, Help/Systems does not document the information shown in the Client
Debug Log window, because its messages will change from version to version.
Note: Opening the Client Debug Log window creates two new menus. Certain of
the items in these menus are designed to test InterMapper's crash recovery facil-
ities. Certain others may exercise portions of the program that may crash.
- 248 -
Chapter 8
Server Settings
Use the Server Settings window to view and edit the settings of an InterMapper
server. You must have administrator privileges to access the Server Settings win-
dow.
The Server Settings documentation in this manual is divided into three topics:
l Server Information Panels (Pg 251) - view information about the InterMapper
version. View and edit the server name and software licenses.
l Server Preferences Panels (Pg 253) - set defaults and other preferences for
your server.
l Server Configuration Panels (Pg 277) - set up the web, telnet, Reports, and
InterMapper Remote servers, enable and disable maps, create users and
groups and set up map access, define notifiers, and set up an SSL certificate
for the InterMapper server.
Use the Server Preferences section of the Server Settings window to view and edit
default InterMapper's server settings.
- 249 -
Chapter 8: Server Settings
1. From the Edit menu, choose Server Settings... The Server Settings window
appears, showing three sections of settings on the left. On the right is a panel
in which the selected settings appear.
2. Click the subsection for the settings you want to edit. The selected settings
appear in the right panel.
- 250 -
Server Information Panels
Use the Version & Credits panel to view the following information.
Properties
Use the Properties panel to view information about the InterMapper host system.
You can also set the server name from this panel:
Server Name View and set the name of the machine on which Inter-
Mapper is running. This name appears in the Map List
window.
<OS type> Run- The length of time the operating system has been run-
ning Time ning.
Server Running The length of time the InterMapper Server has been
Time running.
- 251 -
Chapter 8: Server Settings
Registration
Use the Registration panel to view information about your monitored devices, to
view a list of licensed products, and to add new licenses for software.
- 252 -
Server Preference Panels
- 253 -
Chapter 8: Server Preference Panels
SNMP Preferences
Use the SNMP subsection of the Server Preferences section to set the default SNMP
settings for each SNMP access method. These settings are used for all new
devices.
InterMapper can retrieve data from devices using SNMP version 1, version 2c, or
version 3. Each of these can access the same SNMP information, but through dif-
ferent means:
l SNMPv1 was the original version, and provided a simple means for retriev-
ing data. Security was provided through community strings that acted like a
password to allow or deny access to the information. The Read-Only com-
munity string gave permission to the requester to read data; the Read-Write
community string gave permission to modify data. All data transmissions
(including the community string) were sent "in the clear", that is, unen-
crypted.
l SNMPv2c provided additional, more efficient methods to request data, and
added new data types (such as 64-bit counters) so that the monitoring system
could get more accurate data. SNMPv2c is like SNMPv1 in that it uses the
same community string system, and transmits data in the clear.
l SNMPv3 provides the same data retrieval facilities as SNMPv2c, with addi-
tional security. There is a secure method of providing authentication inform-
ation (so the device knows whether to respond to the query or not), as well as
a privacy function that encrypts the entire transmission so that eaves-
droppers cannot discern the data.
The SNMP Read-only Community string is like a user id or password that allows
access to a router's or other device's statistics. InterMapper sends the community
string along with all SNMP requests. If the community string is correct, the device
responds with the requested information. If the community string is incorrect, the
device simply ignores the request and does not respond.
Note: SNMP Community strings are used only by devices which support SNMPv1
and SNMPv2c protocol. SNMPv3 uses username/password authentication, along
with an encryption key.
- 254 -
SNMP Preferences
l SNMP Trap community string - included when a device sends SNMP Traps
to InterMapper. InterMapper accepts any SNMP Trap community string.
By convention, most SNMPv1-v2c equipment ships from the factory with a read-
only community string set to "public". It is standard practice for network managers
to change all the community strings so that outsiders cannot see information about
the internal network. (In addition, network managers may employ firewalls to
block any SNMP traffic to ports 161 and 162 on the internal network.)
InterMapper remembers the default settings for each of the various SNMP access
methods. These are set in the Server Settings>SNMP preference pane.
l SNMP Version - Select the default Setting the default SNMP preferences
SNMP version to be used for new devices
in autodiscovery. InterMapper will attempt to use the selected version when it
discovers a new device. If it gets a response, it will continue to use that ver-
sion. If that fails, then it will simply ping the device.
l SNMPv1-2c Community - If the selected SNMP Version is either SNMPv1 or
SNMPv2c, InterMapper will use this community string to attempt to com-
municate with the device.
l SNMPv3 Authentication - If the selected SNMP version is SNMPv3, Inter-
Mapper will use the specified authentication method (SHA, MD5, or None)
with the indicated password on the right to authenticate with the device.
l User Name - The SNMPv3 user name to be used for authentication and pri-
vacy.
l Privacy - When using SNMPv3, the privacy method (DES, AES, or None) will
be used with the encryption password on the right.
- 255 -
Chapter 8: Server Preference Panels
l Listen for SNMP Traps on UDP Port 162 - Check this box if you want
InterMapper to listen for SNMP traps sent from devices to the standard port
162.
l Also listen for SNMP traps on UDP port - InterMapper can listen for
traps on a second, non-standard port (in addition to port 162). Check this box
and enter the port number in the text box. Traps received on this alternate
port are handled in the same manner as those received on port 162.
l Verbose trap logging - Check this box to instruct InterMapper to display
the full OID and contents for all varbinds of a trap, instead of simply the var-
bind contents.
The panel shown above sets the default SNMP preferences that InterMapper uses
when querying devices. You can also set SNMP preferences for individual devices
on your map using the Set Community... (SNMPv1-v2c) or Set Probe... (all
three SNMP versions) commands, available from the Monitor menu. You can set
various parameters for one or more devices at a time, by selecting the devices you
want to change before executing the command.
- 256 -
Log File Preferences
l Choose the file you want to view from the Logs submenu of the Windows
menu.
1. From the Edit menu, choose Server Settings... The Server Settings window
appears.
2. Click Log Files. A list of log files appears in the right panel, showing the cur-
rent Log File preferences for the selected log file.
The Log File preferences pane shows a list of currently defined log files with prop-
erties for the selected file.
- 257 -
Chapter 8: Server Preference Panels
l To see a brief explanation of the function of a log file, click the log
file in the list. The explanation appears in the lower panel of the Preferences
pane.
l To add a log file, click Add New Log. The Log File Preferences (Pg 259)
for the new log file appear.
l To edit a log file definition, click to select a log file definition. The prop-
erties for the selected log file appear. The Log File Preferences (Pg 259) for
the selected log file appear.
l To delete a log file, click to select a log file definition, then click Delete
this Log. The log file definition disappears from the list.
Note: The Debug Log, Event Log and Outages Log cannot be deleted.
- 258 -
Log File Preferences
The example above typical log file preferences. It shows the names of the log files,
and their rotation intervals.
1. Click Add New Log. The Log File preferences (Pg 259) for the new log file
appear.
2. Set the log file preferences (Pg 259) as described below.
1. Click to select the log file. The Log File preferences (Pg 259) for the selected
log file appear.
2. Set the log file preferences (Pg 259) as described below.
- 259 -
Chapter 8: Server Preference Panels
Log File Name - Set the filename (actually the prefix) for the log file. You can
enter up to 14 characters (see Log File Naming and File Format (Pg 261)
below.) The file is given a .TXT extension, and can be edited with any text editor.
Start New Log File - Use these settings to specify how often and at what point in
a log cycle the current log file is closed and a new one is opened. This allows you to
break the log files into convenient sizes and/or time epochs. Choose from these
options:
l Never
l Once daily
l Twice daily
l Once weekly
l Twice weekly
Delete log files after __ days/weeks - Check this box to force InterMapper to
delete old log files automatically after a certain date.
Note: Each time InterMapper starts a new log file, it checks to see if any log files
should be deleted. On platforms where the file creation date is available, it is used
to determine whether a log file should be deleted. If the creation date is not avail-
able, the file's last modification date is used.
By default, all entries go to the built-in Event Log file. You can redirect streams of
log entries from InterMapper's Remote Server, Web Server, or Telnet server to a
particular log file (and syslog server). This can be useful, for example, for sending
all web access events one file, and all outage events to a different file.
1. Create a new log file definition for the file you want to receive the log entries,
as described above.
2. From the Edit menu, choose Server Settings... The Server Settings window
appears.
3. In the left panel of the Server Settings window, click to choose the server
(Remote, Web, or Telnet) whose log entries you want to send to a different
log file. The panel for the selected server appears.
4. In the Send Log File Entries to menu, choose the log file you created to
receive the log entries. All log file entries for the selected server are redir-
ected to the new log file.
- 260 -
Log File Preferences
Log files are saved in text format in the InterMapper Settings:InterMapper Logs
folder. Each file has a user-defined prefix that describes its function, and ends with
a suffix of .yyyymmddhhmm.txt, where the suffix is the (four-digit) year, month,
day, hour and minute when the file was created. The prefix can be up to 14 char-
acters in length.
Three built-in log files are always present, and cannot be deleted:
l The Event Log file - when you first launch InterMapper, the Event log file
receives all entries from all sources. You can divert certain streams to other
log files.
l The Outages file - contains entries that describe the start and end times of
outages, as well as their duration. This stream of entries cannot be redirected
to any other log file.
l The Debug file - displays certain debugging information, as described in The
Debug Window (Pg 247).
- 261 -
Chapter 8: Server Preference Panels
DNS/WINS Settings
Use the DNS/WINS Settings section to specify the DNS server(s) and WINS server
(s) that InterMapper uses. InterMapper uses your current DNS servers as its
default.
InterMapper can use one or more Domain Name Service servers (DNS) to convert
DNS names to addresses and back. InterMapper checks the listed DNS server(s) at
regular intervals to make sure that the DNS name and IP address for a device
match.
When you start InterMapper on a MacOS X or Windows machine, the DNS servers
specified by the current network configuration are used. On Unix machines, you
must enter one or more DNS server addresses manually.
The DNS addresses are optional: if the preference is empty, InterMapper does not
attempt to make DNS <-> IP address conversions.
For example, when InterMapper polls a device that has a name assigned, it looks
up the corresponding IP address in the DNS. If the resulting address has changed
since the device was added to a map, InterMapper logs an error message.
- 262 -
DNS/WINS Settings
You can specify one or more WINS servers that InterMapper will use for WINS look-
ups. InterMapper can also fall back to broadcast lookups for WINS/NetBIOS name
lookups. Unless instructed by your network administrator, you should usually
leave the WINS Scope blank.
l Use WINS name resolution - Check this box to allow InterMapper to use
the specified WINS servers to look up device names and addresses.
l Comma-separated list of WINS server addresses - Enter a list of
addresses, separated by commas.
l Use broadcast if lookup fails - Check this box to allow InterMapper to use
broadcast lookups for WINS/NetBIOS lookups if the WINS lookup fails.
l WINS Scope - Enter a WINS Scope. This should only be necessary if instruc-
ted by your network administrator.
- 263 -
Chapter 8: Server Preference Panels
E-Mail Preferences
Use this panel to enter the information required to send e-mail notifications.
l Primary SMTP - Enter the Host name. If your SMTP server requires authen-
tication, enter a User, Password, and Port for the primary SMTP host. Port 25
is typically used for outgoing E-mail servers.
l Back-up SMTP - Enter the Host name. If your SMTP server requires authen-
tication, enter a User, Password, and Port for the back-up SMTP host. If unsuc-
cessful sending through the primary host, InterMapper attempts to deliver e-
mail messages through the Back-up host.
Notes: InterMapper supports the PLAIN and CRAM-MD5 authentication com-
mands. You can use different E-mail accounts and passwords for the primary
and back-up SMTP servers.
l From address - Enter the E-mail address you want to appear as the From:
line of the message.
l Errors to - Enter the address you want to uses in the Errors-To: line of the
message. Bounce messages are returned to this address.
l Automatically e-mail InterMapper bug reports - Check this box to
allow InterMapper to send reports of errors and bugs to the staff at Help/Sys-
tems automatically.
l Send bug reports to - Enter the E-mail address you want to use when
sending bug reports.
- 264 -
Default Map Colors
Use the Default Map Colors preference to view and edit the default colors for all
map items and features.
l From the Server Preferences section of the Server Settings window, click
Map Color Defaults. The Map Color Defaults preferences appear in the
right pane.
- 265 -
Chapter 8: Server Preference Panels
Note: Changing the default colors changes the colors assigned to an existing map
only if Use server defaults is checked in the map's settings (it is checked by
default). Change an individual map's colors from the Map Settings (Pg 86) win-
dow.
- 266 -
Default Device and Network Preferences
Use the Device Defaults and Network Defaults Preferences to change the default
appearance of devices and networks.
Note: The Device Defaults and Network Defaults Preferences are identical in
appearance and function. One affects the default appearance of devices, while the
other affects the default appearance of networks.
Device Defaults
Network Defaults
- 267 -
Chapter 8: Server Preference Panels
1. From the Map List window, click to select any map on the server whose set-
tings you want to edit.
2. From the Edit menu, choose Server Settings... The Server Settings window
appears.
3. In the Server Preferences section, click the Device Defaults or Network
Defaults subsection. The default settings for the selected subsection appear.
4. Edit the preferences as described below.
5. When finished, click OK.
Shape Choose a default shape for the device or network from the dropdown
menu.
Color Choose a default color for the device or network from the dropdown
menu.
Label Choose a default font for the device or network's label.
Font
Label Choose a default font size for the device or network's label.
Size
Position Choose a default position for the label text, relative to the device or
network icon.
Note: The Position parameter affects only Wire and Icon shapes.
Edit Set default labels for numbered and unnumbered networks, as
Label... described in Editing (Pg 106) Labels (Pg 106).
- 268 -
Default Device Thresholds
Note: Only SNMP probes have thresholds for all three parameters (round-trip
time, packet loss and interface errors); a ping/UDP-based probe monitors only
round-trip time and packet loss, and a TCP probe monitors only round-trip time.
For more information on device thresholds, see Setting Error and Traffic
Thresholds (Pg 208).
Use the the Set devices to Alarm status on down link check box to control the
behavior of alarms when an interface goes down.
l Trigger an alarm for the device when any interface goes down - select
the check box.
l Trigger an alarm for an individual interface when an it goes down -
clear the check box.
- 269 -
Chapter 8: Default Server Interface Thresholds
For more information on interface thresholds, see Setting Error and Traffic
Thresholds (Pg 208).
- 270 -
Chart Defaults
Chart Defaults
Charts (see Creating Charts (Pg 219) and Using Charts (Pg 219)) can show his-
torical data for values received from one or more devices. Use the Chart Defaults
panel of the Server Preferences section of the Server Settings window to view and
edit the default settings for a newly-created chart.
1. From the Edit menu, choose Server Settings... The Server Settings window
appears, showing the list of available settings. On the right is a panel in which
the selected settings appear.
2. Click Chart Defaults. The Chart Defaults panel appears in the right panel of
the Server Settings window.
Axes Tab
Use the Axes Tab of the Chart Defaults panel to define the appearance and beha-
vior of newly-created charts.
Upper Bounds,
Lower Bounds -
Enter values to
control the ver-
tical scale of the
chart. The range
of values
depends on the
variable being
monitored.
Auto-adjust -
Select or clear
the Auto-adjust
check box to
choose whether
to allow Inter-
Mapper to adjust
the scale of the
chart auto-
matically. If the
Auto-adjust
check box is
checked, the The Axes Tab
upper and/or
lower bounds are adjusted automatically so that data points are always displayed,
no matter how much they increase or decrease.
- 271 -
Chapter 8: Default Server Interface Thresholds
sub-dividers you want to appear between the dividers. Example: Set the number of
dividers to 3. Set the number of sub-dividers to 4. This gives a total of 11 dividers.
(Three dividers - top, bottom, and center, with four dividers between each. Eight
subdividers and three dividers.)
Show Date, Show Day of Week, Show Time, 24 Hour Time - Click to select
or clear these check boxes to specify which labels appear on a chart's horizontal
axis by default.
Default Interval - Use the drop-down menu to choose a default interval between
time stamps on the X-axis (horizontal) of new charts. Shorter intervals show finer
detail, longer intervals show a longer history.
Note: Because InterMapper saves all the data points, there is no limit to the
amount of memory needed to save a chart. Choosing a longer time interval does
not save memory - all the data points are saved.
Sub-Dividers - Click the up- and down-arrows to specify the number of vertical
sub-dividers to draw between data points.
Data Tab
Use the Data Tab of the Chart Defaults panel to choose line and data point styles.
Style
Highlight
- 272 -
Chart Defaults
Colors Tab
To change a
color:
- 273 -
Chapter 8: Default Server Interface Thresholds
Retention Policies
Use the Retention Policies pane to create and edit retention policies that can be
used to specify how data is stored for a particular device or map.
Each row shows a Retention Policy, and its setting for retaining Original, 5-minute,
Hourly, and Daily data from devices, as well as data from Charts.
- 274 -
Retention Policies
You can use data retention policies to consolidate raw data, reducing the amount of
data stored. Data retention policies control how often and how much data is aver-
aged and reduced.
A data retention policy can be applied to a specific map, to one or more devices or
interfaces on a map, to an individual dataset, or to all maps on an InterMapper
Server. Policies also affect the way InterMapper stores chart data.
Use the Create Retention Policy window to define a new retention policy. The same
window is used for editing an existing policy.
1. In the Retention Policies pane, click the retention policy you want to edit.
2. Click the Pencil tool. The Edit Policy window for the selected policy appears.
- 275 -
Chapter 8: Default Server Interface Thresholds
Notes:
Use the NT Services panel of the Server Preferences section to set the User and
Password for the machine. If you are running InterMapper Server on a Windows
machine, this allows InterMapper to build a list of services the machine is running.
- 276 -
Server Configuration Panels
Use the Server Configuration panels of the Server Settings window to view and
edit settings for the built-in servers, to manage users and groups, to control map
access, and to manage a list of notifiers/alerts (Pg 131).
In the left pane of the Server Settings window, click the button for the settings you
want to edit, as follows:
l Remote Server (Pg 282) - Start, stop, or edit settings for the InterMapper
RemoteAccess server.
l Reports Server (Pg 285) - Start stop, or edit settings for the InterMapper
Reports Server.
l Web Server (Pg 289) - Start, stop, or edit settings for the InterMapper web
server.
l Telnet Server (Pg 291) - Start, stop, or edit settings for the InterMapper
Telnet server.
l Layer 2 Features (Pg 294) - Turn on Layer 2 discovery for your server.
l Enabled Maps (Pg 296) - View a list of available maps, enable or disable
maps, and import or export maps.
l Users (Pg 298) - View, Add, and Edit users and groups, and control access
for users and groups.
l Map Access (Pg 305) - Control access by any user or group to any map
through the web server or remote server.
l Map Backup (Pg 307) - Enable automatic map backups and create a sched-
ule for backing them up.
l Notifier List (Pg 308) - View, add, copy, edit and remove notifiers.
l SSL Certificate (Pg 310) - Create new Certificate Signing Requests (CSR)
and upload new certificates to the InterMapper server.
For more information on configuring your servers, see Server Access Control (Pg
280). It tells how to set a server's port, discusses encryption and when to use it,
and describes how to configure a server's built-in firewall's list of IP addresses.
- 277 -
Chapter 8: Server Configuration Panels
Configuring a Firewall
For each built-in server, the Firewall list shows all the addresses that are allowed
to connect or are blocked:
Firewall definitions are applied in the order in which they appear. You can change
the order of the definitions after you have created them.
You can enter addresses in the access control list in three different formats:
l Fully-specified IP addresses
Example: 192.168.1.10
l Address ranges
Example:192.168.1.1-31. This specifies any device in the range
192.168.1.1 to 192.168.1.31.
l Addresses with a "*" wildcard Each wildcard corresponds to a range of 0-
255.
Example: 192.168.1.* (equivalent to 192.168.1.1-255)
Example: 192.168.*.* (Class B range)
Example: *.*.*.* ("all addresses")
- 278 -
Configuring a Firewall
Tip: To deny access to certain addresses, add them at the top of the list and set
the Access attribute to "Deny".
For a description of the Access Control process and the rules InterMapper uses to
determine whether a user should be allowed to connect to an InterMapper server,
see Controlling Access to Your Server (Pg 280).
- 279 -
Chapter 8: Server Configuration Panels
Notes:
l You can also control access through the InterMapper Authentication Server
(Pg 623), which connects to an external authentication server such as Radius,
LDAP, or ActiveDirectory to authenticate a user. For more information, see
Authentication Server (Pg 623).
l Any firewall that is protecting the machine that is running InterMapper must
be configured to allow access to the ports specified for remote access. This
includes the port specified for use by the web server.
When a user attempts to connect to one of the InterMapper servers, the request
goes through these steps:
3. If the client's IP address does not match an Automatic Login address, the con-
nection is accepted and authentication by a username and password begins,
as follows:
a. Web server - issues a "401 Unauthorized" response, which forces the
web browser to request a username/password from the user.
b. Telnet server - prompts for a username and password.
c. Remote server - proceeds after the InterMapper RemoteAccess client
requests and supplies a username and password.
4. The username and password are verified against InterMapper's
built-in authentication database. If they match, the connection is
assigned the user name. Otherwise, the connection is dropped with a "not
allowed" response. When using the Remote and Telnet servers, an error mes-
sage appears, saying that the user name is not allowed. When using the Web
server, a web page appears, saying that the user is not allowed access.
5. The users is checked for membership in a Special Group. These spe-
cial groups give broader access:
l Administrators Group
If the user is a member of the Administrators group, the connection is
- 280 -
Controlling Access to Your Server
- 281 -
Chapter 8: Server Configuration Panels
You can configure InterMapper to accept connections from remote computers, giv-
ing varying degrees of access by IP address or by username and password.
Unlike the Telnet and Web servers, you cannot start or stop the Remote Server.
You configure the Remote Server using the Remote Server settings panel of the
Server Configuration section, found in the Server Settings window.
- 282 -
The Remote Server
1. From the Edit menu, choose Server Settings... The Server Settings window
appears.
2. In the Server Configuration section, click Remote Server. The Remote
Server panel appears.
Note: The Server Settings window is available only to users who have admin-
istrator privileges.
Click Show Connected Clients to view a list of InterMapper clients connected to the
server. The Remote Clients window appears, showing the connected user's name,
IP address, time of login and type of license.
Additional Information
For more information on configuring your Remote Server, see Server Access Con-
trol (Pg 280). It describes how to set your Remote Server's port, discusses encryp-
tion and when to use it, and describes how to configure the built-in firewall's list of
IP addresses.
For more information on configuring your built-in servers' firewalls, see Con-
figuring a Firewall (Pg 278).
For more information on users and groups, see Users and Groups (Pg 298). It
describes how to set up users and groups, and how you specify who may use the
Remote Server. It also discusses administrator access to the Remote Server.
- 283 -
Chapter 8: Server Configuration Panels
For more information on setting permissions for a particular map, see Controlling
Access to a Map (Pg 305). It describes how to set up unique access controls (by
username) for an individual map.
- 284 -
Reports Server
Reports Server
The Reports Server stores data in a database for use in reports. Use the Reports
Server panel, available from the Server Configuration section of the Server Set-
tings panel, to specify the amount of data you want to store in the database.
l Click Configure... For more about configuring the Reports Server, see Con-
figuring InterMapper DataCenter for more information.
You can start and stop collection of data on the Reports Server.
- 285 -
Chapter 8: Server Configuration Panels
- 286 -
Reports Server
Every minute, InterMapper Reports Server sends a request for a certain number of
rows of current data to insert into the database. The request contains a start and
end time, where the start time is the oldest data desired, and the end time is the
newest (generally, the present time).
The response from InterMapper Server contains the rows to insert into the data-
base, as well as the time of the next row to request. InterMapper Reports Server
uses this information to update its notion of the current time, and the subsequent
requests use that time.
The number of rows in the request is automatically adjusted so that the insertion
process uses approximately half of the (one minute) time interval. Typically, 500
rows are requested for events and 25,000 rows are requested for data points.
If the time of the next row in the response is less than the requested end time,
InterMapper Reports Server can tell that there is more data available.
The InterMapper Server responds with those rows, and InterMapper Reports
Server inserts them and updates the time of the next (oldest) row. Subsequent
requests start at this time, and retrieve still older data rows.
Use the Collection Profile dropdown menu to specify the rate at which Inter-
Mapper Reports Server requests the historical data:
- 287 -
Chapter 8: Server Configuration Panels
Certain variables for probes are recorded automatically when data is collected
from a device by InterMapper Reports Server. You can also specify other variables
you want to record when data for a device is stored.
For built-in probes, Help/Systems has selected values that make sense to record
for each probe.
For custom probes, you can specify which variables should be recorded. The syn-
tax for this is described in Recording Probe Data in the Developer Guide.
- 288 -
The Web Server
Note: Before InterMapper will allow web connections, you must configure the web
preferences as described in Configuring a Firewall (Pg 278). You must also make
sure that any other firewalls protecting the InterMapper machine allow traffic to
the port specified below.
You start, stop, and configure the Web Server from the Web Server panel, in the
Server Configuration section of the Server Settings window, as shown below.
Note: When configuring the InterMapper web server on a machine where IIS is
also installed, do not use the default port 80. IIS uses port 80 by default, and this
will prevent the InterMapper web server from starting.
- 289 -
Chapter 8: Server Configuration Panels
1. From the Edit menu, choose Server Settings... The Server Settings window
appears.
2. In the Server Configuration section, click Web Server. The Web Server
panel appears.
Note: The Server Settings window is available only to users who have admin-
istrator privileges.
For more information on configuring your Web Server, see Server Access Control
(Pg 280). It describes how to set your Web Server's port, discusses encryption and
when to use it, and describes how to configure the built-in firewall's list of IP
addresses.
For more information on users and groups, see Users and Groups (Pg 298). It
describes how to set up users and groups, and how you specify who may use the
Web Server. It also discusses administrator access to the Web Server.
For more information on setting permissions for a particular map, see Controlling
Access to a Map (Pg 305). It describes how to set up unique access controls (by
username) for an individual map.
Once you have started the Web Server, a URL appears below the Web Server's
Stop button. Click the URL, or enter the URL in a web browser. If the Web Server
is configured correctly, the InterMapper Web Server's home page appears in your
browser window.
- 290 -
The Telnet Server
You start, stop, and configure the firewall for the Telnet Server from the Telnet
Server settings panel, in the Server Configuration section of the Server Settings
window, as shown below:
- 291 -
Chapter 8: Server Configuration Panels
1. From the Edit menu, choose Server Settings... The Server Settings window
appears.
2. In the Server Configuration section, click Telnet Server. The Telnet Server
panel appears.
Note: The Server Settings window is available only to users who have admin-
istrator privileges.
For more information on configuring your Telnet Server, see Server Access Control
(Pg 280). It describes how to set your Telnet Server's port, discusses encryption
and when to use it, and describes how to configure the built-in firewall's list of IP
addresses.
For more information on users and groups, see Users and Groups (Pg 298). It
describes how to set up users and groups, and how you specify who may use the
Telnet Server. It also discusses administrator access to the Telnet Server.
- 292 -
AutoMate
AutoMate
Use the AutoMate pane of the Server Settings window to enable and configure a
connection to a local version of the AutoMate application.
Host - Currently, the AutoMate server must be running on the same machine as
InterMapper Server.
Password - The default task password, if one is not supplied during task selec-
tion.
Polling Interval - The number of seconds to be used when polling the AutoMate
server to check the status of a task. When set to zero, the polling interval
increases over the length of time the task has been running.
Server System Tasks - Select the boxes for the system events you want to run
AutoMate tasks. These include InterMapper system startup, completion of a sched-
uled map backup, and log file rotation.
- 293 -
Chapter 8: AutoMate
Layer 2 Features
Use the Layer 2 Features panel to enable Layer 2 features and specify how you
want to use them.
l Enable Layer 2 features on this server - select this check box to turn on
Layer 2 features.
l [NN] Maps Enabled - Click this link to choose the maps for which Layer 2 is
enabled. The Layer 2 Enabled Maps window appears as shown below.
- 294 -
Layer 2 Features
Note: In order to use the Layer 2 features in your map, after enabling Layer 2 fea-
tures in the Server Settings window, you must enable them in the Map Settings win-
dow for each map that contains Layer 2 devices.
Discovery Options
- 295 -
Chapter 8: AutoMate
Enabled Maps
Use the Enabled Maps panel of the Server Settings window to enable and disable
maps, to remove maps, to organize them into folders, and to import and export
them.
The Enabled Maps panel lists available maps and shows which ones are enabled.
From the Enabled Maps panel, you can do the following:
l Enable or Disable a map. Click the check box to the left of a map in the list
to enable or disable it.
l Import a map. Click Import... to import data into InterMapper.
l Export a map. Click Export... to save the current map as an InterMapper
map file on your local machine.
l Duplicate a map. Click to select a map, then click Duplicate to create a
copy of it.
- 296 -
Enabled Maps
From the Enabled Maps panel, you can create folders, and use them to organize
your maps. This organization then appears in the Map List window.
1. If you want to create a folder in the top level of the map list, click any map at
the top level, and click New Folder. A folder appears, with the name
"Untitled". To create a folder within a folder, click the folder in which you
want to create the new folder.
2. Enter a name for the new folder and press Enter. The folder's name changes
to the specified name, and the folder moves to the correct alphabetic location
in the list.
3. Drag maps into the folder.
Note: When you create a folder with the same name as a map at the same hier-
archical level, a folder appears. Once the folder is created, when you double-click
the folder in the Map List window, the map opens.
- 297 -
Chapter 8: AutoMate
Note: The Server Settings window is available only to users who have admin-
istration privileges.
Use the Users panel to maintain the list of users and groups allowed to access the
various servers.
- 298 -
Users and Groups
The example below shows a typical user and group configuration in the Users panel
of the Server Settings window.
l User
An individual identified by a user name and password, or identified auto-
matically from a clients' IP address or range.
l Group
A collection of users. A group can be given permissions to access certain serv-
ers or maps, and may be given different levels of access for a server or map.
- 299 -
Chapter 8: AutoMate
1. Click the + button and choose Add User... The User Information dialog
appears, as shown in the two examples below.
2. Enter the name and password for the new user in the Name and Password
text boxes.
or
Omit the password and enter an IP address range in the Automatic Login
text box.
or
Select the Use External Authentication check box, and enter the user-
name used by the external authentication server. No password is necessary;
authentication is performed by the external authentication server.
These two examples show two different users. 'Fred Flintstone' must log in with a
name and password, and 'Tom Terrific' is automatically identified when connecting
from IP address 192.168.*.*.
- 300 -
Users and Groups
1. In the user list, click to select the user you want to edit.
2. Click Edit... or double-click the user entry. The User Information dialog
appears, containing information for the selected user.
A group is a collection of users, all of whom have the same set of permissions.
Click the plus sign (+) to the left of the group to expand it.
Click and drag the user's entry to the group entry. The user appears in the list of
users for that group.
Note: When you remove a user from a group, the user definition is removed only
from the group, not from the user list. To remove a user completely from the list
and all groups, see Removing Users and Groups (Pg 302)below.
- 301 -
Chapter 8: AutoMate
Note: The Administrators group is a special group that is always present, and
cannot be removed.
Note: The FullWebAccess group is a special group you define. If present, its
members can view all web pages, and can acknowledge devices through the web
server.
Note: The FullLogAccess group is a special group you define. If present, its mem-
bers can view all log files.
Note: The FullTelnetAccess group is a special group you define. If present, its
members have full access to the Telnet server.
Use the Import button to upload a file containing data for users and groups. For
information on importing data, see Importing Data (Pg 637). For information on
the User/Group data structure, see User Attributes (Pg 681).
- 302 -
Access Control Examples
1. From the Server Settings window, click a server (Remote Server, Web
Server, or Telnet Server). A list of firewall entries appears in the right
pane.
2. Add a firewall definition and set it to "Allow *.*.*.*."
3. From the Users panel (Pg 298), create a Guest account with an Automatic
Login address of "*.*.*.*".
Note 1: This is a very open setting. Be sure that you actually intend to
allow anyone to connect. This configuration might be reasonable if Inter-
Mapper were running behind a firewall, and thus not visible outside your
organization.
Note 2: The IP wildcard example above works with 32-bit IPv4 address.
InterMapper now supports 128-bit IPv6 addresses. Wildcard characters are
not currently supported for IPv6 addresses.
1. Define your user names and passwords as described in Users and Groups
(Pg 298).
2. From the Server Settings window, click Remote Server. A list of firewall
entries appears in the right pane.
3. Add a firewall definition and set it to "Allow *.*.*.*."
The users in the group can view all web pages, and can acknowledge down
devices.
- 303 -
Chapter 8: AutoMate
The users in the group can view all the log files.
When connecting from an IP address within the range specified for auto-
matic login, the user is automatically connected and assigned the specified
user name.
When connecting from an IP address outside the range specified for auto-
matic login, the user is prompted for a user name and password.
1. From the Server Settings window, click Remote Server. A list of firewall
entries appears in the right pane.
2. Click Add... The Firewall Definition dialog appears.
3. In the IP Address box, enter an IP address or IP address range (Pg 278).
4. From the Access dropdown menu, choose Deny.
5. Click OK.
These permissions are tested only if the user fails to match the global IP
address test and/or username and password
- 304 -
Controlling Access to a Map
Note: All individuals in the Administrators group have access to all maps.
InterMapper lets you control the access rights to each map in two ways:
The top example shows the list sorted per-user: it shows the rights that Crabby
Appleton has for each of the maps. The bottom example shows the list sorted per-
map: that is, it shows what access each user has to the Current Wireless Probes
map.
Choose Show Access by: User to control each map's access by a specific user
through the Web and Remote servers.
l To set a user's access for any open map, choose the user from the Show
User dropdown menu.
l To allow access to the selected map through the Web server, click the icon in
the Web column for the user or group whose access permissions you want to
set, then select a permission level.
l To allow access to the selected map through the Remote server, click the icon
in the Remote column for the user or group whose access permissions you
want to set, then select a permission level.
- 305 -
Chapter 8: AutoMate
Choose Show Access by: Map to control each user's access to a specific map
through the Web and Remote servers.
l To set access control parameters for any open map, choose that map from
the Map Name dropdown menu.
l To allow access to the selected map through the Web server, click the icon in
the Web column for the user or group whose access permissions you want to
set, then select a permission level.
l To allow access to the selected map through the Remote server, click the icon
in the Remote column for the user or group whose access permissions you
want to set, then select a permission level.
Select a map's Web and Remote server access permission levels for each user or
group as described below:
Read-Only Allow the user to view the map, but do not allow changes.
Access (Access to the web server is always read-only.)
- 306 -
Map Backup
Map Backup
Use the Map Backup panel of the Server Settings window to configure scheduled
backups of your maps.
Scheduled backups appear in the Backup and Restore windows as "Scheduled". For
more information, see Backup... section of the File Menu reference topic.
- 307 -
Chapter 8: Map Backup
Notifier List
Use the Notifier List section of the Server Settings window to add, edit, copy and
delete notifiers. For more information, see Using Notifiers (Pg 131).
1. From the Edit menu, choose Server Settings... The Server Settings window
appears, showing three sections on the left, each containing a list of available
settings. On the right is a panel in which the selected settings appear.
2. Click Notifier List. A list of notifiers appears in the right panel of the Server
Settings window.
- 308 -
Notifier List
l - ). A con-
Delete a notifier. Click to select a notifier, then click minus (
firmation window appears.
l Abort Pending Pages. All messages sent to pagers still in process are ter-
minated as soon possible, and any pages waiting to be sent are deleted. This
affects only pages sent to Dialup Pagers; it has no affect on SNPP pages or
other notifiers.
- 309 -
Chapter 8: Map Backup
SSL Certificates
InterMapper's web and remote servers can employ a certificate to encrypt the data
going between the server and clients. This assures that the client has connected to
the actual server, and not another server acting as an impostor.
InterMapper ships with a certificate signed by Help/Systems Inc. This will work;
the data is encrypted. But it's not using strong encryption (that is, it's easily
broken) and web browsers using HTTPS connections will give a warning that there
is a problem with the certificate, and that the data might be intercepted in transit.
To get stronger encryption and verification that the server is authentic, you can cre-
ate and install your own SSL certificate. This is a three-step process:
1. Create a Certificate Signing Request (CSR). The CSR contains all the inform-
ation needed to identify the computer. InterMapper has a built-in function for
collecting this information and building the certificate.
2. Sign the CSR. Signing is a process where an authority verifies the information
in the certificate.
3. Upload the signed certificate into InterMapper to make it operational.
In either case, you must first create a Certificate Signing Request (CSR), which is a
file that you can create using InterMapper. You then sign the CSR yourself, or send
it to a commercial Certificate Authority to sign.
Use the SSL Certificate panel, available from the Server Configuration section of
the Server Settings window to create a Certificate Signing Request, and to upload a
signed certificate to the InterMapper server.
The remainder of this topic describes the three separate steps in detail.
- 310 -
SSL Certificates
1. From the Edit menu, choose Server Settings... The Server Settings window
appears.
2. In the Server Configuration section, click SSL Certificate. The SSL Cer-
tificate panel appears.
3. Click Create new CSR... The Certificate Signing Request window appears,
as shown below.
4. Enter the required information as described below, and click OK. A 1,024-bit
private key is generated for your computer, and the information is then used
to create the Certificate Signing Request. The key and a copy of the CSR are
saved in the InterMapper Settings:Certificates folder, and a standard Save
File dialog appears.
You are being asked to save a copy of the CSR (with a filename of the FullyQu-
alifiedDomainName.csr) on your disk. We recommend you save this on the
desktop so it's easy to find when you create a signed certificate. After you
have requested a signed certificate, you can discard this file.
5. Click Save. The new certificate is saved in the specified location.
- 311 -
Chapter 8: Map Backup
l Common Name
Enter your full DNS
name or IP address of
your server. If possible,
it should include your
domain name.
l Organization
Enter the name of your
organization.
l Organizational Unit
If applicable, enter the
name of an organ-
izational unit within your
organization, such as a
department or division
name.
l Country
Enter a two-letter abbre-
viation for your country
l State or Province
Enter a state or province
name or abbreviation
l City or Locality
Enter a descriptive loc-
ation of the server.
l Make new private key
The first time you gen-
erate a CSR, this box is
The Certificate Signing Request
dimmed. On subsequent
window.
uses, select this check
box to create a new
private key. Leave it unchecked to use the same private key.
l Key Size
Choose 1024 or 2048 bits.
l Digest Type
Choose SHA1 or SHA2. SHA1 is the default value.
l Digest Size
If you choose SHA2, choose 256 or 512 bits.
When you click the OK button, InterMapper generates a private key for your com-
puter, then use the information entered above to create the Certificate Signing
Request. InterMapper will save following files in the InterMapper Set-
tings:Certificates folder:
You will also be asked to save another copy of the CSR (with a filename of the
FullyQualifiedDomainName.csr) on your disk. We recommend you save this on the
- 312 -
SSL Certificates
desktop so it's easy to find when you are ready to create a signed certificate. You
may discard this file after you have requested a signed certificate.
Once you have a CSR file, you must have it signed. There are two ways to do
this:
After the certificate has been signed, you can upload it using Upload new
Certificate... Either copy and paste the text of the certificate into this window, or
click Browse...
and locate the certificate file on your hard drive.
Stop the affected server from the Server Settings window, and then start it again.
These certificates are then used for HTTPS and InterMapper Remote client con-
nections if the SSL/TLS boxes are checked in the respective server settings.
- 313 -
Chapter 8: Map Backup
If you use a different application from InterMapper to create your Certificate Sign-
ing Request (CSR), InterMapper will not have access to the private key used to cre-
ate the CSR. To upload your certificate with the private key, create one text file
containing the signed certificate, the private key, and the CA's public certificate
chain (if included), and use the "Upload new certificate..." button to upload this
combined file.
Technical Notes
The design for this scheme is based on the SSL section of the Apache Mod-SSL http-
d.conf file.
- 314 -
Chapter 9
InterMapper Flows™
InterMapper has always made it easy to see heavy traffic at a glance. Its charts
show when traffic peaks, but not what it’s used for.
InterMapper Flows collects and stores Flows data from any device that supports its
collection (Flows Exporter). For information on supported devices, see Supported
Exporters (Pg 333) You can choose the available exporters from which you want to
collect data. For more information, see Flows Settings - Exporters Tab (Pg 334).
- 315 -
Chapter 9: InterMapper Flows™
- 316 -
The Flows Window
When you first open the Flows window, the Hosts tab is selected.
l 1: Filter tools (Pg 319) - select the subset of Flows data you want to view.
l 2: InterMapper Flows Settings (Pg 334) - view and edit InterMapper
Flows settings.
l 3: Time Range Selection tools (Pg 321) - select and navigate Flows data
over a specified period.
l 4: Refresh button (Pg 321) - click to refresh the current view of Flows data.
l 5: Set Graph Scale - choose a scale to use for viewing data in the Stack
Chart.
l 6: Stack Chart - view current Host, Port, or VLAN data in a stacked area
chart.
l 7: Hosts, Ports, or VLANs pie chart - view current Host, Port, or VLAN
data as a percentage of total data flow in a pie chart.
l 8: Hosts, Ports, or VLANs list table - view details about a specific host,
port, or VLAN.
l 9: Page Selection tabs - Click a tab to choose a Flows window page. (see
below.)
- 317 -
Chapter 9: InterMapper Flows™
l Top Hosts tab (Pg 323) - view a list of top talkers, listeners, or both, with
stack and pie charts showing the relative activity of each.
l Top Ports tab (Pg 327) - view a list of ports with the highest activity, with
stack and pie charts showing the relative activity of each.
l Top VLANs tab - view a list of VLANs with the highest activity, with stack
and pie charts showing the relative activity of each.
l Top Sessions tab (Pg 332) - view a list of sessions, with start and end IP
addresses and the start and end time of each session.
When collecting data from both NetFlow and sFlow exporters, you can tell at a
glance what kind of exporter the data is coming from.
- 318 -
The Flows Window
Filter Tools
Use the filter tools to view a subset of the data, selecting from available exporters,
talkers, listeners, ports or sessions collected by InterMapper Flows.
- 319 -
Chapter 9: InterMapper Flows™
- 320 -
The Flows Window
Use the time range selection controls to view and select a range of time for which
you want to view.
Back in Click the left arrow to view the previous page of data.
Time The amount of data shown is determined by the cur-
rent setting of the time range dropdown menu.
Forward Click the right arrow to view the next page of data.
in Time The amount of data shown is determined by the cur-
rent setting of the time range dropdown menu.
Forward Click the Now button to view the latest data. The
to Now amount of data shown is determined by the current
setting of the time range dropdown menu.
Zoom Out Click the Zoom Out button to reset the time range to
the most recent setting in the Time Range dropdown
menu.
Refresh Click the Refresh button to view the most recent data,
based on the setting of the time range dropdown
menu.
Auto- Choose a refresh interval from the Auto-refresh drop-
refresh down menu.
Interval
Time until The time to the right of the Auto-refresh Interval but-
refresh ton indicates the time until the next refresh of the win-
dow.
- 321 -
Chapter 9: InterMapper Flows™
- 322 -
Top Hosts Tab
Use the Top Hosts tab's Stack chart to view the relative activity of different hosts
over time. Each host's activity is stacked with the others, with the top host on the
bottom of the stack. Here's a typical stack chart:
The legend above the chart shows the top hosts for the data you
are currently viewing.
- 323 -
Chapter 9: InterMapper Flows™
Use the Host List to view detailed statistics about a particular host. Below is a typ-
ical host list, which shows the top 25 hosts.
l Click a column heading to sort by that column. Click again to reverse the sort.
l Click an unselected row to select it.
l Shift-click an unselected row to select all rows between that row and the cur-
rently selected row.
l Control-click a row to select or de-select it.
l Right-click a line or IP address from the Host list, and choose from the con-
text menu as described below.
l Legend - The top 10 hosts are indicated with color legends. The report shows
the top 25 hosts or ports, but places the "Other" category at the bottom of the
list, as it shows total traffic for the remaining hosts or ports not shown in the
- 324 -
Top Hosts Tab
previous 24 rows.
l Hostname - Contains the host name of the talker or listener.
l Address - Contains the IP address of the talker or listener.
l Country - Contains a flag indicating the country in which the host name or IP
address originates.
l Bytes - The volume of traffic (in bytes/kbytes/mbytes) for a particular row in
the specified time interval.
l % - The percentage of traffic attributed to this host during the specified time
interval.
l In - The number of bytes received by the host's IP address.
l Out - The number of bytes sent from the host IP address.
l Client - The number of bytes transmitted when the host was acting as a client
(for example, sending a request to another server.)
l Server - The number of bytes transmitted when the host was acting as a
server (for instance, when responding to a request from a client.)
Note: InterMapper Flows uses heuristic rules to determine which host is oper-
ating as a client or server:
l It has a built-in list of common server ports. If the port matches an
entry in the list, it is treated as a server.
l If there is no match with a common host port, the lower-numbered port
is treated as a server.
l Packets - The number of packets sent or received by this host.
l Sessions - The number of sessions including this host.
- 325 -
Chapter 9: InterMapper Flows™
Right-click or CTRL-click (Mac) on the Stack chart, Pie chart, or Host list, and
choose from the Context menu as follows:
Stack chart:
Pie chart:
Hosts List:
- 326 -
Top Ports Tab
Use the Top Ports tab's Stack chart to view the relative activity of different ports
over time. Each port's activity is stacked with the others, with the top port on the
bottom of the graph. Here's a typical stack chart:
l Click a legend above the Stack chart to select the corresponding line in the
Port list.
l Mouse over an area of the Stack chart to view port information for that activ-
ity.
l Click an area of the stack chart to select the corresponding line in the Port
list.
l Click and drag to select a region of the chart to reset the time range to that
area of the Stack chart.
l Click the Set Graph Scale button to set the vertical scale for the Stack chart.
Choose Auto to normalize the scale to the displayed data, or select a scale
between 1Kbits/second and 10GBytes/second.
l Right-click an area of the Stack chart and choose from the context menu as
described below.
- 327 -
Chapter 9: InterMapper Flows™
the context menu to bring a particular point in the Stack chart to the center of
the timeline.
l Double-click a pie segment, or right-click or Ctrl-click a segment and choose
Select on Port/Protocol [Service or Port number] from the context
menu to set a filter for that port.
l Right-click an area of the Stack chart and choose from the context menu as
described below.
Use the Ports List to view detailed data about the top 25 ports.
l Click a column heading to sort by that column. Click again to reverse the sort.
l Click an unselected row to select it.
l Shift-click an unselected row to select all rows between that row and the cur-
rently selected row.
l Control-click a row to select or de-select it.
l Right-click or Ctrl-click a row and choose Select All to select all rows.
l Right-click a selected row and choose Copy Selected Rows to copy the cur-
rently selected set of rows to the clipboard in tab-delimited format.
l Legend - The top 10 ports are indicated with colored legends. The report
shows the top 25 ports, but places the "Other" category at the bottom of the
list, as it shows total traffic for the remaining ports not shown in the previous
24 rows.
l Service - Contains the name of the server associated with the port.
l Protocol - Contains the protocol (TCP/UDP/GRE/ICMP) associated with the
port.
l Port - The port number
l Bytes - the volume of traffic (in bytes/kbytes/mbytes) for a particular row in
the specified time interval.
- 328 -
Top Ports Tab
l % - the percentage of that traffic for the specified port in the specified time
interval.
Right-click or CTRL-click (Mac) on the Stack chart, Pie chart, or Ports list, and
choose from the Context menu as follows:
Stack chart:
Pie chart:
Ports List:
- 329 -
Chapter 9: InterMapper Flows™
Use the VLAN List to view detailed statistics about a particular VLAN.
l Click a column heading to sort by that column. Click again to reverse the sort.
l Click an unselected row to select it.
l Shift-click an unselected row to select all rows between that row and the cur-
rently selected row.
l Control-click a row to select or de-select it.
l Right-click a line in the VLAN list, and choose from the context menu as
described below.
- 330 -
Top VLANs Tab
l Legend - The top 10 VLANs are indicated with color legends. The report
shows the top 25 VLANs, but places the "Other" category at the bottom of the
list, as it shows total traffic for the remaining VLANs not shown in the pre-
vious 24 rows.
l VLAN - Contains the number of the VLAN.
l Bytes - The volume of traffic (in bytes/kbytes/mbytes) for a particular row in
the specified time interval.
l % - The percentage of traffic attributed to this VLAN during the specified time
interval.
Right-click or CTRL-click (Mac) on the Stack chart, Pie chart, or Host list, and
choose from the Context menu as follows:
Stack chart:
l Select On VLAN [NN] - include only traffic from the selected host.
l Exclude VLAN [NN] - exclude traffic from the selected host.
l Center On This - centers the stack chart on the selected point in the
timeline.
Pie chart:
l Select On VLAN [NN] - include only traffic from the selected host.
l Exclude VLAN [NN] - exclude traffic from the selected host.
VLANs List:
l Filter on selected VLAN - include only traffic to or from the selected VLAN.
l Exclude selected VLAN - exclude traffic from the selected row.
l Select All - select all rows of the table.
l Copy selected rows - copy the fields from the selected table rows to the
clipboard.
- 331 -
Chapter 9: InterMapper Flows™
Use the Top Sessions tab to view detailed data about sessions with the greatest
amount of traffic.
- 332 -
Supported Exporters
Supported Exporters
NetFlow: InterMapper Flows handles NetFlow v1, v5, v7, and v9 exports from
routers and switches from Cisco and other NetFlow-compatible vendors as well as
a number of software exporters.
sFlow: InterMapper Flows handles sFlow versions 2, 4, and 5, including MIB Enter-
prise numbers 4300 and 14706 from equipment from HP, Extreme, Foundry, For-
ce10, and others.
sFlow provides information about the traffic through the network, including the
sender and recipient of the traffic flows and the protocols used.
To configure InterMapper Flows to receive the sFlow data, you must first enable
sFlow export on the router or switch. Most modern gear uses SNMP to enable/dis-
able sFlow export, as described in the sFlow specification.
InterMapper Flows lets you specify the exporter(s) that should send data.
1. Open the Flows Settings window, and click the Exporters tab.
2. Set the sFlow port (default is 6343) at the bottom of the window.
3. Click the Add sFlow exporter button. The Enter sFlow Information window
appears.
4. Enter the IP address of the exporter, the SNMP read/write community string,
choose the IP address for the collector, choose a sampling rate, and click OK.
InterMapper Flows configures the selected exporter (via SNMP) to send sFlow
records to the specified collector. The exporter appears in the Exporters list in
a few moments.
- 333 -
Chapter 9: InterMapper Flows™
l Click the Settings icon in the top-right corner of the Flows window:
l Use the Exporters (Pg 334) tab to choose which exporters you want to col-
lect from.
l Use the Appearance (Pg 337) tab to select a coloring theme for protocols
and hosts.
l Use the Preferences (Pg 338) tab to set parameters that control behavior
of InterMapper Flows.
l Use the Advanced (Pg 339) tab to set performance-related parameters, the
path to your database, and a database size.
l Use the Registration (Pg 341) tab to view information about your current
InterMapper Flows license, and to enter a new license key.
l Use the About (Pg 342) tab to view version information about InterMapper
Flows and its components.
Exporters tab
Use the Exporters tab to select the exporters from which you want to collect data.
- 334 -
InterMapper Flows Settings
To choose exporters:
Note: NetFlow exporters appear in the list automatically if they are properly
configured. The exporter must be configured to send data to InterMapper
Flows.
lTo add an sFlow exporter, click Add sFlow Exporter. The Enter sFlow
- 335 -
Chapter 9: InterMapper Flows™
Additional Columns:
Additional Boxes:
l NetFlow port - InterMapper Flows listens for NetFlow v1, v5, v7, and v9 on
this port. 2055 is the default port, but ports 9555 and 9995 are sometimes
used.
l Database remaining - each exporter has an estimated flow rate, updated
the last time it reported. The combined rate is used to calculate an estimated
database capacity.
l sFlow port - InterMapper Flows listens for sFlow on this port. The default
port is 6343. This must be different from the NetFlow port. Make sure that
this port is not firewalled from any of your exporters.
l Add sFlow Exporter button - click this button to add an sFlow exporter.
The Enter sFlow Information window appears.
- 336 -
InterMapper Flows Settings
Appearance tab
Use the Appearance tab to choose the coloring scheme used to color charts in the
Flows window.
Two different color scheme strategies are used for charts and graphs:
l By port or host - colors are fixed for each port or host. This means the color
for a port or host is the same in every chart in which that port or host
appears. Because of the limited number of colors, it is possible for two adja-
cent hosts in a chart to have the same color.
l By contrast - chart colors are assigned in the same order for each chart.
This provides greater contrast, but a single host or port might be colored dif-
ferently in each chart, or in the same chart at different times.
- 337 -
Chapter 9: InterMapper Flows™
Preferences Tab
Use the Preferences Tab to set local preferences for InterMapper Flows.
Local Preferences
- 338 -
InterMapper Flows Settings
Advanced tab
Performance settings
Notes:
- Larger values for the session cache will increase server startup/restart
times as records are loaded from disk.
- A cache larger than 1.5Gb requires a 64-bit processor.
- 339 -
Chapter 9: InterMapper Flows™
Note: If you change the database path, the existing database is not copied to
the new location, however, you can do this manually while the service is not
running. The old database is not deleted.
l Database size - available sizes as shown below (calculated from the current
flow rate):
- 340 -
InterMapper Flows Settings
Registration tab
- 341 -
Chapter 9: InterMapper Flows™
About tab
Use the About tab to view information about InterMapper Flows and the platform
on which it is running. Click Copy to Clipboard to copy detailed information about
the configuration of InterMapper Flows to the clipboard for pasting into another doc-
ument. This is useful when corresponding with technical support.
- 342 -
Using the Layer 2 View
Use the Layer 2 view of the Device List window to view information about your
switches and what's connected to them. With the Layer 2 view, you can answer
questions like:
InterMapper periodically scans all the switches on maps where Layer 2 is enabled
(see the Layer 2 Features pane (Pg 86) of the Map Settings window). It collects
information regarding which devices are attached to which ports, what other
switches are present, and places the resulting information into the Endpoints pane.
When Layer 2 passes the connection information back to the map, automatically
showing the connection of each device on the map to the proper port on the switch.
To use the Layer 2 connection information to make connections on the map auto-
matically, select Automatically change this map to show Layer 2 con-
nections in the Layer 2 Features pane of the Map Settings window.
1. From the Window menu, choose Device List. The Device List window
opens.
2. In the Device List window, click the Layer 2 view button, as shown at right.
The Layer 2 window appears.
- 343 -
Chapter 10: Using the Layer 2 View
l Right-click a device on a map and choose Show in Layer 2 from the context
menu.
l Select a device on a map and choose Show in Layer 2 from the Monitor
menu.
l The Endpoints pane (Pg 347) - the upper right pane lists all switch ports
and the devices connected to them. It contains only those ports and devices
that match the filter criteria in the Filter pane.
l The Filter pane (Pg 345) - the left pane provides criteria for showing or hid-
ing endpoints based on their presence on a particular switch, VLAN, or the end-
point's manufacturer. lists available switches, the VLANs in which they
appear, and manufacturers of network interface cards of the devices con-
nected to them. Use the check boxes to select or hide endpoints in the End-
points pane, and type additional criteria to help select the endpoints you want
to view.
l The Connections pane (Pg 348) - the lower right pane provides details
about switch-to-switch connections.
- 344 -
The Filter Pane
- 345 -
Chapter 10: Using the Layer 2 View
l The Filter box provides significant addtional filtering capability. Enter a host-
name or address in the Filter box to limit the devices shown in the Endpoints
pane. See Using the Filter Box (Pg 347) below for many more options.
l Certain flags appear next to entries. See Understanding Layer 2 Flags (Pg
350).
l A switch that appears in grey and in parentheses indicates that the switch was
previously detected, but is no longer on a Layer 2-enabled map.
The right column of the Filter pane shows the number of Endpoint devices (spe-
cifically, the number of distinct MAC addresses) for each of the filter criteria.
The number of endpoints indicated in the Filters panel often exceeds the number of
entries in the Endpoints pane. This discrepancy occurs because the Endpoints panel
often displays multiple entries for the same MAC address. Multiple entries appear
in the following cases:
When you select the Show All Ports box, the Endpoints pane also shows:
- 346 -
Understanding and Using the Endpoints Pane
Use the Filter box, located at the top of the Device Filter pane, to limit the devices
you see in the Endpoints pane.
l Enter a host name or address to view only devices connected to that domain
or address.
l From the Filter dropdown menu, select or clear Endpoints Only to include or
exclude entries for ports with switches, unknown devices, and devices iden-
tified as "fuzzy" (see Understanding Fuzzy Devices (Pg 352).)
l In the Map or List view, select a device, then choose in Layer 2 from the
Show submenu, available from the Monitor menu and the context menu, to
view that device's connections in the Layer 2 View.
l If the value is in double-quotes, list all endpoints where the value is part of
the NIC Manufacturer. (e.g. "App" will match "Apple", "Appliance", etc.)
l If the value is an IPv4 CIDR block, list all endpoints with IP addresses in that
CIDR block. (For example, enter "192.168.1.1/24")
l If the value is decimal digits separated by periods, or just digits, treat it as an
IPv4 address. There are three forms:
a. 192.168 matches any IP address that begins with 192.168
b. .1 matches any IP address that ends with .1
c. 10 matches any IP address that begins with 10. (no period necessary).
l If the value is hexadecimal and separated by dashes, treat it as a MAC
address. Search for endpoints with the MAC address or MAC address sub-
string. (e.g. "00-00-0c", "00-00-d7-00-10-ab")
l If the value starts with an alphabetical character, resolve the host name to an
IPv4 address and filter on that IP address.
l If the value starts with '#', process the specified debug command (e.g.
"#help")
The Layer 2 view's Endpoints pane lists all endpoint devices (servers, work-
stations, and routers) and the switch ports they are connected to. It does not
include managed switches, which are not considered to be endpoints.
l Flags - flags that give detailed information about the port or device. See
Layer 2 Flags (Pg 350) for more information.
l Switch and Port - describe a particular switch port
l MAC and Address - contain the MAC address and the IP Address of the
device.
l DNS - the DNS name of the device (if known).
l VLAN - the VLAN(s) supported by this port.
l NIC Manufacturer - the manufacturer of the Network Interface Card (NIC),
derived from the MAC address.
l First Seen - the time the device was first detecting during a Layer 2 scan.
l Last Seen - the most recent time the device was detected during a Layer 2
scan.
- 347 -
Chapter 10: Using the Layer 2 View
l Present - two numbers, separated by "/". The first is the number of times
this device was seen during a scan, the second is the total number of scans.
l ifAlias - the ifAlias taken from the Switch and Port (if available).
l In the Filter pane, click various combinations of Switch, VLAN, and NIC Man-
ufacture to control the rows that appear in the Endpoints pane.
l In the Endpoints pane, click a column heading to sort by that column. Click
again to reverse the sort.
l Click the sprocket at the right end of the Endpoints pane's column heading bar
to add to or remove columns from the Endpoints Pane.
l By default, the Endpoints pane shows endpoints only - it hides ports con-
nected to other switches, ports with no devices attached (regardless of
whether they are up or down) or devices marked as "fuzzy." Select the Show
All Ports box near the top of the Filter pane (Pg 345) to show all ports.
In addition to this tabular view, InterMapper can pass the connection information
back into the Map view, automatically showing the connection of each device on
the map to the proper port on the switch. This simplifies the creation and arrange-
ment of your maps; all you need to do is tidy up the map. Turn this feature on from
the Layer 2 Features pane of the Map Settings (Pg 94) window.
The Layer 2 Connections pane lists all switches, the switches they are connected
to, and the ports through which they are connected. This information is derived
from the switch's forwarding tables, as well as information available through Cisco
Delivery Protocol (CDP), Link Layer Delivery Protocol (LLDP), and Spanning Tree
Protocol (STP).
- 348 -
Understanding and Using the Connections Pane
l Switch and Port - each row shows two switches and two ports. These
switches are known to be connected by the specified ports.
l VLAN - The VLAN(s) that are present on the connection between the switches.
l CDP and LLDP - (Cisco Discovery Protocol and Link Layer Discovery Pro-
tocol)
A two-headed arrow indicates that both switches hear the other’s pro-
tocol advertisements.
A single-headed arrow points to the switch that receives the protocol
advertisements from the other.
Note: Some CDP/LLDP-aware switches may turn off advertisements on cer-
tain ports. This affects the arrows.
l Click a column heading to sort by that column. Click again to reverse the sort.
l Click the sprocket icon at the right end of the column heading bar to choose
the columns that appear in the list.
- 349 -
Chapter 10: Using the Layer 2 View
The meanings of flags in the Layer 2 view depend the pane in which they appear.
or
Duplicate MAC address detected - The Layer 2 process has found the
same MAC address on two separate switch ports.
IP conflict - The Layer 2 process has found the same IP address on two sep-
arate switch ports.
Spanning tree root - This switch is the root of the spanning tree.
Loop - a port is connected to another port on the same switch.
Wireless (assigned manually) - a port or VLAN has been tagged as Wireless.
The Wireless flag appears next to the port in the Filters and Endpoints panes.
See Manual Tagging (Pg 352) below.
Virtual machine (assigned manually) - All NICs from this manufacturer with
this OUI (organizationally unique identifier) are virtual machines. The Virtual
Machine flag appears next to the OUI and any endpoints that use NICs with
that OUI. See Manual Tagging (Pg 352) below.
- 350 -
Understanding Layer 2 Flags
The following flags may be present in the Flags column of the Connections pane.
STP column: In the STP column of the Connections Pane, arrows indicate the dir-
ection of travel of STP bridge information.
Right switch is the left switch’s path to root for one or more of the left
switch’s spanning trees. (Right switch's port may be in blocking state, if there
are loops.)
Left switch is the right switch’s path to root for one or more of the right
switches’ spanning trees. (Left switch's port may be in blocking state, if there
are loops.)
Right switch is left switch's path to root for one or more spanning trees and
left switch is right switch's path to root for other spanning trees. (Either
switch's port may be in blocking state for one or more spanning trees, if there
are loops.)
- 351 -
Chapter 10: Using the Layer 2 View
A device with a MAC address whose location in the Layer 2 topology cannot be com-
pletely determined is considered a “fuzzy” device by InterMapper.
Fuzzy devices are quite common, and can occur for a number of reasons. The
Layer 2 engine attempts to collect information from all the switches nearly sim-
ultaneously. However, some time can elapse between the times that two switches
finishes collecting Layer 2 information. During this time period, a MAC address col-
lected from one switch may "age out" of another switch. Alternatively, a device
may connect to the network during Layer 2 collection, so its MAC address is repor-
ted in one switch's forwarding tables, but not in the edge switch (due to the dif-
ference in scan times for the two switches).
Devices may be classified as fuzzy due to bugs in certain switch models. For
example, Help/Systems has a small managed desktop switch that doesn't report
its complete forwarding table via SNMP. The extra un-reported devices appear as
fuzzy, because the upstream switch reports the MAC address, but the downstream
switch never reports them (even though the switch is otherwise perfectly func-
tional.)
Fuzzy devices are distinct from Interior devices. A fuzzy device appears to be in
the middle of the network (between two switches) because InterMapper doesn't
have complete information. An interior device appears to be in the middle of the
network because there is actually another switch or hub located there, but it's not
part of the Layer 2 information.
Manual Tagging
For certain kinds of connections, you may want to tag a port or endpoint device so
you can see easily what kind of device it is.
- 352 -
Mapping With Layer 2
For maps with a relatively small number of devices, you can convert the map dir-
ectly so that it uses Layer 2 features to configure the map. You can also create a
new map and use Layer 2 information to add the switches and devices.
- 353 -
InterMapper Reports
InterMapper Reports
Overview
Use the InterMapper Reports server to create, view, print and save reports that
use data collected from InterMapper servers.
Note: Before you can use it, you must start the InterMapper Reports Server. This
allows InterMapper to send data to the Reports Server where it is collected in a
database.
1. From the Server Settings window, choose Reports Server. The Reports
Server pane appears.
2. From the Reports Server pane, click Start. The Configure button becomes act-
ive.
l From any InterMapper map, right-click a device and choose Reports... from
the Show in submenu. A browser page launches and the InterMapper Reports
window appears.
- 354 -
Chapter 11: InterMapper Reports
Creating A Report
Use the Reports Server web UI to create, save, load, link, or print a report.
You can open the InterMapper Reports window from an InterMapper map.
Two other ways you can also open the Reports window:
l From the Server Settings window, view the Reports Server pane, and click
Configure, log in to the InterMapper DataCenter, and click View Reports in
the InterMapper Reports box.
- 355 -
Creating A Report
l From the Map Window - open the Reports window after selecting one or
more devices or interfaces.
l From a template - a number of pre-configured templates are available.
l From scratch - using an empty template. Select your own devices or inter-
faces, the data you want to show from each, any calculations you want to
apply, a report period and interval, and the way in which the data is shown.
- 356 -
Chapter 11: InterMapper Reports
Report types
Graph - Can be used with datasets that contain only numeric data.
Three display options are available in a Graph report:
l Area - a line chart with the area below the line filled.
l Line - a line chart with a dot at each data point.
l Bar - a bar chart.
Table - a tabular report, containing columns and rows.
Editing a Report
The image below shows the controls you can use to fine-tune your report defin-
ition.
Once in Edit mode, you need to answer some or all of these questions (in the areas
shown above), depending on your requirements for this report:
l Which devices? Select the devices you want to include in the report. Select
from the available Servers, Maps and Devices. If network interface data
available for any of the selected devices, select one or more Interfaces.
l Which data? Choose from available Datasets. A number of datasets, includ-
ing Details and Event History, are standard for all devices, other datasets are
based on data available from your device selection.
l Calculations? If you have selected a Dataset other than Details and Event
History, such as Response Time, you can choose from some basic calculation
options. Choose Min, Avg, or Max to specify how the results are displayed.
- 357 -
Creating A Report
l Report Type? Choose how the dataset results are displayed. By default, a
Tabular report (list) is shown. When the selected dataset contains numeric val-
ues, you can also choose Area, Line or Bar chart. For Event History and
Details, only a tabular view is available.
You can save any number of reports, then open, view or print them at a later time.
For more information, see Managing and Printing Your Reports (Pg 370).
- 358 -
Chapter 11: InterMapper Reports
Use the data source selection bar to select the devices or interfaces for your
report.
l Click anywhere in the source selection bar shown above. A selection tree
appears, as shown below.
l Select or clear the check boxes for the devices or interfaces whose source
data you want to include in the report.
l Select the Show deleted devices & interfaces check box to include
devices or interfaces that have been deleted.
l Click the Select All or Unselect All to select or unselect all devices or inter-
faces in a column.
l When finished selecting, click the source selection bar. The selection tree dis-
appears, and the selected data appears.
Note: If you select a large amount of data over a large time range, it may
take a few moments or longer for the data to appear. This depends on a num-
ber of variables - the speed of reports server CPU, the amount of data, the
time units selected.
- 359 -
Selecting Source Data
Selecting a Dataset
To create graphs, you need to select a dataset that contains numeric values. The
datasets available depend on which devices are selected, the probes used to mon-
itor those devices, what datasets are recorded through those probes, and whether
those datasets are being exported to the Reports Server database.
A dataset is available when retention policy for the selected device is not set to
None and one of the following is true:
l For devices, response time or short-term packet loss are always stored.
l For interfaces, incoming or outgoing bytes/second are always stored.
l If the dataset is specified in the probe to be 'autorecord' .
l If a chart was created from the dataset by clicking it in the Status window or
dragging it from the Status window to an existing chart.
To select a dataset:
Grouping by time
In most cases, the selected time scale causes each data point to represent a group
of raw samples. Use the data grouping buttons to specify how you want the group
of samples represented by a graph data point to be displayed.
l Click Min to display the minimum value from the group of samples during a
data point's time period.
l Click Avg to take the average value from the group of samples during a data
point's time period.
l Click Max to display the maximum value from the group of samples during a
data point's time period.
- 360 -
Chapter 11: InterMapper Reports
When multiple devices or interfaces are selected, each device or interface's data-
set appears as a line or bar on the graph. The Group check box allows you to group
the datasets from multiple devices or interfaces into a single dataset that shows
the minimum, average or maximum value for all devices in the group over the
selected time period.
l Click the left and right arrow buttons to move to the start or end of the report
or to move to the previous or next page.
l Type in a page number to move to that page.
l Use the dropdown selector to specify the number of results are shown on a
page.
You can limit the amount of data from the dataset that is displayed in the report. In
selecting a data range, you select data over a time range, and control the density
of that data over the specified range. You do this using the Show Data From con-
trols at the bottom of the window. Select a range of data by date, and specify the
units to use (hours, days, weeks, months, etc.). Learn more about data range
selection options in Data Range Options, below.
- 361 -
Selecting Source Data
Previous
...to Date
Specific date
- 362 -
Chapter 11: InterMapper Reports
Date Range
- 363 -
Creating and Using Data Filters
To create a filter:
Filter Options
The available values for comparison operators depend on the type of data field
selected.
Comparison operators
(non-numeric fields)
Comparison operators
(numeric fields)
- 364 -
Chapter 11: InterMapper Reports
Multi-part Filters
You can create filters with more than one set of filter criteria.
- 365 -
Choosing a Report Style
l Click one of the report style tabs in the lower right of the window to choose a
report style.
Note: Area, Line, and Bar styles are available only for datasets with numeric val-
ues.
In Area, Line and Bar styles, mouse over a data point to see its
value.
Table Report
- 366 -
Chapter 11: InterMapper Reports
- 367 -
Choosing a Report Style
Area Report
Line Report
- 368 -
Chapter 11: InterMapper Reports
Column Report
- 369 -
Managing and Printing Your Reports
l Click the Edit button. The Edit controls appear as shown below. Click again to
switch back to View mode.
You can save any number of reports, then open, view or print them at a later time.
1. From the Report window's File menu, choose Open. A list of saved reports
appears, as shown below. Each report shows a summary of selected para-
meters.
2. Click the report you want to load, then click Load Report. To create a new
report instead, click Report Templates to view available templates.
- 370 -
Chapter 11: InterMapper Reports
You can delete a saved report from the Saved Reports list.
1. From the Report window's File menu, choose Open. A list of saved reports
appears, as shown above.
2. Click the report you want to delete, then click Delete. A Confirm window
appears.
3. Click OK. The selected report is removed from the list.
- 371 -
Switching to Edit Mode
Use the Report window's Export menu to obtain a URL for dis-
tribution, or to export the report data in a CSV file.
1. After viewing the report, choose Link URL from the Report window's Export
menu. The Link URL box appears as shown.
2. Copy the URL and paste it into an email, document, or other container you
want to use to distribute it.
3. Click Cancel to close the Link URL box.
4. To protect the URL from being changed, select Lock against changes.
1. After viewing the report, choose CSV File from the Report window's Export
menu. The result depends on your browser, but a file save action is initiated.
2. Choose a location for the file, and click Save (again, the actual name depends
on your browser.) A CSV file is saved to the specified location.
- 372 -
Chapter 12
Note to Windows users: By default, XP, Vista, and Windows 7 have significant
firewalling turned on. You need to create exceptions ("poke holes") in the firewall
in order to use the remote server, web server, telnet server, or DataCenter server
as well as to monitor SNMP traps. For detailed information, see Using InterMapper
with Windows XP SP2 and Vista in the InterMapper Knowledgebase.
- 373 -
Chapter 12: Command and Menu Reference
- 374 -
File Menu
File Menu
Use the File menu to create new maps, open existing maps, and to save maps that
you have edited. You can also import and export maps, and can set up and print
maps. The table below shows the commands available from the File menu, and
which commands are available from the Map or Map List window.
Note: Use shortcuts with Control key (Windows) or Command key (Macintosh.)
Command Description
New Map (Pg 377) Creates a new map.
Open Recent (submenu) Choose a recently-opened map from this submenu.
(Pg 377)
Close (Pg 377) Closes the current window.
Backup... (Pg 377) Backs up the current map.
Restore... (Pg 378) Restores the current map from a backup.
Rename... (Pg 378) Renames the selected map.
Duplicate... (Pg 378) Makes a copy of the selected map.
Disable... (Pg 378) If you have administrator privileges, use this com-
mand to disable the current map (Map Window) or
the selected map (Map List window.)
Import (submenu) (Pg Choose from these submenu commands:
378)
l Map... - Copies a map file saved on the Inter-
Mapper RemoteAccess machine to the Inter-
Mapper server and makes it available. (Use the
Export... command to save the file on the Inter-
Mapper RemoteAccess machine.)
l Data File... - Creates maps or updates devices
from a tab-delimited import file. For more
information, see Importing Data Into Maps (Pg
637).
l Probe... - Imports custom probe files to your
server.
l MIB... - Imports an SNMP MIB file for a specific
device or family of devices.
Export (submenu) (Pg Choose from these submenu commands:
379)
l Map... - Save a copy of a server's map to the
InterMapper RemoteAccess machine.
l Data File... - Save a file containing selected
data from a map in Tab-delimited, CSV, HTML,
or XML format.
l Image... - Save a PNG image of the selected
map.
- 375 -
Chapter 12: Command and Menu Reference
- 376 -
File Menu
New Map
Creates a new empty map. See the Autodiscovery (Pg 406) menu command for
details about creating a map automatically.
Close
Note: Closing a map window does not stop the map's devices from being polled or
from sending notifications. To prevent a map from being polled, disable the map in
the Enabled Maps section of the Server Settings window (Pg 277).
Backup...
Makes a snapshot
backup of the cur-
rent map.
Backup Types
- 377 -
Chapter 12: Command and Menu Reference
Restore...
See Backup...
(above) for inform-
ation on backup
types.
Rename...
Duplicate...
Disable...
If you have administrator privileges, use this command to disable the current map
(Map Window) or the selected map (Map List window.) A confirmation dialog
appears.
Import (submenu)
Use the Import submenu to choose from the available Import commands:
Data File...
Use the Import > Map... command to import a map from a tab-delimited,
comma-delimited, or XML file. For more information, see Importing Data Into
Maps (Pg 637).
InterMapper Map...
Copies a map file saved on the InterMapper RemoteAccess machine to the Inter-
Mapper server and makes it available. (Use the Export... command to save the file
on the InterMapper RemoteAccess machine.)
- 378 -
File Menu
Probes...
Imports custom probe files to your server. For more information, see the Inter-
Mapper Developer Guide.
MIB...
Imports an SNMP MIB file for a specific device or family of devices. You can use
the MIB file information to enhance the formatting of the displayed data. For
example, certain views (especially in log files and the SNMP Table views) use the
MIB data to display numeric values as the human-readable strings.
Export Map...
Use the Export Map... command to save a copy of your map on your local machine
or network drive. This is an easy way to copy a map from one server to another.
After you export the map file, you can then import it to a different server. You can
also export a tab-delimited file for use in a spreadsheet or database.
For more information, see Exporting Data From Maps (Pg 635).
Server (submenu)
Log In...
In the Map List window, click the
server you want to log into, then
choose Log In...from the File
menu. An authentication window
appears:
Enter a Name and Password. If
you want to save the Name and
Password, click to select Save
Name and Password.
Note: SASL authentication is used
for logins.
Log Out
In the Map List window, click a map on the server you want to log out from, then
choose Log Out. You are disconnected from the selected server.
Note: Open windows for any maps on the selected server remain open after you
log out, but the maps are dimmed to indicate that they are no longer active.
Page Setup...
Opens a standard Page Setup dialog.
Print...
Prints the current window on the currently selected printer. This operation uses as
many pages as necessary to print the entire map or window contents.
Exit/Quit
Exits the application.
- 379 -
Chapter 12: Command and Menu Reference
Edit Menu
The Edit menu contains standard editing commands, as well as various commands
for selecting and finding items.
Redo (Pg 381) (Map Window only) Available after you execute the
Undo command. Restores the state of the map
before the Undo command was executed.
Revert... (Pg 381) (Map Window only) Restores the state of the map as
it was when you last opened it for editing.
Paste (Pg 381) Paste the contents of the clipboard to the current win-
dow.
Delete (Pg 381) Removes the selected items from the map.
Caution: This operation cannot be undone.
Select All (Pg 382) (Map List Window only) Select all maps and servers.
Find (submenu) (Pg l Find (Pg 382) - Opens the Find window. Enter a
382) text string to search for.
l Find Next (Pg 382) - Search for the next occur-
rence of the last defined text string.
l Find Device... (Pg 382) - Search for a device
in a map on a connected server.
- 380 -
Edit Menu
Undo
Redo
Re-performs the previous undo operation. Any operation that has been undone can
be redone.
Note: The Undo/Redo function is sequential; if you undo multiple operations, then
perform a different operation, all the operations you undid are gone.
Revert
Restores the state of the current map to its last state when it was last enabled for
editing.
Cut
Copy
Paste
Delete
Select (submenu)
- 381 -
Chapter 12: Command and Menu Reference
Select All
Find...
Find Next
Finds the next item in the current map that matches the previously specified text
string.
Find Device...
Map Settings...
Use the Map Settings... command to view and edit an individual map's color set-
tings, specify a background image, and view and edit the list of default notifiers for
the map. See Map Settings (Pg 86) for more information. This command is avail-
able only in Edit mode.
- 382 -
Edit Menu
Server Settings...
Use the Server Settings command to open the Server Settings window. Use the
Server Settings window to view server information, and to view and edit all server
preferences and settings. You can control the settings of the built-in Web, Inter-
Mapper RemoteAccess, and Telnet servers. See Server Settings (Pg 249) for more
information.
Preferences...
Use the Preferences... command to open the Preferences window to set pref-
erences for the InterMapper client application or for InterMapper RemoteAccess.
These settings affect only the copy of the application you are running.
- 383 -
Chapter 12: Command and Menu Reference
View Menu
Use the View menu in the Map window to specify how you want to look at a map.
The view menu is available only from the map window.
Note: You can also sort the list by clicking a column head-
ing. Click again to reverse the sort.
Columns (sub- Choose the columns you want to show in any list view.
menu) (Pg 385)
Filter (submenu) Choose to view only those objects with the selected state.
(Pg 385)
Expand All (Pg In List view, expands all hierarchical items in the Map and
386) Device List windows.
Collapse All (Pg In List view, collapses all hierarchical items in the Map and
386) Device List windows.
Show/Hide Tool- (Map List Window only)
bar (Pg 386) Choose to show or hide the toolbar.
Edit Map (Pg Toggles between Map Edit mode and Monitor mode.
386)
Map
View as a map, with graphic objects representing devices, networks and links.
List
- 384 -
View Menu
Device Notifiers
View as a list of devices, each showing the states for which the selected notifier
sends notifications.
Link Notifiers
View as a list of interfaces, each showing the states for which the selected notifier
sends notifications.
Charts
Datasets
Select from a list of devices to view a list of datasets available for those devices.
Actual Size
Zoom In
Zoom Out
Sort (submenu)
From the Sort submenu, choose a column by which you want to sort the list.
Choose it again to reverse the sort order. Not available in Map view.
Note: You can also click the column heading to sort by that column, and click it
again to reverse the sort order.
Columns
From the Columns submenu, select or clear the check mark for a column to show
or hide the column. Not available in Map view.
Filter (submenu)
Choose to view only those objects with the selected state. Filter devices with the
selected state to view only those that are acknowledged or unacknowledged.
- 385 -
Chapter 12: Command and Menu Reference
Expand All
Expands all hierarchical items in the Map List or Device List window.
Collapse All
Collapses all hierarchical items in the Map List or Device List window.
Show/Hide Toolbar
Edit Map
Select this menu item, click the lock icon at the upper left of the map, or press the
Tab key.
Toggles the map between Editing mode (where the map may be rearranged,
edited, and changed) and Monitoring mode (where the map is uneditable, but dis-
plays the current state of the network.) The menu item has a check mark when
map editing is enabled.
- 386 -
Monitor Menu
Monitor Menu
Use the Monitor menu to re-probe one or more devices on a map, to edit inform-
ation about one or more devices, and to open various windows related to map
items. The Monitor menu is available only from a Map window.
Info Window (Pg 390) Open the Info Window for the selected device or net-
work.
Status Window (Pg Opens the Status window for the selected device,
391) network, or link.
Interfaces > Win- Opens the Interfaces window for the selected
dow... (Pg 392) device.
Interfaces > Error Opens the Error Thresholds dialog. Set error
Thresholds... (Pg 392) thresholds for one or more interfaces.
Interfaces > Discard Opens the Discard Thresholds dialog. Set packet dis-
Thresholds... (Pg 393) card thresholds for an interface.
Notifiers Window (Pg Opens the Notifiers window, and shows a list of noti-
394) fiers for the selected device.
Flows Window (Pg Opens the Flows Window if you have installed the
397) InterMapper Flows add-on.
Show in Layer 2 (Pg Opens the Device List window in Layer 2 view, and
- 387 -
Chapter 12: Command and Menu Reference
Set Info > Set Set the IP address or name for the selected device.
Address... (Pg 397)
Set Info > Set Com- Enter a comment about the selected device(s).
ment... (Pg 399)
Set Info > Set Com- Set the SNMP community string for the selected
munity... (Pg 399) devices.
Set Info > Set Data Select a Data Retention policy to use when storing
Retention... (Pg 399) data to the InterMapper Database.
Set Info > Set Double- Define the action to be taken when you double-click
click (submenu) (Pg the selected device.
403)
Set Info > Set Kind... Set the device kind you want to use when storing
(Pg 400) data to the InterMapper Database.
Set Info > Set Lat- Set the latitude and longitude for the selected
itude & Longitude... devices.
(Pg 400)
Set Poll Interval... Set the poll interval for the selected devices.
(Pg 400)
Set Info > Set Set the probe to be used with the selected devices.
Probe... (Pg 401)
Set Info > Set Set the criteria for sending notifications that a
Thresholds... (Pg 402) device is down, in alarm, or in warning. These set-
tings apply to all devices on the map.
Set Info > Set Vant- Set the selected device as the vantage point from
age Point (Pg 402) which InterMapper views all other devices on the
map.
- 388 -
Monitor Menu
Reprobe/Reprobe Selection
Re-poll the selected device(s). This is useful for retrieving the status of a device or
detecting that it has returned to service.
Acknowledge
When Inter-
Mapper
detects a
problem
with a
device, the
device's
icon
changes to
yellow,
orange, or
red. This
serves to The Acknowledge Message Window. Data typed here is entered into
attract atten- the InterMapper log file, as well as appearing in the device's
tion to the Information window.
failure, but
can be dis-
tracting after corrective action has been initiated. It also masks further failures: if
several items on a map are already in alarm, it's hard to notice new problems.
Note: Another feature - dependencies - is useful for controlling the number of noti-
fications you receive when there are failures of central equipment. See Using Noti-
fication Dependencies (Pg 136) for more information.
- 389 -
Chapter 12: Command and Menu Reference
Un-Acknowledge
Use this command to restore the flashing icon for a device that has been acknow-
ledged in error, or which needs further attention. Un-acknowledging a device react-
ivates recurring notifications.
Info Window
Use the Info window (Pg 185) command to view information about the selected
device or network.
- 390 -
Monitor Menu
Status Window
Open the Status window (Pg 185) for the selected device. This command is active
in Map Edit mode, which is useful for creating charts.
The example below shows a Device Status window. Status windows are also avail-
able for networks and links. For examples, see Status windows (Pg 185).
Status window
- 391 -
Chapter 12: Command and Menu Reference
Interfaces Window
Open the Interfaces window (Pg 195) for the selected device.
Info View
Use the Info view of the Interfaces window to view the status of interfaces for the
selected device, to hide or show them, to specify mapping behavior, and to choose
what thresholds to ignore. You can also access the Interfaces submenu for one or
more interfaces.
Statistics View
Use the Statistics view of the Interfaces window to see various statistics for all
interfaces on a device.
Use the Error Thresholds window to override map defaults and set thresholds for
link errors on the selected devices. For more information, see Setting Thresholds
(Pg 208).
- 392 -
Monitor Menu
Use the Utilization Thresholds window to override map defaults and set thresholds
for link utilization on the selected devices. For more information, see Setting
Thresholds (Pg 208).
Use the Discard Thresholds window to override map defaults and set thresholds for
discarded packets on the selected devices. For more information, see Setting
Thresholds (Pg 208).
- 393 -
Chapter 12: Command and Menu Reference
Behavior Window
Use the Behavior window to set the display and polling behavior of the selected
devices. This window is also available from the context menu; the options are also
available from the Interfaces window (Pg 392).
Notifiers Window
- 394 -
Monitor Menu
Notifiers window
- 395 -
Chapter 12: Command and Menu Reference
SNMPWalk
- 396 -
Monitor Menu
Flows Window
If you have installed the InterMapper Flows add-on, opens the Flows Window,
which shows InterMapper Flows information. For documentation about Inter-
Mapper Flows, please see InterMapper Flows (Pg 315).
Show in Layer 2
Use the Show in Layer 2 command to open the Device List window in Layer 2 view,
and view the connections to the selected devices.
Reports...
Use the Reports command to open the Reports UI in a browser window. Use the
Reports window to create, load, edit, and save reports.
Set Address...
- 397 -
Chapter 12: Command and Menu Reference
- 398 -
Monitor Menu
Set Comment...
The com-
ment is
seen in the
device's
status win-
dow. Sets
the com-
ment for all
the selec-
ted
devices.
(See the
Device Status window for details on the comment field.)
This information is saved as part of the map. Use the Comment field to save the
model and serial number for a device, telephone numbers, circuit numbers, or
other information related to the item.
Set Community...
- 399 -
Chapter 12: Command and Menu Reference
Set Kind
- 400 -
Monitor Menu
Set Probe...
Sets the probe used to query the selected device and the probe's parameters, if
applicable. See Probe Reference (Pg 439) for details on the available InterMapper
probes. See Custom Probes for information on creating your own InterMapper
probes.
- 401 -
Chapter 12: Command and Menu Reference
Set Thresholds
Set the criteria for sending a notification that a device is down, in an alarm state,
or in a warning state. These settings apply to all the devices on the map.
l Down: This is the most serious condition. It means the device is no longer
responding to probes. Specify the number of packets that may be lost before
declaring the device down.
l Critical: This is the most serious condition in which responses are still being
received.Specify the number of interface errors (per minute) allowed before
marking the device as critical.
l Alarm: This is next most serious condition. Specify the number of interface
errors (per minute) allowed before marking the device in alarm.
l Warning: The least serious error state. Specify the number of interface
errors (per minute) allowed before showing the device in warning.
Set the selected device as the Vantage Point from which Inter-
Mapper views all other devices on the map. If a device (such as
a router or switch) between the Vantage Point and other devices
fails, notifications are sent only for the failed device. The other
devices are in the "shadow" of the failed device, and appear
dimmed on the map.
A Vant
The Vantage Point specifies InterMapper's virtual point of pres-
ence - as if the InterMapper server were directly connected to
that item. When the Vantage Point is set on a device, a star appears next to the
icon, as shown.
- 402 -
Monitor Menu
InterMapper counts the number of dropped packets out of the last 100. This applies
to all packets sent to the device (networks and links are not involved).
The Short-term packet loss is displayed in the device's Status Window as a per-
centage of the number of dropped packets in the last 100. Use this command to
reset the current value to zero.
Helper Apps
Select a device, then choose from this submenu to launch a helper application, or
choose customize to configure your helper applications.
Set Double-click
Select one or more map items, then choose from this submenu to specify what
action is taken when any of the items is double-clicked. Use double-click actions to
launch an Helper Application, URL, or Menu item.
For more information on Double-Click actions, see Using Double-Click Actions (Pg
83).
- 403 -
Chapter 12: Command and Menu Reference
Insert Menu
Use the Insert menu to insert devices, networks, links, and blocks of text to your
map, and to initiate the Auto-discovery and network-scanning processes.
The Insert menu is available only in the Map window, and is active only when the
Map Editor is on.
Empty Probe Group... Insert one or more empty probe groups in the
(Pg 409) map.
Text... (Pg 409) Adds an object to the map containing the spe-
cified text.
Map Benchmark (Pg Insert a benchmark to define the latitude and lon-
410) gitude of a point on the map.
Group (Pg 410) Group two or more selected devices into a probe
group. Devices must have the same IP address.
Un-Group (Pg 410) Remove all probes from the selected probe
group, and create a single device for each probe.
- 404 -
Insert Menu
Device...
To add a device:
You can also choose from a list of probes for web servers, mail servers, or
any of the other probes shown in the dropdown menu. See Probe Reference
(Pg 438) for a complete list of the built-in probes.
Network...
Add a network
(oval) to the
map. This is
useful when
InterMapper
does not auto-
matically
detect the net-
work because
no SNMP- Add Network... window. Enter an IP address range.
speaking
- 405 -
Chapter 12: Command and Menu Reference
The window shown appears. Enter the IPaddress. (For a discussion of how IP net-
work information is represented, along with a discussion of the "/24" etc notation,
see Subnet Mask FAQ. (Pg 727) )
After you click OK, you will see a new network oval on the map representing that
subnet. You can connect devices to this network by dragging their links as
described in Adding and Removing Links (Pg 69).
Link
Use the Link command to add a link manually where none exists. This can be use-
ful when a link is not added during the auto-discovery process, or when you want
to use links to specify that certain devices are dependent upon other devices. For
more information on dependencies, see Using Notification Dependencies (Pg 136).
1. Select two devices or networks. (The menu command is available only when
two items are selected.) You can use Shift-click, Control-click, or you can
click and drag to draw a box around the items you want to select.
2. From the Insert menu, choose Link. A link appears between the selected
items. The link is permanently attached, and remains connected when you
move the items.
- 406 -
Insert Menu
Auto-Discover...
InterMapper uses a starting address and then scans for additional devices. By
default, InterMapper starts with its router's address or its own IP address (Pg
726). You may, however, enter a different address or DNS name (Pg 730) or WINS
name (Pg 735) (preceded by "\\") as a starting point. If InterMapper finds SNMP-
speaking routers with connections on other networks, it searches those networks,
hop-by-hop, finding more devices (and possibly more routers) until the specified
hop limit is reached.
The Autodiscovery window shown above allows you to specify the starting
address as well as specifying other options for the autodiscovery process.
Enter a starting host name, IP address, or IP subnet - Enter the name or
address of a device that InterMapper should use to begin the autodiscovery pro-
cess.
Specify a SNMP Community - Enter an additional SNMP Read-only com-
munity string to be used to interrogate all devices. (InterMapper always
attempts to read SNMP information using the default 'public' community string.
For more information, see SNMP Frequently-asked Questions (Pg 731).)
Stay within __ hops of starting device - Stops autodiscovery after Inter-
Mapper has searched the specified number of hops from the starting device.
Scan for devices on all networks - See Scan Network... (Pg 407)below.
Edit Filters... - Click this button to open the Network Scanning window. See
Scan Network... (Pg 407) below.
Automatically Layout - Select this box to have the map laid out automatically
(using the Organic layout.)
- 407 -
Chapter 12: Command and Menu Reference
Scan Networks...
The auto-discovery
process also allows
you to select which
kinds of devices are
to be added to the
map. InterMapper
applies a set of filters
to the discovered
devices. Only those
that match the
checked filters will be
added to the map.
- 408 -
Insert Menu
Text...
To add a text
object to a
map:
Add Text window. Enter text in the text box.
1. From the Use the text formatting controls to format the text.
Insert
menu,
choose Text.... The Add Text window appears.
2. Enter the text you want to add to your map.
3. Use the formatting controls to format the text.
4. Click OK. A text object appears on the map.
5. Drag the text object to move it to the desired location.
Icon...
Use the Icon command to add an icon to a map. An icon inserted using this method
is not associated with any device or network; it is simply a graphic element added
to the map.
1. With the map editable, choose Icon... from the Insert menu. The Select an
Icon window appears.
2. Choose an icon, and click OK. The icon appears in the map.
- 409 -
Chapter 12: Command and Menu Reference
Map Benchmark
Use the Map Benchmark command to define the latitude and longitude of a point
on a map. This is useful if you are placing devices on the map using geographic
coordinates. Each device is located on the map in relation to the map's bench-
marks.
Group
Use the Group command to create a probe group, a single device containing mul-
tiple probes. In order for the command to work, all selected devices must use the
same IP address.
1. Select the devices you want to group. All selected devices must have the
same IP address.
2. From the Insert menu, choose Group. The selected devices are "collapsed"
into a single device, containing a probe for each selected device.
Note: A probe group counts as one device against your device count.
Un-Group
Use the Un-Group command to "explode" a probe group into individual devices.
Note: Each device counts as one device against your device count.
- 410 -
Format Menu
Format Menu
The Format menu contains commands that affect the appearance of individual
items in the map. Items can be either devices (routers, servers, hosts, etc.) or net-
works (drawn as ovals, by default.)
Label... (Pg 414) Modifies the label of one or more items from the
map. Devices and networks have text labels that
identify the item. These labels may be generated
automatically from information gathered from the
device, or contain static text that you enter.
Rotate... (Pg 419) Rotate the positions of the selected objects in rela-
tion to each other.
Scale... (Pg 420) Scale the positions of the selected items in rela-
tion to each other.
Arrange (submenu) (Pg Rearrange the selected items into a cycle, bus, or
420) star.
Context menu (Pg 423) Set the Font, Size, and Style of the selected
devices from the context menu
- 411 -
Chapter 12: Command and Menu Reference
Icon
- 412 -
Format Menu
Built-in Shapes
Note: Except for the Wire icon, all Built-in Shapes stretch to enclose the specified
label text.
- 413 -
Chapter 12: Command and Menu Reference
Label
Each item in your map has a label. Use the Label... command from the Format
menu to edit labels for the selected items.
Default Labels
The example below shows the window for editing an item's label.
In the top pane, place your cursor where you want to place the variable.
In the Lower-left pane, double-click variable you want to insert. The variable
appears in the top pane, enclosed in <...>.
Tip: To move text or a variable to a new line, place the cursor where you want the
new line to start and press Enter.
- 414 -
Format Menu
- 415 -
Chapter 12: Command and Menu Reference
Label Variables
Use label variables to help you see the item information you consider most import-
ant.
Device Variables
TCP Port The TCP port number that is being monitored, if the device
is using a TCP-based probe type.
- 416 -
Format Menu
Network Variables
- 417 -
Chapter 12: Command and Menu Reference
Label Position
Note: The label position affects only Wire and Icon shapes.
- 418 -
Format Menu
Align
Align the selected items relative to each other. The Align ... buttons work like
other drawing programs.
Distribute:
Rotate
- 419 -
Chapter 12: Command and Menu Reference
Scale
Arrange (submenu)
If no objects are selected, Organic and Tree commands work on all objects on a
map. For Star and Bus, you must select at least one object. For Cycle, you must
select at least two object. All commands will work on two or more objects.
Organic
- 420 -
Format Menu
Tree
Arrange items in a tree structure. Choose which direction the branches of the tree
should go.
Tree - up
Tree - down
- 421 -
Chapter 12: Command and Menu Reference
Cycle
Bus
- 422 -
Format Menu
Star
Grid
You can change the attributes for each label in your map.
l Choose from Font, Size or Style from the context menu to change the label's
font, font size, and font style.
- 423 -
Chapter 12: Command and Menu Reference
Note: The Font, Size, and Style attributes affect all labels in the selected objects.
The Color attribute affects the text color only when the shape is set to Text. These
functions are also available from the Edit Device Label... dialog.
- 424 -
Window Menu
Window Menu
The Window menu lists all open maps at the bottom of the menu. You can also
change certain aspects of window appearance, and can access other InterMapper
windows.
Map List (Pg 428) Open the Map List window, or bring
it to the front.
- 425 -
Chapter 12: Command and Menu Reference
Minimize
Zoom
Choose the Zoom command to expand the frontmost window to the largest size
necessary to show all devices, or to the maximum size of its current screen, if all
items cannot be shown at the same time.
Send to Back
Use the Send to Back command to send the front-most window to the back.
Floating windows associated with that window, such as Status windows, are hid-
den.
Slideshow...
Use the Slideshow... command to rotate the open map windows at a specified
rate.
l From the Window menu, choose Slideshow..., and choose the amount of
time each map should be shown.
l Choose Slideshow again to stop the slide show.
- 426 -
Window Menu
Logs
Use the Logs selection from the Window menu to choose from a submenu of log
files. You can view a history of events, outages, connections to the web and
remote servers, or custom logs you set up yourself.
Each time a device changes state, an entry is made in an event log window. In addi-
tion, InterMapper logs messages for the following events:
For more information, see the Overview of Information and Log Windows (Pg 234).
- 427 -
Chapter 12: Command and Menu Reference
Charts
Choose from a submenu listing all available
charts for the current map window
Map List
Use the Map List command to open the Map List window or bring it to the front.
- 428 -
Window Menu
Device List
Use the Device List command to view the Device List window, which shows a
global device list. InterMapper keeps a server-wide list of all the devices that are
being monitored on all enabled maps that the current logged-in user can see.
- 429 -
Chapter 12: Command and Menu Reference
Help Menu
Use the Help menu to view the on-line help system.
About InterMapper
Opens the InterMapper software information page. View information about the soft-
ware and its contributors, as well as viewing information about memory use, plat-
form, operating system and current Java version.
- 430 -
Help Menu
(InterMapper Only)
Diagnostics (submenu)
- 431 -
Chapter 12: Command and Menu Reference
Reverse Connection...
Detailed Logs...
- 432 -
Help Menu
Server Command...
InterMapper RemoteAc-
cess can instruct a server
to execute certain com-
mands, and to display the
output in the Debug Log
file. The major command
is snmpwalk; it and
other commands are
described in the
Developer Guide.
Client Log
Use this command to open the Client Log window, which contains the messages
sent between the client and the InterMapper server. This information can often be
useful for debugging InterMapper problems.
Server Log
Use this command to open the Debug log file for the server. It can also be opened
from the Window>Logs>Debug menu.
- 433 -
Chapter 12: Command and Menu Reference
InterMapper Menus
Macintosh OSX adds an InterMapper menu or IM RemoteAccess menu. These
menus contain menu items that normally appear in other menus on other plat-
forms.
The About, Preferences..., and Quit menu items appear in these menus on
Macintosh systems.
For information on these features, see the menu reference topics as follows:
- 434 -
Context Menus
Context Menus
Use a context menu to choose options available for a particular device, network,
link, map, window or other screen object. The options available in a context menu
change depending on the object you are using to activate the context menu.
1. Right/Ctrl-click the object for which you want to activate the context menu.
The context menu appears.
2. Click to choose a command from the context menu. Commands appropriate to
the selected object and current context appear.
- 435 -
Chapter 12: Command and Menu Reference
Keyboard Shortcuts
InterMapper runs on multiple platforms. Since different platforms have different
modifier keys, (keys that change the function or meaning of another key) the key-
board shortcuts vary slightly from one platform to another.
General Rules
The primary difference is between Macintosh and Windows machines. Use the fol-
lowing rules, depending on your platform:
Macintosh: Commandkey
Each menu item that has a shortcut shows the key required for the shortcut in the
menu.
Keyboard Navigation
You can use the keyboard to speed up a number of operations. See Keyboard Nav-
igation (Pg 437) for a complete set of navigation keystrokes.
Other Shortcuts
A number of other shortcuts are available to help you work efficiently. See Quick
Reference - Editing Your Map (Pg 95) for additional selection and scrolling tech-
niques.
- 436 -
Keyboard Navigation
Keyboard Navigation
Scroll the view
- 437 -
Chapter 13
Probe Reference
Use the Probe Picker window to choose the probe you want to use to query the
device.
- 438 -
Chapter 13: Probe Reference
InterMapper comes with a large number of built-in probes. For a full index and
detailed descriptions of built-in probes, see the Probe Index (Pg 442).
l Basic Probes (Pg 448) - use the Basic probes to cover the majority of your
needs for probing devices.
l SNMP Probes (Pg 451)- use the SNMP probes to perform a wide variety of
queries on SNMP devices.
l Network Devices (Pg 466) - Use the network device probes to query net-
work devices, such as routers, switches and UPS units.
l PowerShell Probes (Pg 479) - Use these probes to get information from
Windows machines using PowerShell scripts.
l Servers-Standard (Pg 505) - use these probes to query various devices
using one of many Standard protocols.
l Servers-Proprietary (Pg 485) - use these probes to query various devices
using one of many Proprietary protocols.
l Miscellaneous Probes (Pg 461) - use these probes for a variety of uses.
You can find the Demo, Non-Polling, and TCP Check probes. You can also find
the Legacy probes (included to support older maps) and the template for
developing Nagios and Command-line probes.
l Wireless Probes (Pg 549) - Use these probes to get vendor-specific
information from a number of wireless devices.
l WMI Probes (Pg 536) - If InterMapper is installed on a Windows machine,
use these probes to get detailed information from Windows workstations
through the Windows Management Instrumentation (WMI) interface.
Packet-based probes
Probes such as "Ping/Echo", "SNMP Traffic", "NNTP" and "RADIUS" send UDP pack-
ets to the device being tested and await a correctly formatted response.
The timeout period for waiting is configured by choosing Set Timeout from the
Set Probe Info submenu. If no response is received within the timeout period,
InterMapper tries again by sending another request packet. This process is
repeated until either a response is received, or the number of requests sent
exceeds the "Number of Lost Packets" threshold set for the map (a default of 3).
All packet-based probes check the integrity of the response they receive, and
some can set the status of the device (Alarm, Warning, or OK) based on the sever-
ity of a problem.
TCP-based probes
Probes like "HTTP", "SMTP", and "LDAP" and others test the ability of a server to
accept a TCP connection on a specific listening port, and to respond to a scripted
interchange.
- 439 -
Probe Reference
Miscellaneous Probes
l Demo probe - Use this probe to create demonstration maps, which simulate
a network and its activity.
l Legacy probes - These probes that have been superceded by other probes.
They are included to support older maps.
l Nagios - Use the Nagios probe type to select plugins from the Nagios mon-
itoring system. InterMapper can use these plugins to test devices. For more
details, see the Nagios Plugins page in the Developer Guide.
l Non-polling probe - Choose this probe so that the selected device is not
probed.
l Prototype SNMP probe - Use this probe as the basis for creating custom
SNMP probes.
l TCP Check probe - Use this probe to monitor the number of TCP con-
nections to an SNMP-enabled device and to send an alarm when a specified
number of connections is exceeded.
If you are having trouble getting PowerShell probes to work, you can look in the
Debug Log information.
- 440 -
Chapter 13: Probe Reference
- 441 -
Probe Reference Index
l Network Devices > Apple > Apple AirPort (Extreme) (Pg 466)
l Network Devices > Apple > Apple AirPort (Graphite) (Pg 467)
l Network Devices > Cisco > Cisco IP SLA Jitter (Pg 467)
l Network Devices > Cisco > Cisco N5000 with FEX Traffic (Pg 469)
l Network Devices > Cisco > Cisco Old CPU MIB (Pg 469)
l Network Devices > Cisco > Cisco Process and Memory Pool (Pg 470)
l Network Devices > Cisco > Cisco Aironet (Pg 470)
l Network Devices > Juniper > Netscreen VPN (Pg 471)
l Network Devices > Karlnet Wireless (Pg 471)
l Network Devices > UPS > APC UPS AP961x (Pg 471)
l Network Devices > UPS > APC UPS (Pg 472)
l Network Devices > UPS > BestPower UPS (Pg 473)
l Network Devices > UPS > Exide UPS (Pg 474)
l Network Devices > UPS > Liebert UPS OpenComms (Pg 474)
l Network Devices > UPS > Liebert UPS Series 300 (Pg 475)
l Network Devices > UPS > Liebert UPS (Pg 476)
l Network Devices > UPS > Standard UPS (RFC1628) (Pg 476)
l Network Devices > UPS > TrippLite UPS (Pg 477)
l Network Devices > UPS > Victron UPS (Pg 477)
- 442 -
Chapter 13: Probe Reference
- 443 -
Probe Reference Index
- 444 -
Chapter 13: Probe Reference
Splunk view
- 445 -
Probe Reference Index
- 446 -
Chapter 13: Probe Reference
- 447 -
Basic
Basic
l Basic > Automatic (Pg 448)
l Basic > Map Status (Pg 448)
l Basic > Ping/Echo (Pg 449)
l Basic > SNMP Traffic (Pg 449)
Automatic
How it works:
Filename: com.dartware.automatic
Version: 1.7
Back to Top
Map Status
The easiest way to use this probe is to drag a map from the Map List onto
another editable map. You can also create a device using the DNS Name
or IP address of the InterMapper server containing the map, or "loc-
alhost" for a local map. Then set the following:
Filename: com.dartware.map.status
Version: 1.8
Back to Top
- 448 -
Chapter 13: Probe Reference
Ping/Echo
This probe sends an ICMP echo request packet to the target device to
determine if it is active and responding.
InterMapper sends the ping packet, then waits for a response. The
device's specified Timeout value is used to determined the amount of
time the probe waits for a response. If no response is received within the
specified time, InterMapper re-sends the echo request, waiting again the
device's Timeout. When the probe reaches the device's limit of the num-
ber of pings to send (as determined by the device or map's limit),
without receiving a response, the device status is set to DOWN.
By default, the number of echo requests is three, and the default timeout
is three seconds. Thus it can take up to nine seconds to set a device
status to DOWN.
Filename: com.dartware.ping
Version: 2.0
Back to Top
SNMP Traffic
The probe also shows sysLocation, sysContact, and sysUptime from the
system group in the device's Status Window.
Note: This is exactly the same probe as the "SNMP MIB-II" probe found
in earlier versions of InterMapper. It was renamed to reflect its purpose
more accurately.
- 449 -
Basic
Filename: com.dartware.snmp
Version: 1.7
Back to Top
- 450 -
Chapter 13: Probe Reference
SNMP
l SNMP > Basic OID (Pg 451)
l SNMP > Comparison (Pg 451)
l SNMP > High Threshold (Pg 452)
l SNMP > Low Threshold (Pg 453)
l SNMP > Range Threshold (Pg 453)
l SNMP > Restricted Interface (Pg 454)
l SNMP > Single OID Viewer (Pg 454)
l SNMP > SNMP High PPS (Pg 455)
l SNMP > SNMP High Traffic (Pg 455)
l SNMP > SNMP High Util (Pg 455)
l SNMP > String Comparison (Pg 456)
l SNMP > Table Viewer (Pg 457)
l SNMP > Trap Viewer (Pg 458)
Basic OID
Object Name - optional - The name of the value that you want to mon-
itor. This parameter value is used only for display in the popup window
and chart legend.
Object ID - The object identifier (OID) of the value that you want to mon-
itor. To retrieve the value of a MIB variable that is not in a table, the OID
must end with ".0" (e.g. "1.3.6.1.2.1.1.1.0").
This probe retrieves a lot of SNMP information from the device, including
the MIB-II system group and the interfaces table. If you just want to
monitor a single SNMP variable, use the SNMP/Single OID probe.
Filename: com.dartware.snmp.basic
Version: 0.7
Back to Top
Comparison
Parameters
Variable - the MIB name or OID to retrieve. If you have imported the
MIB for this device, enter the symbolic name for this value. Otherwise,
enter its OID.
- 451 -
SNMP
Test - Choose whether to set the status to ALARM if the device is Equal
or NotEqual to the Value parameter.
Legend - A text string used to identify the variable in the status window
and any strip charts. If left blank, the variable's name or OID is used.
Units - optional - A text string that is displayed next to the value in the
Status Window, intended for use as a unit of measure (packets/sec,
degrees, etc.)
Tag - A short text string that identifies a particular class of dataset. Tags
are used to correlate different variables from different probes that
describe the same type of data, such as CPU% or temperature.
Filename: com.dartware.snmp.oidcomparison.txt
Version: 1.11
Back to Top
High Threshold
This probe retrieves a single SNMP MIB variable and compares it to the
specified thresholds below. If the value goes above any of the specified
thresholds, the device changes to the specified state.
Parameters
Variable - the MIB name or OID to retrieve. If you have imported the
MIB for this device, enter the symbolic name for this value. Otherwise,
enter its OID.
Legend - a text string used to identify the variable in the status window
and in strip charts. If left blank, the variable's name or OID is used.
Units - a text string displayed next to the variable's value in the Status
Window. Usually used for units of measure (packets/sec, degrees, etc.)
Tag - A short text string that identifies a particular class of dataset. Tags
are used to correlate different variables from different probes that
describe the same type of data, such as CPU% or temperature.
Filename: com.dartware.snmp.oidhigh.txt
Version: 1.6
- 452 -
Chapter 13: Probe Reference
Back to Top
Low Threshold
This probe retrieves a single SNMP MIB variable and compares it to the
specified thresholds below. If the value goes below any of the specified
thresholds, the device changes to the specified state.
Parameters
Variable - the MIB name or OID to retrieve. If you have imported the
MIB for this device, enter the symbolic name for this value. Otherwise,
enter its OID.
Legend - a text string used to identify the variable in the status window
and in strip charts. If left blank, the variable's name or OID is used.
Units - a text string displayed next to the variable's value in the Status
Window. Usually used for units of measure (packets/sec, degrees, etc.)
Tag - A short text string that identifies a particular class of dataset. Tags
are used to correlate different variables from different probes that
describe the same type of data, such as CPU% or temperature.
Filename: com.dartware.snmp.oidlow.txt
Version: 1.6
Back to Top
Range Threshold
This probe retrieves a single SNMP MIB variable and compares it to the
specified thresholds. If the value goes outside the specified range, the
device changes to the corresponding state.
Parameters
Variable - the MIB name or OID to retrieve. If you have imported the
MIB for this device, enter the symbolic name for this value. Otherwise,
enter its OID.
Legend - a text string used to identify the variable in the status window
and in strip charts. If left blank, the variable's name or OID is used.
- 453 -
SNMP
Units - a text string displayed next to the variable's value in the Status
Window. Usually used for units of measure (packets/sec, degrees, etc.)
Tag - A short text string that identifies a particular class of dataset. Tags
are used to correlate different variables from different probes that
describe the same type of data, such as CPU% or temperature.
Filename: com.dartware.snmp.oidrange.txt
Version: 1.7
Back to Top
Restricted Interface
This probe is identical to the Basic SNMP Traffic probe, except that it
restricts the visible interfaces to those that match the specified Interface
Description.
Parameters
Filename: com.dartware.snmp.restrictedint.txt
Version: 0.2
Back to Top
This probe retrieves a single SNMP MIB variable and displays it in the
device's Status Window.
Parameters
Variable - the MIB name or OID to retrieve. If you have imported the
MIB for this device, enter the symbolic name for this value. Otherwise,
enter its OID.
Legend - a text string used to identify the variable in the status window
and in strip charts. If left blank, the variable's name or OID is used.
Units - a text string displayed next to the variable's value in the Status
Window. Usually used for units of measure (packets/sec, degrees, etc.)
Tag - A short text string that identifies a particular class of dataset. Tags
are used to correlate different variables from different probes that
describe the same type of data, such as CPU% or temperature.
- 454 -
Chapter 13: Probe Reference
Filename: com.dartware.snmp.oidsingle.txt
Version: 1.5
Back to Top
This probe monitors the ifInPackets and ifOutPackets statistics of the spe-
cified device interface, and sets the state of the device to Alarm or
Warning when the packet rate (in packets/second) exceeds specified
thresholds. It sets the state to Down if the interface's ifOperStatus is not
equal to 1 (Up).
Parameters
Filename: com.dartware.snmp.pps.txt
Version: 0.6
Back to Top
Parameters
Filename: com.dartware.snmp.traffic.txt
Version: 0.4
Back to Top
- 455 -
SNMP
Parameters
Filename: com.dartware.snmp.traffic-util.txt
Version: 0.3
Back to Top
String Comparison
Parameters
Variable - the MIB name or OID to retrieve. If you have imported the
MIB for this device, enter the symbolic name for this value. Otherwise,
enter its OID.
Test - choose whether the device is equal to the Value parameter or not.
Severity - choose severity level to use if the value does not match the
specified value.
Legend - a text string used to identify the variable in the status window
and in strip charts. If left blank, the variable's name or OID is used.
Units - a text string displayed next to the variable's value in the Status
Window. Usually used for units of measure (packets/sec, degrees, etc.)
Tag - A short text string that identifies a particular class of dataset. Tags
are used to correlate different variables from different probes that
describe the same type of data, such as CPU% or temperature.
Filename: com.dartware.snmp.oidstrcomparison.txt
Version: 1.9
Back to Top
- 456 -
Chapter 13: Probe Reference
Table Viewer
This probe shows the contents of several useful tables from common
SNMP MIBs. It retrieves its data by walking the SNMP data values in the
tables.
A link to each table appears in the Status Window. Click the link to see
the contents of the table on the selected device.
- 457 -
SNMP
This probe requires that you first import these MIBs: RFC1213-MIB (MIB-
II), Bridge MIB (rfc1493), IP-MIB (rfc2011), IF-MIB (rfc2863), and IP-
FORWARD-MIB (rfc2096). These are all bundled together in a single zip
archive.
Parameters
None.
Filename: com.dartware.snmp.tableviewer.txt
Version: 1.9
Back to Top
Trap Viewer
This probe listens for trap packets and displays the contents of a trap in
the Status Window. It does not actively poll the device, and takes no
action based on the contents of the trap.
All variables parsed from the trap packet appear in the device's Status
Window. You can use this probe as a prototype for making your own trap
probes.
When a trap arrives, the probe parses the trap to retireve the values
from the trap's header, along with the first ten items in its Varbind List.
Each value is assigned to a variable for use by the probe; each is also
shown in the Status Window.
To see how this probe works, you can configure your equipment to send
traps to InterMapper, or use the net-snmp snmptrap command. Either
way, the Status Window shows the values present in any traps that
arrive.
For more information on the snmptrap command, see the net-snmp doc-
umentation for the trap tutorial and the snmptrap command. The
remainder of this note shows how to send a trap with variables from the
Dartware MIB:
SNMPv1 Traps
c) Issue the snmptrap command below from the command line (it should
all be on one line):
- 458 -
Chapter 13: Probe Reference
1.3.6.1.4.1.6306.2.1.2.0 s Critical
1.3.6.1.4.1.6306.2.1.5.0 s "127.0.0.1"
SNMPv2c Traps
c) Issue the snmptrap command below from the command line (it should
all be on one line)
4567890 1.3.6.1.4.1.6306
1.3.6.1.4.1.6306.2.1.2.0 s Critical
1.3.6.1.4.1.6306.2.1.5.0 s "127.0.0.1"
Notes:
l This probe file contains the lines above in a single-line format suit-
able for copying and pasting.
l The parameters in this probe are unused, but could be used to set
thresholds for various alarms.
Parameters
MinValue - Unused
MaxVAlue - Unused
- 459 -
SNMP
Filename: com.dartware.snmp.trapdisplay.txt
Version: 2.3
Back to Top
- 460 -
Chapter 13: Probe Reference
Miscellaneous
l Miscellaneous > Demo Probe (Pg 461)
l Miscellaneous > Legacy > Basic OID (v2c) (Pg 461)
l Miscellaneous > Legacy > Cisco (v2c) (Pg 462)
l Miscellaneous > Legacy > SNMP v2c (Pg 462)
l Miscellaneous > Nagios > Nagios Plugin (Pg 463)
l Miscellaneous > Non Polling (Pg 463)
l Miscellaneous > Prototype SNMP Probe (Pg 464)
l Miscellaneous > TCP Check (Pg 465)
Demo Probe
Use this probe to build a demo map. The probe generates random data
for the traffic on all its links, giving you something to look at. All data are
chartable, and can be used to demonstrate strip charts or data collection.
The probe also toggles the device state between UP/OK and Down when
you reprobe the device manually. This makes it easy to see what hap-
pens when a device goes down, especially for manual dependencies.
For simple maps, the parameters can be set to zero. To create com-
plicated, heavily-interconnected demonstration maps, try setting the
Link Count and Loop % parameters to 10 and 50, respectively.
Link Count - sets the number of interfaces to create when adding the
device to the map.
Filename: com.dartware.demo
Version: 1.6
Back to Top
This probe lets you monitor a single, user-defined MIB variable. It uses
SNMPv2c.
Object Name - optional - The name of the value that you want to mon-
itor. It appears in the Status window and in a chart legend.
- 461 -
Miscellaneous
Object ID - The object identifier (OID) of the value that you want to mon-
itor. To retrieve the value of a MIB variable that is not in a table, the OID
must end with ".0" (e.g. "1.3.6.1.2.1.1.1.0").
Filename: com.dartware.snmpv2c.basic
Version: 1.5
Back to Top
Cisco (v2c)
This probe monitors the CPU and Memory utilization of a Cisco router
using SNMPv2c.
Parameters
CPU Busy - Alarm - specifies the Alarm threshold for CPU utilization as a
percentage. If the average CPU usage over a 1 minute interval exceeds
this threshold, the device is set to Alarm state.
CPU Busy - Warning - specifies the Warning threshold for CPU util-
ization. If the average CPU usage over a 1 minute interval exceeds this
threshold, the device is set to Warning state.
Low Memory - Alarm - specifies the Alarm threshold for the amount of
free memory remaining (in bytes). If the free memory drops below this
threshold, the device is set to Alarm state.
Filename: com.dartware.snmpv2c.cisco
Version: 1.11
Back to Top
SNMP v2c
- 462 -
Chapter 13: Probe Reference
The SNMP v2c probe retrieves MIB-II information from the device. This
includes sysLocation, sysContact, and sysUptime from the system group,
and traffic (bytes/second, packets/second, errors/minute) for each inter-
face.
It uses the 64-bit counters for interface traffic statistics. This provides
accurate information (without rollover) on very high speed links.
Filename: com.dartware.snmpv2c
Version: 1.6
Back to Top
Nagios Plugin
This probe lets you specify a Nagios plugin. InterMapper invokes the plu-
gin and uses the exit value to set the condition of the device. It uses the
performance data returned by the plugin to create a nice display of chart-
able data.
Nagios and the Nagios logo are registered trademarks of Ethan Galstad.
For more information, see http://www.nagios.org
Parameters
Plugin - enter the Nagios command string. You can use the ${ADDRESS}
and ${PORT}, as mentioned above.
Filename: com.dartware.nagios.template
Version: 1.8
Back to Top
Non-Polling
This probe does not cause any action to occur. It can be used as a place-
holder for a device; it does not count against the InterMapper device
count.
- 463 -
Miscellaneous
Filename: com.dartware.nonpolling
Version: 1.5
Back to Top
This probe probably isn't useful for production work, but provides
examples of techniques available in custom SNMP probes.
The probe also provides thresholds that set the device into Alarm or
Warning state.
In this example, the device goes into Alarm or Warning state if it has
been rebooted recently (controlled by the RebootAlarm and RebootWarn
parameters - two and three minutes, by default) or if there aren't as
many interfaces in the ifTable as specified (in the ExpectedInterfaces
parameter.)
Parameters
RebootAlarm - set the device to Alarm if the sysUptime is less than the
specified value in minutes.
Filename: com.dartware.snmp.prototype.txt
Version: 1.4
- 464 -
Chapter 13: Probe Reference
Back to Top
TCP Check
Parameters
Filename: com.dartware.snmp.tcpcheck
Version: 1.6
Back to Top
- 465 -
Network Devices
Network Devices
l Network Devices > Apple > Apple AirPort (Extreme) (Pg 466)
l Network Devices > Apple > Apple AirPort (Graphite) (Pg 467)
l Network Devices > Cisco > Cisco IP SLA Jitter (Pg 467)
l Network Devices > Cisco > Cisco N5000 with FEX Traffic (Pg 469)
l Network Devices > Cisco > Cisco Old CPU MIB (Pg 469)
l Network Devices > Cisco > Cisco Process and Memory Pool (Pg 470)
l Network Devices > Cisco > Cisco Aironet (Pg 470)
l Network Devices > Juniper > Netscreen VPN (Pg 471)
l Network Devices > Karlnet Wireless (Pg 471)
l Network Devices > UPS > APC UPS AP961x (Pg 471)
l Network Devices > UPS > APC UPS (Pg 472)
l Network Devices > UPS > BestPower UPS (Pg 473)
l Network Devices > UPS > Exide UPS (Pg 474)
l Network Devices > UPS > Liebert UPS OpenComms (Pg 474)
l Network Devices > UPS > Liebert UPS Series 300 (Pg 475)
l Network Devices > UPS > Liebert UPS (Pg 476)
l Network Devices > UPS > Standard UPS (RFC1628) (Pg 476)
l Network Devices > UPS > TrippLite UPS (Pg 477)
l Network Devices > UPS > Victron UPS (Pg 477)
This probe monitors the custom MIB in an Apple AirPort Extreme Base
Station. This probe monitors the number of clients using the base sta-
tion, and lists each with its signal strength.
The first version of AirPort Extreme was round; subsequent versions are
square. There is one important difference between them:
Parameters
None.
Filename: com.dartware.snmp.airport.ext
Version: 1.6
Back to Top
- 466 -
Chapter 13: Probe Reference
This probe monitors the custom MIB in an Apple AirPort Base Station (v1
= Graphite) using SNMPv1. This probe monitors the number of clients
using the base station and lists each one with its signal strength.
Parameters
Filename: com.dartware.snmp.airport
Version: 1.8
Back to Top
This probe extracts jitter test data from a Cisco IP SLA agent that is run-
ning on a Cisco router or switch. Typically these jitter tests are used to
measure jitter, latency, and packet loss for VoIP and video conferencing
applications.
Parameters
SNMP Index - The value used when configuring the IP SLA agent in the
Cisco switch or router using the "ip sla monitor" command (see example
below). This value identifies the jitter test, and is the SNMP index used
by Intermapper to probe the device. To probe for different instances of
jitter tests on a single Cisco switch or router, create separate devices on
your Intermapper map, each using a different SNMP Index.
Jitter Alarm Threshold - The ALARM threshold for Jitter. If the Average Jit-
ter value exceeds this threshold, the device enters ALARM state.
Jitter Warning Threshold - The WARNING threshold for Jitter. If the Aver-
age Jitter value exceeds this threshold, the device enters WARNING
state.
- 467 -
Network Devices
Packet Loss Alarm Threshold - The ALARM threshold for Packet Loss. If
the Percent Packet Loss value exceeds this threshold, the device enters
ALARM state.
Example
request-data-size 256
owner yyyy
tag zzzz
exit
In the above example specifies "250" as the SNMP index. This can be any
value as long as it is unique. "w.w.w.w" is the IP address of the remote
IP SLA responder. "x.x.x.x" is the local IP address of this IP SLA agent.
"yyyy" is any text information identifying the owner of the test (e.g.,
name of network service provider). "zzzz" is any text information identi-
fying this particular test.
In the above IOS commands, the jitter test does not specify a codec
type, so ICPIF and MOS scores are not available. If the test is modified
to include a codec type then minor revisions are required to this SNMP
probe. Also, some routers and switches may not support the MIB vari-
ables for ICPIF and MOS scores - this depends on the IOS train.
Filename: com.dartware.snmp.cisco-ip-sla.txt
Version: 2.4
Back to Top
- 468 -
Chapter 13: Probe Reference
Network Devices > Cisco > Cisco N5000 with FEX Traffic
This probe provides Basic SNMP Traffic probe functionality for the Nexus
5000 with Fiber Extender (FEX). The standard SNMP Traffic probe does
not show the Fiber Extender's interfaces, so this probe incorporates spe-
cial logic to retrieve that information.
Parameters
None.
Filename: com.dartware.snmp.cisco.n5kfex.traffic.txt
Version: 1.1
Back to Top
This probe monitors the CPU and Memory utilization of a Cisco router.
Parameters
CPU Busy - Alarm - The ALARM threshold for CPU utilization in Per Cent.
If the average CPU usage over a 1 minute interval exceeds this
threshold, the device enters ALARM state.
CPU Busy - Warning - The WARNING threshold for CPU utilization in Per
Cent. If the average CPU usage over a 1 minute interval exceeds this
threshold, the device enters WARNING state.
Low Memory - Alarm - The ALARM threshold for the amount of free
memory remaining (in bytes). If free memory drops below this
threshold, the device enters ALARM state.
Low Memory - Warning - The WARNING threshold for the amount of free
memory remaining (in bytes). If free memory drops below this
threshold, the device enters WARNING state.
Filename: com.dartware.snmp.cisco
Version: 1.9
Back to Top
- 469 -
Network Devices
Network Devices > Cisco > Cisco Process and Memory Pool
This probe monitors the CPU and Memory utilization in a Cisco router. It
uses variables from CISCO-MEMORY-POOL-MIB and CISCO-PROCESS-
MIB.
Parameters
CPU Busy - Alarm - The ALARM threshold for CPU utilization in Per Cent.
If the average CPU usage over a 1 minute interval exceeds this
threshold, the device enters ALARM state.
CPU Busy - Warning - The WARNING threshold for CPU utilization in Per
Cent. If the average CPU usage over a 1 minute interval exceeds this
threshold, the device enters WARNING state.
Low Memory - Alarm - The ALARM threshold for the amount of free
memory remaining (in bytes). If the free memory drops below this
threshold, the device enters ALARM state.
Low Memory - Warning - The WARNING threshold for the amount of free
memory remaining (in bytes). If the free memory drops below this
threshold, the device enters WARNING state.
Filename: com.dartware.snmp.cisconewmib
Version: 1.9
Back to Top
Cisco Aironet
This probe uses SNMPv1 to monitor the custom MIB in a Cisco Aironet
Wireless Access Point. It monitors the number of clients using the base
station and lists each client with its signal strength.
The alarm and warning thresholds must be greater than zero, or they are
ignored.
Parameters
Number of Active Stations alarm - Set the threshold at which the device
goes into ALARM state.
Filename: com.dartware.snmp.aironet
Version: 1.6
Back to Top
- 470 -
Chapter 13: Probe Reference
Netscreen VPN
Some statistics may be available only if the monitoring status for the tun-
nel as reported by nsVpnMonMonState is on.
Parameters
None.
Filename: com.dartware.snmp.netscreen.txt
Version: 1.2
Back to Top
Karlnet Wireless
This probe monitors the custom MIB in a Karlnet Wiress Base Station
using SNMPv1. It monitors the number of clients using the base station
and lists each, along with its signal strength.
This probe sends SNMP set-requests to the Karlnet Base Station, causing
it to discover and test the signal strength of each client. For the set-
requests to work, enter the read/write community string for the base sta-
tion.
Parameters
Filename: com.dartware.snmp.karlnet
Version: 1.6
Back to Top
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
- 471 -
Network Devices
B. Displayed Values
C. Alarms
D. Warnings
Parameters
None.
Filename: com.dartware.ups.apc-ap961x.txt
Version: 3.5
Back to Top
APC UPS
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
B. Displayed Values
C. Alarms
- 472 -
Chapter 13: Probe Reference
D. Warnings
Parameters
Filename: com.dartware.ups.apc.txt
Version: 3.5
Back to Top
BestPower UPS
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
B. Displayed Values
- 473 -
Network Devices
Parameters
Filename: com.dartware.ups.bestpower.txt
Version: 2.11
Back to Top
Exide UPS
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
B. Displayed Values
C. Alarms
Parameters
None.
Filename: shef.ac.uk.ups.exide.txt
Version: 2.12
Back to Top
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
- 474 -
Chapter 13: Probe Reference
B. Displayed Values
C. Alarms
Parameters
None.
Filename: com.dartware.ups.liebert-opencomms.txt
Version: 2.13
Back to Top
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
B. Displayed Values
vendor, model, software version, firmware version, output load (%), bat-
tery voltage, battery current, (three input, output, and bypass phases:
voltage, current),(frequencies: input, output, bypass)
C. Alarms
Parameters
None.
Filename: com.dartware.ups.liebert-series300.txt
Version: 2.7
Back to Top
- 475 -
Network Devices
Liebert UPS
1) Check other probes to see if one exists for your Liebert UPS device.
3) Open the status window and "Copy All" (right/option click on the win-
dow)
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
B. Displayed Values
Parameters
None.
Filename: com.dartware.ups.liebert-ups.txt
Version: 2.7
Back to Top
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
B. Displayed Values
C. Alarms
- 476 -
Chapter 13: Probe Reference
Parameters
Filename: com.dartware.ups.standard.txt
Version: 3.5
Back to Top
TrippLite UPS
A. Probed MIB(s)
This probe works best with devices which have implemented the listed
MIB(s).
B. Displayed Values
C. Alarms
Parameters
None.
Filename: com.dartware.ups.tripplite.txt
Version: 2.12
Back to Top
Victron UPS
Parameters
- 477 -
Network Devices
UPS Battery low Voltage - Warning - WARNING threshold for the min. bat-
tery voltage. If the Battery voltage is less than this threshold, the device
is set to Warning.
Low Input Voltage line [1,2, or 3] - Alarm - ALARM threshold for the min-
inmum specified input voltage on phase 1, 2, or 3. If the input voltage
drops below this threshold, the device is set to Alarm.
Low Output Voltage line [1,2, or 3] - Alarm - ALARM threshold for the min-
inmum specified output voltage on phase 1, 2, or 3. If the output voltage
drops below this threshold, the device is set to Alarm.
Filename: de.medianet.freinet.ups.victron.txt
Version: 3.0
Back to Top
- 478 -
Chapter 13: Probe Reference
PowerShell
l PowerShell > Disk Space (Pg 479)
l PowerShell > Remoting > Disk Space (Signed) (Pg 480)
l PowerShell > Remoting > Disk Space (Pg 481)
l PowerShell > Remoting > Installed Software (Pg 481)
l PowerShell > Remoting > Process Count (Pg 482)
Disk Space
Parameters
Drive - set to "All" to list all Local hard drives on the host. Enter a list of
comma-separated drive letters with colons. Drives can be listed regard-
less of whether they are local or not. Zero-sized drives, such as empty
cd-roms, are not listed. The first drive failing the warning or critical cri-
teria test is cited in the reason.
Warning, Alarm, Critical, Down (%) - enter a threshold for the per-
centage of disk space that changes the device's state to the specified
alarm level.
User - may be a local user on the target host, or may take the form of
"domain\user" for a domain login. Leave it blank if authentication is not
required, such as when the target is the localhost.
Filename: com.helpsystems.powershell.wmi.diskspace.txt
Version: 1.0
- 479 -
PowerShell
Back to Top
Parameters
Drive - set to "All" to list all Local hard drives on the host. Use a list of
comma-separated drive letters with colons. Drives can be listed regard-
less of whether they are local or not. Zero-sized drives (i.e. an empty
cd-rom) are not listed. The first drive failing the warning or critical cri-
teria test is cited in the reason.
Warning, Alarm, Critical, Down (%) - enter a threshold for the per-
centage of disk space that changes the device's state to the specified
alarm level.
User - may be a local user on the target host, or may take the form of
"domain\user" for a domain login. Leave it blank if authentication is not
required, such as when the target is the localhost.
Filename:
com.helpsystems.powershell.remote.diskspace.sign.txt
Version: 1.0
- 480 -
Chapter 13: Probe Reference
Back to Top
Disk Space
Parameters
Drive - set to "All" to list all Local hard drives on the host. Use a list of
comma-separated drive letters with colons. Drives can be listed regard-
less of whether they are local or not. Zero-sized drives (i.e. an empty
cd-rom) are not listed. The first drive failing the warning or critical cri-
teria test is cited in the reason.
Warning, Alarm, Critical, Down (%) - enter a threshold for the per-
centage of disk space that changes the device's state to the specified
alarm level.
User - may be a local user on the target host, or may take the form of
"domain\user" for a domain login. Leave it blank if authentication is not
required, such as when the target is the localhost.
Filename: com.helpsystems.powershell.remote.diskspace.txt
Version: 1.0
Back to Top
Installed Software
- 481 -
PowerShell
configured to use this probe. This probe uses the registry, not WMI
objects
Parameters
User - may be a local user on the target host, or may take the form of
"domain\user" for a domain login. Leave it blank if authentication is not
required, such as when the target is the localhost.
Filename:
com.helpsystems.powershell.remote.installedSoftware.txt
Version: 1.0
Back to Top
Process Count
Parameters
User - may be a local user on the target host, or may take the form of
"domain\user" for a domain login. Leave it blank if authentication is not
required, such as when the target is the localhost.
- 482 -
Chapter 13: Probe Reference
Filename:
com.helpsystems.powershell.remote.processcount.txt
Version: 1.0
Back to Top
- 483 -
Probe Groups
Probe Groups
l Probe Groups > Probe Group (Pg 484)
Probe Group
This probe creates an empty probe group. Once you have created a
device using this probe, you can select the new probe group device and
other devices and choose Insert->Group to place those devices into the
single probe group. Find out more about probe groups in the User Guide
at http://intermapper.com/go.php?to=intermapper.probegroups.
Parameters
None.
Filename: com.dartware.probegroup.txt
Version: 0.4
Back to Top
- 484 -
Chapter 13: Probe Reference
Servers-Proprietary
l Servers Proprietary > 4D Server (Pg 485)
l Servers Proprietary > Apache > (Pg 486)
l Servers Proprietary > Apple > AppleShareIP (Pg 486)
l Servers Proprietary > Apple > OS X Server > AFP (Pg 487)
l Servers Proprietary > Apple > OS X Server > FTP (Pg 487)
l Servers Proprietary > Apple > OS X Server > Info (Pg 488)
l Servers Proprietary > Apple > OS X Server > NAT (Pg 488)
l Servers Proprietary > Apple > OS X Server > Print (Pg 488)
l Servers Proprietary > Apple > OS X Server > QTSS (Pg 489)
l Servers Proprietary > Apple > OS X Server > Web (Pg 489)
l Servers Proprietary > Apple > RTMP (Pg 490)
l Servers Proprietary > Apple > Xserve > Xserve G4 (Pg 490)
l Servers Proprietary > Apple > Xserve > Xserve G5 (Pg 491)
l Servers Proprietary > Apple > Xserve > Xserve RAID (Pg 492)
l Servers Proprietary > Apple > Xserve > Xserve Tiger (PPC) (Pg 492)
l Servers Proprietary > Barracuda > Barracuda HTTP (Pg 493)
l Servers Proprietary > Barracuda > Barracuda HTTPS (Pg 495)
l Servers Proprietary > Big Brother Probe (Pg 498)
l Servers Proprietary > BlitzWatch (Pg 498)
l Servers Proprietary > Citrix Server (Pg 498)
l Servers Proprietary > Dartware > DataCenter > IMAuth (Pg 499)
l Servers Proprietary > Dartware > DataCenter > IMDatabase (Pg 499)
l Servers Proprietary > DND Protocol (Pg 499)
l Servers Proprietary > FileMaker Pro (Pg 500)
l Servers Proprietary > FirstClass Server (Pg 500)
l Servers Proprietary > KeyServer (Pg 500)
l Servers Proprietary > Lotus Notes (Pg 501)
l Servers Proprietary > MeetingMaker (Pg 501)
l Servers Proprietary > Microsoft > DHCP Lease Check (Pg 501)
l Servers Proprietary > Microsoft > NT Services (Pg 502)
l Servers Proprietary > Microsoft > SQL Server Query (Pg 502)
l Servers Proprietary > Nagios NRPE (Pg 503)
4D Server
Filename: com.dartware.tcp.4D
Version: 1.5
Back to Top
- 485 -
Servers-Proprietary
This probes monitors an Apache Web Server with the Apache Status mod-
ule enabled (mod_status). The Apache Status module allows a server
administrator to find out how well an Apache server is performing. This
probe reads output of provided by the Status module that presents the
current server statistics, using the ?auto parameter.
To enable status reports for this probe, add this code to the httpd.conf
file on the target server:
<Location /server-status>
SetHandler server-status
Order Deny,Allow
</Location>
Parameters
Filename: com.dartware.tcp.apache.txt
Version: 1.1
Back to Top
AppleShareIP
This TCP probe connects to the AppleShareIP port and issues a "Get
Server Info" request. If the the probe does not receive the expected
response, the device's status is set to Down.
This probe sends a request; it does not actually create an AppleShare ses-
sion.
- 486 -
Chapter 13: Probe Reference
Filename: com.dartware.tcp.appleshareip
Version: 1.5
Back to Top
AFP
This TCP probe queries a Mac OS X Server installation for various details
about its Apple File Sharing using the Server Admin port and protocol.
Sends a request for status information via an HTTPS post to the Server
Admin port and parses an XML response.
Parameters
User - the name of any user on the specified server. An admin user is not
required.
Filename: com.dartware.tcp.osxserver.afp.txt
Version: 1.0
Back to Top
FTP
This TCP probe queries a Mac OS X Server installation for various details
about its FTP Server using the Server Admin port and protocol.
Sends a request for status information via an HTTPS post to the Server
Admin port and parses an XML response.
Parameters
User - the name of any user on the specified server. An admin user is not
required.
Filename: com.dartware.tcp.osxserver.ftp.txt
Version: 1.0
Back to Top
- 487 -
Servers-Proprietary
Info
This TCP probe queries a Mac OS X Server installation for various details
using the Server Admin port and protocol.
Sends a request for status information via an HTTPS post to the Server
Admin port and parses an XML response.
Parameters
User - the name of any user on the specified server. An admin user is not
required.
Filename: com.dartware.tcp.osxserver.info.txt
Version: 1.0
Back to Top
NAT
This TCP probe queries a Mac OS X Server installation for various details
about its NAT service using the Server Admin port and protocol.
A request for status information is made via an HTTPS post to the Server
Admin port. The server responds with XML data that is then parsed by
the probe.
Parameters
User - the name of any user on the specified server. An admin user is not
required.
Filename: com.dartware.tcp.osxserver.nat.txt
Version: 1.0
Back to Top
This TCP probe queries a Mac OS X Server installation for various details
about its Print Server using the Server Admin port and protocol.
- 488 -
Chapter 13: Probe Reference
Sends a request for status information via an HTTPS post to the Server
Admin port and parses an XML response.
Parameters
User - the name of any user on the specified server. An admin user is not
required.
Filename: com.dartware.tcp.osxserver.print.txt
Version: 1.0
Back to Top
QTSS
This TCP probe queries a Mac OS X Server installation for various details
about its QuickTime Streaming Server using the Server Admin port and
protocol.
Sends a request for status information via an HTTPS post to the Server
Admin port and parses an XML response.
Parameters
User - the name of any user on the specified server. An admin user is not
required.
Filename: com.dartware.tcp.osxserver.qtss.txt
Version: 1.0
Back to Top
Web
This TCP probe queries a Mac OS X Server installation for various details
about its Web Server using the Server Admin port and protocol.
Sends a request for status information via an HTTPS post to the Server
Admin port and parses an XML response.
Parameters
User - the name of any user on the specified server. An admin user is not
required.
- 489 -
Servers-Proprietary
Filename: com.dartware.tcp.osxserver.web.txt
Version: 1.0
Back to Top
RTMP
This probe sends an AppleTalk RTMP RDR Request query of type 3, and
waits for a RTMP response.
Filename: com.dartware.rtmp
Version: 1.5
Back to Top
Xserve G4
This TCP probe queries an Xserve G4 for various details using the Server
Monitor port and protocol.
A request for status information is made via an HTTPS post to the Server
Monitor port. The server responds with XML data that is then parsed by
the probe.
Info is general information about the server, such as amount of RAM and
OS name and version.
- 490 -
Chapter 13: Probe Reference
Security monitors the state of the security lock and the enclosure.
Filename: com.dartware.tcp.xserve.details
Version: 1.0
Back to Top
Xserve G5
This TCP probe queries an Xserve G5 for various details using the Server
Monitor port and protocol.
Sends a request for status information via an HTTPS post to the Server
Monitor port and parses an XML response.
Parameters
The remaining options let you display or ignore data in the response.
These options correspond to tabs in the Server Monitor application on
Mac OS X Server.
Info - general information about the server, such as amount of RAM, and
OS name, and version.
- 491 -
Servers-Proprietary
Filename: com.dartware.tcp.xserve.g5.txt
Version: 1.0
Back to Top
Xserve RAID
This TCP probe queries an Xserve RAID for various details using the
RAID Admin port and protocol.
Sends a request to an Xserve Raid via an HTTPS post via a series of HTTP
POSTs and parses an XML responses.
Parameters
Filename: com.dartware.tcp.xserve.raid.txt
Version: 1.0
Back to Top
Servers Proprietary > Apple > Xserve > Xserve Tiger (PPC)
This probe queries an Xserve running Mac OS X 10.4 using the Server
Monitor port and protocol. Because of this, the probe requires an admin-
istrators name and password in order to access the information. Due to
significant hardware differences, there are separate probes for G4
Xserves, G5 Xserves, and Intel Xserves.
Sends a request for status information via an HTTPS post to the Server
Monitor port and parses an XML response.
Parameters
The remaining options let you display or ignore data in the response.
These options correspond to tabs in the Server Monitor application on
Mac OS X Server.
- 492 -
Chapter 13: Probe Reference
Info - general information about the server, such as amount of RAM, and
OS name, and version.
Filename: com.dartware.tcp.xserve.tiger.txt
Version: 1.0
Back to Top
Barracuda HTTP
This TCP probe queries a Barracuda Spam Firewall for various per-
formance statistics.
Parameters
Thresholds
In/Out Queue Size - The returned value should normally be less than
100. An In or Out Queue value that consistently exceeds 100 for more
than 30 minutes may indicate a problem that needs attention.
Note: The returned value may rise temporarily, then go back down after
10 or 15 minutes.
l For the Inbound Queue, this is normal behavior, but can also be the
result of an orchestrated attack. The Barracuda attempts to read as
many messages as it can, which results in a slower processing rate,
- 493 -
Servers-Proprietary
Recommended settings:
Recommended settings:
Last Message - The time, in minutes, since the last message was
received. For a busy machine, this value should normally be less than 5
minutes. A value consistently exceeding 20 minutes for more than 30
minutes may indicate a problem that needs attention. Sometimes the
value will rise temporarily and then go back down after 2 or 3 minutes.
This is normal behavior.
Recommended settings:
CPU 1/CPU 2 Fan Speed - Should be between 3,000 and 5,000 (RPM)
Recommended settings:
l A value for either CPU fan that falls below 2500 should result in a
Warning.
l A value for either CPU fan that falls below 500 should result in an
Alarm.
Recommended settings:
- 494 -
Chapter 13: Probe Reference
Recommended settings:
System Load - The system's load (in percent.) During normal operation,
this value can vary wildly, anywhere between 1 and 100%. A value that
remains at 100% for more than 2 hours may indicate a problem that
needs attention. The value may rise temporarily, then go back down
after 2 or 3 minutes. This is normal behavior.
Recommended settings:
l A value above 80% for more than 1 hour should result in a Warn-
ing.
l A value above 90% for more than 3 hours should result in an
Alarm.
Recommended settings:
Filename: com.dartware.tcp.barracuda.http.txt
Version: 3.1
Back to Top
Barracuda HTTPS
This TCP probe queries a Barracuda Spam Firewall for various per-
formance statistics.
Parameters
- 495 -
Servers-Proprietary
Thresholds
In/Out Queue Size - The returned value should normally be less than
100. An In or Out Queue value that consistently exceeds 100 for more
than 30 minutes may indicate a problem that needs attention.
Note: The returned value may rise temporarily, then go back down after
10 or 15 minutes.
l For the Inbound Queue, this is normal behavior, but can also be the
result of an orchestrated attack. The Barracuda attempts to read as
many messages as it can, which results in a slower processing rate,
which in turn increases the number of messages in the queue.
l For the Outbound Queue, an increase usually indicates that the des-
tination server is unavailable or the local DNS is not functioning
properly.
Recommended settings:
Recommended settings:
Last Message - The time, in minutes, since the last message was
received. For a busy machine, this value should normally be less than 5
minutes. A value consistently exceeding 20 minutes for more than 30
minutes may indicate a problem that needs attention. Sometimes the
value will rise temporarily and then go back down after 2 or 3 minutes.
This is normal behavior.
Recommended settings:
CPU 1/CPU 2 Fan Speed - Should be between 3,000 and 5,000 (RPM)
- 496 -
Chapter 13: Probe Reference
Recommended settings:
l A value for either CPU fan that falls below 2500 should result in a
Warning.
l A value for either CPU fan that falls below 500 should result in an
Alarm.
Recommended settings:
Recommended settings:
System Load - The system's load (in percent.) During normal operation,
this value can vary wildly, anywhere between 1 and 100%. A value that
remains at 100% for more than 2 hours may indicate a problem that
needs attention. The value may rise temporarily, then go back down
after 2 or 3 minutes. This is normal behavior.
Recommended settings:
l A value above 80% for more than 1 hour should result in a Warn-
ing.
l A value above 90% for more than 3 hours should result in an
Alarm.
Recommended settings:
Filename: com.dartware.tcp.barracuda.https.txt
Version: 3.1
Back to Top
- 497 -
Servers-Proprietary
This probe lets you use InterMapper as a Big Brother "BBDISPLAY" to col-
lect information sent by Big Brother clients.
Purple Time - sets the number of minutes to wait without a report before
indicating a problem. In an actual Big Brother server, this is thirty
minutes; Big Brother shows a device as purple if it goes this long without
a report from the device. This probe shows it as DOWN.
Filename: com.dartware.bigbrother
Version: 1.6
Back to Top
BlitzWatch
This probe provides a simple view into the current state of a single
BlitzMail server, showing simultaneous user count, CPU utilization, and
disk transfer statistics.
Filename: com.dartware.blitzwatch
Version: 1.5
Back to Top
Citrix Server
This probe connects to a Citrix server, using default port 1494. It checks
for the presence of the string "ICA" in the response, which indicates that
the Citrix server is running.
Parameters
None.
- 498 -
Chapter 13: Probe Reference
Filename: com.dartware.tcp.citrix.txt
Version: 1.2
Back to Top
IMAuth
Parameters
Filename: com.dartware.tcp.imauth
Version: 0.4
Back to Top
IMDatabase
Parameters
Filename: com.dartware.tcp.imdatabase
Version: 0.4
Back to Top
DND Protocol
- 499 -
Servers-Proprietary
vice developed at Dartmouth College. The default TCP port number for
DND connections is port 902.
Filename: com.dartware.tcp.dnd
Version: 1.6
Back to Top
FileMaker Pro
Filename: com.dartware.tcp.filemaker
Version: 1.6
Back to Top
FirstClass Server
Filename: com.dartware.tcp.firstclass
Version: 1.6
Back to Top
KeyServer
Filename: com.dartware.keyserver
Version: 1.6
- 500 -
Chapter 13: Probe Reference
Back to Top
Lotus Notes
Lotus Notes uses Port 1352 for its Remote Procedure Call and Notes Rep-
lication.
Filename: com.dartware.tcp.lotusnotes
Version: 1.4
Back to Top
MeetingMaker
The MeetingMaker server listens on port 649. This probe attempts to con-
nect and exits with OKAY status if it succeeds.
Filename: com.dartware.tcp.meetingmaker
Version: 1.4
Back to Top
This probe monitors the count of free DHCP leases on a Microsoft DHCP
server. If the count goes below the specified thresholds, the device
enters ALARM or WARNING state.
Parameters
Free Lease Alarm - The number of free leases remaining at which the
device enters ALARM state.
Free Lease Critical - The number of free leases remaining at which the
device enters CRITICAL state.
- 501 -
Servers-Proprietary
View the DHCP scope table - Click to view a list of available scopes,
along with information about in-use lease, free lease, and pending
offers.
Filename: com.dartware.snmp.dhcpcheck.txt
Version: 0.4
Back to Top
NT Services
If Username and Password are left blank, the user credentials under
which InterMapper is running will be used.
Filename: com.dartware.ntsvcs.std
Version: 1.8
Back to Top
- 502 -
Chapter 13: Probe Reference
query and displays the returned fields. If no records are returned, the
device status is set to Critical.
Parameters
Rows and Columns - let you limit the output of your query. Enter the num-
ber of "Columns" and the number of "Rows" records of the query you
want to view.
Instance - specifies the SQL Server instance on the target host the query
is sent to. If you wish to query the default server instance, leave this
field blank.
User - can be an SQL Server user on the target host, or may take the
form of "domain\user" for a domain login. Leave it blank to use integ-
rated authentication. The specified user must have dbreader privileges
to the database.
Filename: com.dartware.cmd.sql_query.txt
Version: 1.4
Back to Top
Nagios NRPE
The NRPE daemon uses a configuration file (nrpe.cfg) that has command
definition entries in this form:
- 503 -
Servers-Proprietary
command[check_swap]=/usr/local/nagios/libexec/check_swap -
w 20% -c 10%
When the NRPE daemon receives a request to run the "check_swap" plu-
gin, it issues the command above.
Parameters
Nagios Plugin - tells which plugin to execute. It must match one of the
command definitions in the nrpe.cfg file (the text within square brackets
[ ... ]). To test the connection from InterMapper to the NRPE daemon, set
Nagios Plugin to the value "_NRPE_CHECK".
For information about installing an NRPE daemon, see the NRPE Docu-
mentation (at http://nagios.sourceforge.net/docs/nrpe/NRPE.pdf), espe-
cially the section on Remote Host Configuration. Nagios and the Nagios
logo are registered trademarks of Ethan Galstad. For more information,
see http://www.nagios.org.
Filename: com.dartware.tcp.nrpe.txt
Version: 1.2
Back to Top
- 504 -
Chapter 13: Probe Reference
Servers-Standard
l Servers Standard > Basic TCP (Blocked) (Pg 506)
l Servers Standard > Basic TCP (Pg 506)
l Servers Standard > Custom TCP (Pg 506)
l Servers Standard > CVS Server (Pg 507)
l Servers Standard > DHCPv4/BOOTP (Pg 507)
l Servers Standard > Domain Name (DNS) > DNS: (A) Address (Pg 508)
l Servers Standard > Domain Name (DNS) > DNS: (MX) Mail Server (Pg 509)
l Servers Standard > Domain Name (DNS) > DNS: (NS) Name Server (Pg 510)
l Servers Standard > Domain Name (DNS) > DNS: (PTR) Reverse Lookup (Pg
510)
l Servers Standard > Domain Name (DNS) > DNS: (TXT) Text Record (Pg 511)
l Servers Standard > FTP > FTP (Login) (Pg 512)
l Servers Standard > FTP > FTP (No Login) (Pg 512)
l Servers Standard > Gopher (Pg 513)
l Servers Standard > Host Resources (Pg 513)
l Servers Standard > HTTP & HTTPS > HTTP (Don't Match) (Pg 514)
l Servers Standard > HTTP & HTTPS > HTTP (Follow Redirects) (Pg 515)
l Servers Standard > HTTP & HTTPS > HTTP (Post) (Pg 515)
l Servers Standard > HTTP & HTTPS > HTTP (Proxy) (Pg 516)
l Servers Standard > HTTP & HTTPS > HTTP (Redirect) (Pg 517)
l Servers Standard > HTTP & HTTPS > HTTP (Pg 518)
l Servers Standard > HTTP & HTTPS > HTTPS (Follow Redirects) (Pg 518)
l Servers Standard > HTTP & HTTPS > HTTPS (Post) (Pg 519)
l Servers Standard > HTTP & HTTPS > HTTPS (Redirect) (Pg 520)
l Servers Standard > HTTP & HTTPS > HTTPS (SSLv3) (Pg 521)
l Servers Standard > HTTP & HTTPS > HTTPS (Pg 522)
l Servers Standard > IPMI v2.0 (Pg 522)
l Servers Standard > IRC (Pg 523)
l Servers Standard > LDAP > LDAP SSL (Pg 523)
l Servers Standard > LDAP > LDAP (Pg 524)
l Servers Standard > LPR (Pg 524)
l Servers Standard > Mail > IMAP4 SSL (Pg 525)
l Servers Standard > Mail > IMAP4 (Pg 525)
l Servers Standard > Mail > POP3 SSL (Pg 525)
l Servers Standard > Mail > POP3 (Pg 526)
l Servers Standard > Mail > Roundtrip IMAP (Pg 526)
l Servers Standard > Mail > Roundtrip POP (Pg 527)
l Servers Standard > Mail > SMTP TLS (Pg 528)
l Servers Standard > Mail > SMTP (Pg 528)
l Servers Standard > Multimedia > Multicast Listener (Pg 529)
l Servers Standard > Multimedia > RTSP (Pg 529)
l Servers Standard > Network Time (Pg 530)
l Servers Standard > NNTP (Pg 530)
l Servers Standard > RADIUS (Pg 530)
l Servers Standard > SIP over UDP (Pg 531)
l Servers Standard > SNPP (Pg 531)
l Servers Standard > SSH (Pg 532)
l Servers Standard > Subversion > SVN (Apache) (Pg 532)
l Servers Standard > Subversion > SVN (Svnserve) (Pg 533)
- 505 -
Servers-Standard
This basic TCP probe tests that a TCP port is not accepting connections.
This probe may be used to test that a firewall is working properly, or that
a particular TCP service is never operating on an important machine.
If the specified port accepts the TCP connection, the device state is set to
the selected state. Otherwise, the device status is set to OKAY.
Filename: com.dartware.tcp.blocked
Version: 1.5
Back to Top
Basic TCP
This basic TCP probe tests whether a TCP port accepts connections. If the
specified port fails to accept the TCP connection within sixty seconds, the
device state is set to Down.
Filename: com.dartware.tcp.basic
Version: 1.5
Back to Top
Custom TCP
This probe sends the specified string over a TCP connection, and sets the
status of the device based on the response. Six parameters control the
operation of this probe:
String to send - The initial string sent to the device via TCP. This could be
a command which indicates what to test, or a combination of a command
and a password. The string is sent on its own line, terminated by a CR-
LF.
- 506 -
Chapter 13: Probe Reference
Filename: com.dartware.tcp.custom
Version: 1.9
Back to Top
CVS Server
This probe tests a CVS server by connecting to the specified port and
authentication strings as shown below. By default, the port is 2401.
BEGIN AUTH REQUEST<lf>
CVSROOT_Path<lf>
Username<lf>
Scrambled_password<lf>
If the response is "I HATE YOU", then either the authentication failed or
the path to CVSROOT is incorrect.
Filename: com.dartware.tcp.cvs
Version: 1.6
Back to Top
DHCPv4/BOOTP
- 507 -
Servers-Standard
Note: On Mac OS X, this probe will only work if no DHCP, Bootp, or PPP
interfaces are enabled.
BOOTP Relay Address - the IP address to which all DHCP requests are
addressed. Normal BOOTP/DHCP requests are broadcast to the local sub-
net (255.255.255.255), where they are picked up by the BOOTP agent in
a router and relayed to the BOOTP/DHCP server. If this parameter is left
blank, InterMapper sends the DHCP requests directly to the device's IP
address.
DHCP Message Type - the type of DHCP message to send. Typically, you
should use DHCP-INFORM, since this type will not cause the DHCP server
to allocate an IP address. A DHCP server may respond to a DHCP-
DISCOVER request by leasing an IP address which will never be used.
Filename: com.dartware.dhcp
Version: 2.0
Back to Top
Servers Standard > Domain Name (DNS) > DNS: (A) Address
- 508 -
Chapter 13: Probe Reference
Domain Name - the fully qualified domain name you are attempting to
resolve.
Recursion Desired - If the target DNS server cannot resolve the given
domain name, and this parameter is True, the DNS server may query an
authoritative DNS server. To prevent this behavior, use the default set-
ting of False.
Failure Status - the device status InterMapper should report when the IP
address in a DNS response doesn't match the specified IP Address para-
meter. By default, an IP address mismatch sets the device to Alarm.
(Down is reserved for complete lack of response by the DNS server.)
Filename: com.dartware.dns
Version: 1.8
Back to Top
Servers Standard > Domain Name (DNS) > DNS: (MX) Mail Server
Mail Server - optional - specify a mail server the domain name should
resolve to. If this parameter is non-empty, and one of the returned mail
servers doesn't match the one provided, a status as specified in Failure
Status is returned.
Recursion Desired - If the target DNS server cannot resolve the given
domain name, and this parameter is True, the DNS server may query an
authoritative DNS server. To prevent this behavior, use the default set-
ting of False.
Failure Status - specifies the device status returned when the DNS
response returns a mail server that doesn't match the specified Mail
Server. You can choose Down, Alarm or Warning. By default, mail
server mismatches return an Alarm condition; Down is reserved for
when the DNS server fails to respond at all.
- 509 -
Servers-Standard
Filename: com.dartware.dns.mx
Version: 1.1
Back to Top
Servers Standard > Domain Name (DNS) > DNS: (NS) Name Server
Name Server - optional - specify the name server the domain name
should resolve to. If this parameter is non-empty, and one of the
returned name servers doesn't match the one provided, a status as spe-
cified in Failure Status is returned.
Recursion Desired - If the target DNS server cannot resolve the given
domain name, and this parameter is True, the DNS server may query an
authoritative DNS server. To prevent this behavior, use the default set-
ting of False.
Failure Status - specifies the device status returned when the DNS
response returns a name server that doesn't match the specified Name
Server. You can choose Down, Alarm or Warning. By default, name
server mismatches return an Alarm condition; Down is reserved for
when the DNS server fails to respond at all.
Filename: com.dartware.dns.ns
Version: 1.1
Back to Top
Servers Standard > Domain Name (DNS) > DNS: (PTR) Reverse Lookup
Parameters
- 510 -
Chapter 13: Probe Reference
Recursion Desired - If the target DNS server cannot resolve the given
domain name, and this parameter is True, the DNS server may query an
authoritative DNS server. To prevent this behavior, use the default set-
ting of False.
Failure Status - specifies the device status returned when the DNS
response returns a domain name that doesn't match the specified
Domain Name. You can choose Down, Alarm or Warning. By default,
mail server mismatches return an Alarm condition; Down is reserved
for when the DNS server fails to respond at all.
Filename: com.dartware.dns.ptr
Version: 1.2
Back to Top
Servers Standard > Domain Name (DNS) > DNS: (TXT) Text Record
Parameters
Recursion Desired - If the target DNS server cannot resolve the given
domain name, and this parameter is True, the DNS server may query an
authoritative DNS server. To prevent this behavior, use the default set-
ting of False.
Failure Status - specifies the device status returned when the DNS
response text record in a DNS response doesn't contain the specified
Text Substring. You can choose Down, Alarm or Warning. By default,
mail server mismatches return an Alarm condition; Down is reserved
for when the DNS server fails to respond at all.
Filename: com.dartware.dns.txt
Version: 1.2
- 511 -
Servers-Standard
Back to Top
FTP (Login)
This TCP probe connects to the FTP server's control port (21). It then
logs in using the specified User ID and Password and issues a NOOP com-
mand. If the connection is successful, the probe issues the QUIT com-
mand and sets the status to Okay.
Parameters
Password - the account password used to verify the User ID's identity.
Note: If the probe queries the FTP server often, and at regular intervals,
the FTP server's log files contain a succession of "Login" and "Logout" log
lines.
Filename: com.dartware.tcp.ftp.login
Version: 1.9
Back to Top
This TCP script connects to the FTP server's control port (21). It then
issues a NOOP command without logging in. If the connection is suc-
cessful, the probe issues the QUIT command and sets the status to
Okay.
Note: Use this script if you are going to be probing the FTP server fre-
quently. Unlike the FTP (login) probe, this probe does generate numer-
ous entries in your FTP logs.
Parameters
None.
Filename: com.dartware.tcp.ftp.nologin
Version: 1.9
- 512 -
Chapter 13: Probe Reference
Back to Top
Gopher
The document search and retrieval protocol described in RFC 1436. The
default TCP port number for Gopher connections is port 70.
This script connects to a Gopher server and sends the specified Selector
string. By default, the Selector string is empty; the Gopher server
returns top level information as a sequence of lines. This script simply
checks that data is returned by the gopher server; it does not validate
the data's contents.
Selector string - the string sent to the Gopher server. By default, this
string is empty.
Filename: com.dartware.tcp.gopher
Version: 1.6
Back to Top
Host Resources
This probe uses SNMP to monitor elements of the Host Resources MIB of
the target device.
Parameters
- 513 -
Servers-Standard
Ignore storage table indices After the device is polled, select the storage
table entries you want to ignore. The selected entries do not cause
alarms or warnings and are not be displayed in the Status window.
Filename: com.dartware.snmp.hrmib
Version: 1.13
Back to Top
Servers Standard > HTTP & HTTPS > HTTP (Don't Match)
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTP con-
nections is port 80.
This TCP probe lets you download a specific web page and scan it for a
specific string of HTML. If the string is present, then the device goes to a
warning state.
Host Name - the domain name of the web server (e.g. "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. Only enter an IP address or domain name; do
not add "http://".
URL Path - the full path of the desired file on the web server (e.g. "/in-
dex.html"). This can be empty to get to the root page of the site.
User ID - the user name typed into the web browser's password dialog.
Set this parameter to test a web page that requires authentication.
Password - the password for the web browser's dialog. Set this para-
meter to test a web page that requires authentication.
Filename: com.dartware.tcp.http-nomatch.txt
Version: 2.5
- 514 -
Chapter 13: Probe Reference
Back to Top
Servers Standard > HTTP & HTTPS > HTTP (Follow Redirects)
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTP con-
nections is port 80.
This TCP probe lets you download a specific web page and scan it for a
specific string of HTML. This probe will follow a limited number of page
redirects to the same HTTP server.
Parameters
Host Name - the domain name of the web server (Example: "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. You must enter a valid Host Name to test a
web server that implements a virtual host. Add only an IP address or
domain name; do not add "http://".
URL Path - the full path of the desired file on the web server (Example:
"/index.html"). This can be empty to request the root page of the site.
User ID - the user name typed into the web browser's password dialog.
Leave this blank unless you want to test a web page that requires authen-
tication.
Password - the password for the web browser's dialog. Leave this blank
unless you want to test a web page that requires authentication.
Filename: com.dartware.tcp.http.follow
Version: 1.3
Back to Top
HTTP (Post)
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTP con-
nections is port 80.
This TCP probe lets you post form results to a specific web CGI and
verify that the POST operation worked.
- 515 -
Servers-Standard
Parameters
Host Name - the domain name of the web server (e.g. "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. Only enter an IP address or domain name; do
not add "http://".
URL Path - the full path to the desired CGI on the web server (e.g. "/in-
dex.cgi"). This can be empty to get to the root page of the site.
Form Data - the encoded data sent in the body of the POST message.
Filename: com.dartware.tcp.http.cgi.post
Version: 2.8
Back to Top
HTTP (Proxy)
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTP con-
nections is port 80.
This TCP probe lets you test that a web server can be accessed using a
remote proxy server as an intermediary. For example, this probe can
check if your web server is accessible from some remote location on the
Internet.
Parameters
Host Name - the domain name of the web server (example: "www.in-
termapper.com"). This is the host name part of the URL that you want to
test.
Note: The host name is likely to be different from that of the actual
device on the map. If the host name is not specified, the probe assumes
it is included in the URL Path, and no adjustment to the path is made.
URL Path - the relative URI of the desired file on the web server (e.g.
"/index.html"). This can be empty to get to the root page of the site. If
Host Name is empty, this should contain the absolute URI.
- 516 -
Chapter 13: Probe Reference
Proxy User ID - your user ID for the proxy server. Leave this field blank
if no authentication is required to use the proxy server.
Proxy Password - your password for the proxy server. Leave this field
blank if no authentication is required to use the proxy server.
User Agent - the string that identifies this InterMapper client probe to the
proxy web server. Some proxy servers block traffic at the proxy based
on the User-Agent identity. This parameter lets you override Inter-
Mapper's default User-Agent setting. Leave this parameter blank to send
a User-Agent string of "InterMapper/version", where version is the cur-
rent version number of InterMapper.
Filename: com.dartware.tcp.http.proxy
Version: 2.12
Back to Top
HTTP (Redirect)
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTP con-
nections is port 80.
This TCP probe lets you test that a web server is redirecting certain
URL's to a specific URL.
Parameters
Host Name - the domain name of the web server (e.g. "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test.
URL Path - the full path of the desired file on the web server (e.g. "/in-
dex.html"). This can be empty to get to the root page of the site.
Redirect URL - the complete URL that the given URL Path is redirected to.
The URL should begin with "http://".
User ID - the user name typed into the web browser's password dialog.
Set this parameter to test a web page that requires authentication.
Password - the password for the web browser's dialog. Set this para-
meter if you want to test a web page that requires authentication.
- 517 -
Servers-Standard
Filename: com.dartware.tcp.http.redirect
Version: 1.15
Back to Top
HTTP
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTP con-
nections is port 80.
This TCP probe lets you download a specific web page and scan it for a
specific string of HTML.
Parameters
Host Name - the domain name of the web server (e.g. "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. Only add an IP address or domain name; do
not add "http://".
URL Path - the full path of the desired file on the web server (e.g. "/in-
dex.html"). This can be empty to get to the root page of the site.
String to verify - the string to verify in the data returned by the HTTP
server. For example, if you are retrieving a web page, you might search
for "<HTML" or "<P>" to verify that the data is HTML. If this string is not
found, the device will go into alarm.
User ID - the user name typed into the web browser's password dialog.
The default is to leave this blank. You should set this parameter if you
want to test a web page that requires authentication.
Password - the password for the web browser's dialog. The default is to
leave this blank. Set this parameter if you want to test a web page that
requires authentication.
Filename: com.dartware.tcp.http
Version: 2.12
Back to Top
Servers Standard > HTTP & HTTPS > HTTPS (Follow Redirects)
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTPS con-
nections is port 443.
- 518 -
Chapter 13: Probe Reference
This TCP probe lets you download a specific web page and scan it for a
specific string of HTML. This probe will follow a limited number of page
redirects to the same HTTPS server.
Parameters
Host Name - the domain name of the web server (Example: "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. You must enter a valid Host Name to test a
web server that implements a virtual host. Add only an IP address or
domain name; do not add "http://".
URL Path - the full path of the desired file on the web server (Example:
"/index.html"). This can be empty to get to the root page of the site.
User ID - the user name typed into the web browser's password dialog.
Set this parameter to test a web page that requires authentication.
Password - the password for the web browser's dialog. Set this para-
meter to test a web page that requires authentication.
Filename: com.dartware.tcp.https.follow
Version: 1.2
Back to Top
HTTPS (Post)
The protocol used for secure transfer of web pages on the World Wide
Web. The default TCP port number for HTTPS connections is port 443.
This TCP probe lets you post form results to a specific web CGI over a
secure connection and verify that the POST operation worked.
Parameters
Host Name - the domain name of the web server (Example: "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. You must enter a valid Host Name to test a
web server that implements a virtual host. Add only an IP address or
domain name; do not add "http://".
URL Path - the full path to the desired CGI on the web server (e.g. "/in-
dex.cgi"). This can be empty to get to the root page of the site.
Form Data - the encoded data sent in the body of the POST message.
- 519 -
Servers-Standard
Filename: com.dartware.tcp.https.cgi.post
Version: 1.14
Back to Top
HTTPS (Redirect)
The protocol used to transfer web pages on the World Wide Web, defined
in RFC 2068 and RFC 1945. The default TCP port number for HTTP con-
nections is port 80.
This TCP probe lets you test that a web server is redirecting certain
URL's to a specific URL.
Parameters
Host Name - the domain name of the web server (Example: "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. You must enter a valid Host Name to test a
web server that implements a virtual host. Add only an IP address or
domain name; do not add "http://".
URL Path - the full path of the desired file on the web server (Example:
"/index.html"). This can be empty to get to the root page of the site.
Redirect URL - the complete URL that the given URL Path is redirected to.
The URL should begin with "https://".
User ID - the user name typed into the web browser's password dialog.
Set this parameter to test a web page that requires authentication.
Password - the password for the web browser's dialog. Set this para-
meter to test a web page that requires authentication.
Filename: com.dartware.tcp.https.redirect.txt
Version: 1.5
Back to Top
- 520 -
Chapter 13: Probe Reference
HTTPS (SSLv3)
The protocol used for secure transfer of web pages on the World Wide
Web. The default TCP port number for HTTP connections is port 443.
The protocol used for secure transfer of web pages on the World Wide
Web. The default TCP port number for HTTP connections is port 443.
This probe lets you establish a secure connection to a web server, down-
load a specific web page, and scan it for a specific string of HTML. Unlike
the default HTTPS probe, this probe will not attempt to auto-negotiate a
TLSv1 connection, making it compatible with some older application serv-
ers.
Parameters
Host Name - the domain name of the web server (Example: "www.in-
termapper.com"). This can be derived from the host name part of the
URL that you want to test. You must enter a valid Host Name to test a
web server that implements a virtual host. Add only an IP address or
domain name; do not add "http://".
URL Path - the full path of the desired file on the web server (Example:
"/index.html"). This can be empty to get to the root page of the site.
User ID - the user name typed into the web browser's password dialog.
Set this parameter to test a web page that requires authentication.
Password - the password for the web browser's dialog. Set this para-
meter to test a web page that requires authentication.
Filename: com.dartware.tcp.https.notls.txt
Version: 1.4
Back to Top
- 521 -
Servers-Standard
HTTPS
The protocol used for secure transfer of web pages on the World Wide
Web. The default TCP port number for HTTP connections is port 443.
Host Name - the domain name of the web server (e.g. "www.in-
termapper.com"). Use the host name part of the URL that you want to
test. You must enter a valid "Host Name" to test web servers which
implement virtual hosts.
URL Path - the full path of the desired file on the web server (e.g. "/in-
dex.html"). This can be empty to get to the root page of the site.
User ID - the login user name. Set this parameter to test a web page that
requires authentication.
Password - the login password. Set this parameter to test a web page
that requires authentication.
Filename: com.dartware.tcp.https
Version: 2.8
Back to Top
IPMI v2.0
Parameters
Dialect - The variant of the IPMI protocol. There are subtle differences in
implementations of IPMI in various products.
- 522 -
Chapter 13: Probe Reference
l To use this probe with an Apple XServe 2008 or earlier, set the "Dia-
lect" parameter to "XServe".
l For Dell Servers, the Apple XServe 2009, and any other product set
the "Dialect" parameter to "Other".
Filename: com.dartware.ipmi.txt
Version: 1.2
Back to Top
IRC
Filename: com.dartware.tcp.irc
Version: 1.6
Back to Top
LDAP-SSL
- 523 -
Servers-Standard
This probe connects to the LDAP server and binds using the designated
Bind Name. If a Bind Password is provided, this password is sent as clear
text to authenticate the probe.
Once logged in, the probe sends a SearchRequest for Field to Match
searching for an equality match of Name to Lookup, and counts the num-
ber of LDAP records returned.
If the Search Base field is specified, this value is used as the base of the
search. Otherwise, the Bind Name is used for the Base DN.
Filename: com.dartware.tcp.ldap.ssl
Version: 1.9
Back to Top
LDAP
This probe connects to the LDAP server and binds using the designated
Bind Name. If a Bind Password is provided, this password is sent as clear
text to authenticate the probe.
Once logged in, the probe sends a SearchRequest for Field to Match
searching for an equality match of Name to Lookup, and counts the num-
ber of LDAP records returned.
If the Search Base field is specified, this value is used as the base of the
search. Otherwise, the Bind Name is used for the Base DN.
Filename: com.dartware.tcp.ldap
Version: 1.9
Back to Top
LPR
The print server protocol used to print over a TCP/IP network, as defined
in RFC 1179. The default TCP port number for LPR connections is port
515.
Filename: com.dartware.tcp.lpr
Version: 1.7
Back to Top
- 524 -
Chapter 13: Probe Reference
IMAP4-SSL
This TCP script connects to the IMAP4 server and issues a CAPABILITY
command, a NOOP command, and finally terminates with a LOGOUT com-
mand. The script checks the server's response to the CAPABILITY com-
mand to verify that the server supports IMAP4 or IMAP4rev1.
Filename: com.dartware.tcp.imap4.ssl
Version: 1.7
Back to Top
IMAP4
This TCP script connects to the IMAP4 server and issues a CAPABILITY
command, a NOOP command, and finally terminates with a LOGOUT com-
mand. The script checks the server's response to the CAPABILITY com-
mand to verify that the server supports IMAP4 or IMAP4rev1.
Filename: com.dartware.tcp.imap4
Version: 1.7
Back to Top
POP3-SSL
If the "User Name" parameter is left empty, this probe verifies that the
server send "+OK" as its initial greeting, then immediately sends the
QUIT command.
Parameters
User Name - if left empty, the probe verifies that the server sends
"+OK" as its initial greeting, then immediately sends the QUIT
- 525 -
Servers-Standard
Use APOP if supported - By default, the probe uses the APOP command to
authenticate the user if the server supports it. To authenticate via USER
and PASS commands for a particular user, set this parameter to False.
Note: If APOP is not supported by the server, the Use APOP if supported
option has no effect.
Filename: com.dartware.tcp.pop3.ssl
Version: 2.7
Back to Top
POP3
If the "User Name" parameter is left empty, this probe verifies that the
server send "+OK" as its initial greeting, then immediately sends the
QUIT command.
By default, this probe will use the APOP command to authenticate the
user if the the APOP command is supported by the server. To authen-
ticate via USER and PASS commands for a particular user, set the "Use
APOP if supported" parameter to False.
l The "Use APOP if supported" option has no effect if APOP is not sup-
ported by the server.
Filename: com.dartware.tcp.pop3
Version: 2.6
Back to Top
Roundtrip-IMAP
This probe tests an IMAP server and measures the time it takes to send a
message (via SMTP) and retrieve it (via IMAP). It sends a short message
to the specified SMTP server, and continually attempts to retrieve the
- 526 -
Chapter 13: Probe Reference
message via IMAP from the device being tested. The probe alerts if the
server fails to respond properly or the round-trip time exceeds the spe-
cified timeout.
Parameters
SMTP Server - The server to receive the SMTP message. If left blank, the
device being tested is used as the target.
SMTP User and SMTP Password - optional - The user name and password
to be used when sending the message. Leave blank if not required.
IMAP User and IMAP Password - The user name and password used to
log into the IMAP server to retrieve the message.
Filename: com.dartware.email.imap.txt
Version: 1.4
Back to Top
Roundtrip-POP
This probe tests a POP server and measures the time it takes to send a
message (via SMTP) and retrieve it (via POP). It sends a short message
to the specified SMTP server, and continually attempts to retrieve the
message via POP from the device being tested. The probe alerts if the
server fails to respond properly or the round-trip time exceeds the spe-
cified timeout.
Parameters
SMTP Server - The server to receive the SMTP message. If left blank, the
device being tested is used as the target..
SMTP User and SMTP Password - optional - The user name and password
to be used for sending the message. Leave blank if not required.
POP User and POP Password - The user name and password used to log
into the POP server to retrieve the message.
- 527 -
Servers-Standard
Filename: com.dartware.email.pop.txt
Version: 1.4
Back to Top
SMTP-TLS
This probe tries to verify that a specified email address exists on the
SMTP server, using the VRFY command. It connects to the SMTP server,
introduces itself using the HELO command, then issues a VRFY command
for the specified email address. When it has received a response, the
script sends the QUIT command before closing its connection to the
server.
Filename: com.dartware.tcp.smtp.tls
Version: 1.8
Back to Top
SMTP
This probe tries to verify that a specified email address exists on the
SMTP server, using the VRFY command. It connects to the SMTP server,
introduces itself using the HELO command, then issues a VRFY command
for the specified email address. When it has received a response, the
script sends the QUIT command before closing its connection to the
server.
Filename: com.dartware.tcp.smtp
Version: 2.0
Back to Top
- 528 -
Chapter 13: Probe Reference
Multicast Listener
This probe lets you listen for UDP packets directed to a specific UDP port.
If you specify a multicast IP address, InterMapper will listen for packets
directed to that multicast address. This probe will change the device
status to the DOWN if a packet isn't received within specified number of
seconds (the default is 10 seconds).
The Multicast Listener probe can be used to verify that a multicast source
is broadcasting, for example, a live QuickTime broadcaster.
This probe does not inject any traffic into the network; it is passive only.
Verify Source Address lets you specify whether the probe should only
count packets from the IP address of the targeted device.
Filename: com.dartware.udplistener
Version: 2.0
Back to Top
RTSP
The protocol used to control real-time streams, defined in RFC 2326 and
RFC 1889. The default TCP port number for RTSP connections is port 554.
This TCP probe lets you check that the server is up and responding.
The specifics of the commands that the probe must send to the server
vary somewhat depending upon the version of RFC2326 that the server
implements. If the server you're monitoring implements RFC2326bis-02
or later, then set RFC2326bis-02 or later to "Yes". If you're not sure,
leave it set to "No". If the device goes into warning with the reason set to
"[RTSP] Unexpected response to PLAY command. (RTSP/1.0 460 Only
Aggregate Option Allowed)", then set it to "Yes".
Filename: com.dartware.tcp.rtsp
Version: 2.1
Back to Top
- 529 -
Servers-Standard
Network Time
Filename: com.dartware.ntp
Version: 1.5
Back to Top
NNTP
This script connects to the news server and uses the GROUP command to
ask for information about a specific newsgroup name. The script then
issues the QUIT command to tell the server it is closing the connection.
Filename: com.dartware.tcp.nntp
Version: 1.6
Back to Top
RADIUS
The official port number for RADIUS is 1812. Some RADIUS servers, how-
ever, use port number 1645 for historical reasons.
- 530 -
Chapter 13: Probe Reference
Password - The password for the specified user name. The password is
not sent in the clear; it is encrypted using the shared secret.
Filename: com.dartware.radius
Version: 1.8
Back to Top
Parameters
Filename: com.dartware.sip.txt
Version: 1.1
Back to Top
SNPP
- 531 -
Servers-Standard
Parameters
Filename: com.dartware.tcp.snpp
Version: 1.6
Back to Top
SSH
The protocol used for secure remote login. The default TCP port number
for SSH connections is port 22.
This probe opens a TCP connection to the specified port and looks for the
identification string that indicates an SSH server as specified in RFC
4253.
Parameters
Require SSH 2.0 - If set to true and the server doesn't require SSH 2.0,
the device is set to Alarm.
Filename: com.dartware.tcp.ssh.txt
Version: 1.4
Back to Top
SVN (Apache)
Parameters
Host Name - the domain name of the subversion server (e.g. "svn.-
collab.net"). Include only the IP address or domain name; do not include
"http://".
URL Path - the path to the repository. The first and last characters must
be a '/'.
- 532 -
Chapter 13: Probe Reference
Filename: com.dartware.tcp.svn.apache
Version: 1.1
Back to Top
SVN (Svnserve)
Parameters
Filename: com.dartware.tcp.svn.svnserve
Version: 1.1
Back to Top
- 533 -
Servers-Standard
Telnet
This probe lets you Telnet to a device, login with a name and password,
and optionally enter a command. This probe is specifically designed to
reject any Telnet options proffered by the Telnet server; the TCP con-
nection always remains in the base "network virtual terminal" state. This
probe lets you enter data at up to three prompts.
First Prompt is the string to match in the first prompt. (e.g. "Login:")
Reply #1 is your reply to the first prompt. (i.e. your response to the
"Login:" prompt)
Second Prompt is the string to match in the second prompt. (e.g. "Pass-
word:") If this parameter is empty, the probe ignores the prompt string
and it does not send its reply.
Reply #2 is your reply to the second prompt. (i.e. your response to the
"Password:" prompt.)
Third Prompt is the string to match in the third prompt. If this parameter
is empty, the probe ignores the prompt string and its reply.
Filename: com.dartware.tcp.telnet
Version: 1.7
Back to Top
VNC Server
- 534 -
Chapter 13: Probe Reference
Filename: com.dartware.tcp.vnc
Version: 1.7
Back to Top
- 535 -
WMI
WMI
l WMI > WMI CPU Utilization (Pg 536)
l WMI > WMI Disk Available (Pg 537)
l WMI > WMI Disk Fragmentation Analysis (Pg 537)
l WMI > WMI Event Log (Pg 538)
l WMI > WMI File Check (Pg 539)
l WMI > WMI Folder Check (Pg 540)
l WMI > WMI Free Memory (Pg 540)
l WMI > WMI Installed Software (Pg 541)
l WMI > WMI Logged on Users (Pg 542)
l WMI > WMI MSExchange 2007 Hub Transport Server (Pg 542)
l WMI > WMI MSExchange 2007 Mailbox Server (Pg 543)
l WMI > WMI Network Utilization (Pg 543)
l WMI > WMI Process Monitor (Pg 544)
l WMI > WMI Service Monitor (Pg 545)
l WMI > WMI SQL Server 2008 Service Monitor (Pg 545)
l WMI > WMI System Accessibility (Pg 546)
l WMI > WMI System Information (Pg 547)
l WMI > WMI Top Processes (Pg 547)
This probe uses WMI to retrieve the percentage of time that a processor
uses to execute a non-idle thread on the target host. Specifically, it quer-
ies the PercentProcessorTime property of the Win32_Per-
fFormattedData_PerfOS_Processor class and compares it against the
Warning and Critical parameters you set.
The target host must be running Windows XP, Windows Server 2003 or
later.
Parameters
Single Warning, Single Critical, Total Warning, and Total Critical - the
device's condition is set by comparing each processor against the spe-
cified Single percentages, and the total CPU utilization against the spe-
cified Total percentages. You can leave any of these values blank.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
- 536 -
Chapter 13: Probe Reference
Filename: com.dartware.wmi.cpu_utilization.txt
Version: 1.11
Back to Top
This probe uses WMI to determine the disk space available on the spe-
cified drive(s) on the target host. Specifically, it queries the Size and
FreeSpace properties of the Win32_LogicalDisk class, computes per-
centage free space, and compares it against the specified values. The tar-
get host must be running Windows 2000 or later.
Parameters
Drive - May be set to "All" to check disk space on all of the host
machine's local hard drives. Enter a list of comma-separated drive
names (including the colon). These drives will be listed regardless of
whether they are local hard drives. Zero-sized drives, such as an empty
cd-rom, are not listed. The first drive with space that is less than the spe-
cified values is cited in the reason.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Filename: com.dartware.wmi.disk_available.txt
Version: 1.10
Back to Top
This probe uses WMI to analyze disk fragmentation on a drive on the tar-
get host. Specifically, it calls the DefragAnalysis method of the Win32_
Volume class and reports pertinent statistics from the anaylsis. If the
drive needs to be defragmented, the device is set to Warning. The tar-
get host must be running Windows Vista, Windows Server 2003 or later.
Parameters
- 537 -
WMI
Drive - the drive letter assigned to the local disk to be analyzed, includ-
ing the colon but without backslashes.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.defrag_analysis.txt
Version: 1.10
Back to Top
This probe uses WMI to retrieve entries from the Event Logs on the tar-
get host. Specifically, it queries the Win32_NTLogEvent class, limiting
the search with the parameters you set. If matching events are found, a
critical status is returned. The target host must be running Windows 2000
or later.
Parameters
Hours, Minutes, and Seconds - combine to define how far back in the
event log to search. The specified values are subtracted from the current
time and used to select events, based on when they were written to the
log.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
- 538 -
Chapter 13: Probe Reference
Filename: com.dartware.wmi.event_log.txt
Version: 1.12
Back to Top
This probe uses WMI to retrieve information about files on the target
host. Specifically, it queries the CIM_DataFile class, limiting the search
with the parameters you set. The target host must be running Windows
2000 or later.
Parameters
Path - the location of the files to be checked. Include the drive, and
enclose the path in double-quotes if it contains spaces.
File - the filename and extension of the file you wish to check. The path
is prepended to filename during the final query. To check all files that
met the specified Size or time criteria, leave this parameter blank. You
may also use a list of comma-separated filenames.
Size - the minimum filesize in bytes. Any file larger than this value is lis-
ted.
Hours, Minutes and Seconds - specify how recently the file was changed
in order to be listed, based on the file's LastModified value. At least one
of these parameters must be set.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.file_check.txt
Version: 1.10
Back to Top
- 539 -
WMI
This probe uses WMI to retrieve information about a folder on the target
host. Specifically, it queries the Win32_Directory and CIM_DataFile
classes to walk the directory tree, accumulating file and folder counts
and the total of file sizes. It also notes the most recently modified file in
the tree. The target host must be running Windows 2000 or later.
Parameters
Path - specifies the folder at the top of the tree you want to check. It
should include the drive, and should be enclosed in double-quotes if it
contains spaces.
Warning and Critical - set thresholds for the number of folders, the num-
ber of files, and the total of the file sizes.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.folder_check.txt
Version: 1.12
Back to Top
This probe uses WMI to retrieve the amount of physical memory avail-
able to processes running on the target host, in megabytes. Specifically,
it queries the TotalPhysicalMemory property of the Win32_Com-
puterSystem class. It also queries the FreePhysicalMemory property of
the Win32_OperatingSystem class and compares it against specified
thresholds. The target host must be running Windows 2000 or later.
Parameters
- 540 -
Chapter 13: Probe Reference
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.free_memory.txt
Version: 1.9
Back to Top
The target host must be running Windows XP, Windows Server 2003 or
later. On Windows Server 2003, the Win32_Product class isn't always
installed by default. You can install the "WMI Windows Installer Provider"
component under "Management and Monitoring Tools" in "Add/Remove
Windows Components".
Parameters
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.installed_software.txt
Version: 1.6
Back to Top
- 541 -
WMI
This probe uses WMI to retrieve information about users logged on to the
target host. Specifically, it queries the LogonType and StartTime prop-
erties of the Win32_LogonSession class, limiting the selection to those in
the comma-separated list of numeric Logon Types you set in the Type
parameter. It queries instances of the Win32_LoggedOnUser class,
matches the LogonID and extracts the user's name and domain from the
path of the Win32_Account. The target host must be running Windows
XP, Windows Server 2003 or later.
Parameters
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.logged-on_users.txt
Version: 1.12
Back to Top
This probe uses WMI to retrieve performance information about the deliv-
ery queues on a MS Exchange 2007 Hub Transport Server. Specifically, it
queries the Win32_PerfFormattedData_MSExchangeTransportQueues_
MSExchangeTransportQueues class to collect a variety of queue statistics
and then compares them to the criteria you set. The default criteria for
warning and critical conditions are taken from the Microsoft TechNet art-
icle Monitoring Hub Transport Servers.
Parameters
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
- 542 -
Chapter 13: Probe Reference
Filename: com.dartware.wmi.ex07_transport_server.txt
Version: 1.5
Back to Top
This probe uses WMI to retrieve performance information about the deliv-
ery queues on a MS Exchange 2007 Mailbox Server. Specifically, it quer-
ies the Win32_PerfFormattedData_MSExchangeIS_MSExchangeIS,
Win32_PerfFormattedData_MSExchangeIS_MSExchangeISMailbox,
Win32_PerfFormattedData_MSExchangeIS_MSExchangeISPublic,
Win32_PerfFormattedData_MSExchangeSearchIndices_MSEx-
changeSearchIndices classes to collect a variety of statistics and then
compares them to the criteria you set. The default criteria for warning
and critical conditions are taken from the Microsoft TechNet article Mon-
itoring Mailbox Servers.
Parameters
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.ex07_mailbox_server.txt
Version: 1.5
Back to Top
- 543 -
WMI
meters you set. The target host must be running Windows XP, Windows
Server 2003 or later.
Parameters
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.net_utilization.txt
Version: 1.11
Back to Top
Parameters
Warning and Critical - specify thresholds (in percent) for which the
device condition is set to the specified state.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
- 544 -
Chapter 13: Probe Reference
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.process_monitor.txt
Version: 1.12
Back to Top
This probe uses WMI to retrieve the state of services running on the tar-
get host by querying the Win32_Service class. Any specified services not
found are listed, and the status is set to Critical. The target host must be
running Windows 2000 or later.
Parameters
Note: Service names should not be confused with the service's Display
Name, shown in the Services tool. Check the Properties for the service to
find the actual service name. Names containing spaces or other special
characters should be enclosed in quotes.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.service_monitor.txt
Version: 1.13
Back to Top
This probe uses WMI to retrieve the state of Microsoft SQL Server 2008
services running on the target host by querying the Win32_Service class.
- 545 -
WMI
The states of the selected services are listed, and if any are not running,
the status of the device is set to Critical. The target host must be running
Windows 2000 or later.
Parameters
Instance - the SQL Server instance you wish to monitor on the target
host. To monitor the default instance, leave this parameter blank.
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.sql2k8_service_monitor.txt
Version: 1.5
Back to Top
This probe uses WMI to test accessibilty of a target device from the mon-
itored host. Specifically, it uses the Win32_PingStatus class to test the
connectivity and returns a chartable response time. If the target cannot
be pinged, the status is set to critical and a discontinuity is inserted in
the chart data. The target host must be running Windows XP, Windows
Server 2003 or later.
Parameters
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
- 546 -
Chapter 13: Probe Reference
Filename: com.dartware.wmi.system_accessibility.txt
Version: 1.10
Back to Top
This probe uses WMI to collect a variety of information about the mon-
itored host including hardware and operating system details. The target
host must be running Windows 2000 or later.
Parameters
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.system_infomation.txt
Version: 1.9
Back to Top
This probe uses WMI to retrieve information about CPU utilization and
processes running on the target host. Specifically, it queries the Per-
centProcessorTime property of the Win32_PerfFormattedData_PerfOS_
Processor class and compares it against the specified thresholds. It quer-
ies the PercentProcessorTime property of the Win32_Per-
fFormattedData_PerfProc_Process class and lists up to five processes
using the most CPU time. Because there is a time lapse between col-
lecting the CPU data and the process data, the reported values do not
add up exactly. The target host must be running Windows XP, Windows
Server 2003 or later.
Parameters
- 547 -
WMI
User - may be a local user on the target host, or can take the form
domain\user for a domain login. If authentication is not required (such
as when the target is localhost,) leave this parameter blank.
Timeout (sec) - the number of seconds to wait before assuming the host
is not available.
Filename: com.dartware.wmi.top_process.txt
Version: 1.11
Back to Top
- 548 -
Chapter 13: Probe Reference
Wireless
l Wireless > Alvarion > Alvarion B 14 & B 28 (BU) (Pg 550)
l Wireless > Alvarion > Alvarion B 14 & B 28 (RB) (Pg 551)
l Wireless > Alvarion > BreezeACCESS (AU) (Pg 551)
l Wireless > Alvarion > BreezeACCESS (SU) (Pg 552)
l Wireless > Alvarion > BreezeACCESS LB (Pg 552)
l Wireless > Alvarion > BreezeACCESS VL (AU) (Pg 553)
l Wireless > Alvarion > BreezeACCESS VL (SU) (Pg 553)
l Wireless > Atmel > Atmel AT76C510 (Pg 554)
l Wireless > Basic > IEEE 802.11 (Pg 555)
l Wireless > Basic > SNMP for Wireless (Pg 555)
l Wireless > Canopy > Canopy (AP) (Pg 555)
l Wireless > Canopy > Canopy (SM) (Pg 556)
l Wireless > Canopy > Canopy Backhaul (45 Mbps/FW 5830) (Pg 557)
l Wireless > Canopy > Canopy Backhaul (60 Mbp/FW 5840) (Pg 557)
l Wireless > Canopy > Canopy Backhaul (Master) (Pg 558)
l Wireless > Canopy > Canopy Backhaul (Slave) (Pg 558)
l Wireless > Canopy > Canopy CMM Micro (Pg 559)
l Wireless > CB3 > CB3 Bridge (Pg 559)
l Wireless > CB3 > CB3 Deluxe Bridge (Pg 559)
l Wireless > Inscape Data > AirEther AB54 Series AP (AP Mode) (Pg 560)
l Wireless > Inscape Data > AirEther AB54 Series AP (Bridge Mode) (Pg 560)
l Wireless > Inscape Data > AirEther AB54 Series AP (Client Mode) (Pg 561)
l Wireless > Inscape Data > AirEther AB54 Series AP (Repeater Mode) (Pg 561)
l Wireless > Inscape Data > AirEther CB54 Series Client (Pg 562)
l Wireless > MikroTik > MT Radio Uplink (Pg 562)
l Wireless > MikroTik > MT Routerboard (Pg 563)
l Wireless > MikroTik > MT Software Only (Pg 564)
l Wireless > MikroTik > WDS Bridge (Pg 564)
l Wireless > Motorola > PTP 400 Series Bridge (Pg 565)
l Wireless > Motorola > PTP 600 Series Bridge (Pg 566)
l Wireless > Orthogon > Gemini (Pg 566)
l Wireless > Orthogon > Spectra (Pg 567)
l Wireless > Other > HTTP (Pg 567)
l Wireless > Proxim > Proxim AP 2000 (Pg 568)
l Wireless > Proxim > Proxim AP 4000 (Pg 569)
l Wireless > Proxim > Proxim AP 600 (Pg 569)
l Wireless > Proxim > Proxim AP 700 (Pg 570)
l Wireless > Proxim > Proxim LAN Access Point (Pg 570)
l Wireless > Proxim > Tsunami GX (Pg 571)
l Wireless > Proxim > Tsunami MP.11 BSU (Pg 572)
l Wireless > Proxim > Tsunami MP.11 SU (Pg 572)
l Wireless > Redline > AN50 (Pg 573)
l Wireless > smartBridges > airBridge (Pg 574)
l Wireless > smartBridges > airClient Nexus PRO total (Pg 574)
l Wireless > smartBridges > airClient Nexus (Pg 575)
l Wireless > smartBridges > airHaul Nexus PRO total (Pg 575)
l Wireless > smartBridges > airHaul Nexus (Pg 576)
l Wireless > smartBridges > airHaul2 Nexus PRO (Pg 577)
l Wireless > smartBridges > airPoint Nexus PRO total (Pg 577)
- 549 -
Wireless
This probe monitors an Alvarion B-14 or B-28 base unit (BU). It retrieves
and displays the radio band, operating frequency, and slave association.
It will go into an alarm when no slave is associated, and when the oper-
ating frequency doesn't match the configured frequency. Traffic inform-
ation is available for the ethernet and radio interfaces. (To show the
ethernet interface, we recommend using the "Display unnumbered inter-
faces" behavior.)
Parameters
None.
Filename: com.dartware.wrls.alvarion.b14.master.txt
Version: 0.5
Back to Top
- 550 -
Chapter 13: Probe Reference
This probe monitors an Alvarion B-14 or B-28 remote bridge (RB) unit. It
retrieves and displays the radio band, operating frequency, average
received signal to noise ratio, and the MAC address of the associated
base unit (BU). It will go into alarm or warning states based on user-
defined parameters for a low signal to noise ratio or high traffic on a spe-
cified interface.
Parameters
Avg Receive SNR too low alarm, Avg Receive SNR low warning,
High Traffic Interface Number - enter the number of the interface for
which you want to monitor traffic.
Filename: com.dartware.wrls.alvarion.b14.slave.txt
Version: 0.5
Back to Top
BreezeACCESS (AU)
Parameters
High Traffic Interface Number - enter the number of the interface for
which you want to monitor traffic.
- 551 -
Wireless
Filename: com.dartware.wrls.alvarionbaau.txt
Version: 1.7
Back to Top
BreezeACCESS (SU)
Parameters
High Traffic Interface Number - enter the number of the interface for
which you want to monitor traffic.
Filename: com.dartware.wrls.alvarionbasu.txt
Version: 1.7
Back to Top
BreezeACCESS LB
Parameters
SNR too low alarm, SNR low warning - enter thresholds for Warning and
Alarm.
Filename: com.dartware.wrls.alvarionbalb.txt
Version: 0.16
- 552 -
Chapter 13: Probe Reference
Back to Top
BreezeACCESS VL (AU)
Parameters
Filename: com.dartware.wrls.alvarionbavlau.txt
Version: 1.7
Back to Top
BreezeACCESS VL (SU)
Parameters
Avg Receive SNR too low alarm, Avg Receive SNR low warning,
High Traffic Interface Number - enter the number of the interface for
which you want to monitor traffic.
Filename: com.dartware.wrls.alvarionbavlsu.txt
Version: 1.7
Back to Top
- 553 -
Wireless
Atmel AT76C510
This probe monitors devices based on the Atmel AT76C510 chip. Please
refer to your device's technical specification to find out the chip type.
Sample devices based on AT76C510 chip are as follows: Belkin F5D6130,
D-Link DWL 900AP (rev. 1), Netgear ME102, and Linksys WAP11 (ver <
2).
It retrieves and displays information from the AT76C510 MIB using SNMP
v1. Depending on the brige's operating mode this probe will display dif-
ferent information.
This probe may not return complete information to SNMPv1 clients using
the community string "public". To fully utilize this probe, you must set
the community string to the one with the correct permissions.
Parameters
Link to Device Management Tool - enter the URL to the web manager for
this device.
Filename: com.dartware.wrls.AT76C510.txt
Version: 1.5
Back to Top
- 554 -
Chapter 13: Probe Reference
IEEE 802.11
This probe monitors 802.11 counters from a wireless device that sup-
ports the IEEE802dot11-MIB.
Parameters
Filename: com.dartware.wrls.80211counters.txt
Version: 0.2
Back to Top
This is a general probe for monitoring wireless gear for which there is no
specific InterMapper probe, but that supports SNMP MIB-2. This probe
will gather general traffic information, network connections, etc. It also
adds an alarm when traffic on a user-selected interface reaches spe-
cified levels.
Parameters
High Traffic Bytes alarm, High Traffic Bytes warning - enter thresholds
for Warning and Alarm.
Filename: com.dartware.wrls.generic.txt
Version: 1.4
Back to Top
Canopy (AP)
This probe monitors a Canopy wireless access point (AP), including basic
information, traffic information, and the number of clients associated. It
places the device into alarm or warning when the number of clients
exceeds the user-defined thresholds.
The default poll interval for this probe is 5 minutes. The default poll inter-
val is an automatic safeguard; polling more frequently has been shown
to adversely affect the device.
- 555 -
Wireless
Parameters
Filename: com.dartware.wrls.canopyap.txt
Version: 1.9
Back to Top
Canopy (SM)
This probe retrieves and displays a number of variables. It will place the
device in alarm or warning states based on user-defined thresholds for
high re-registration count, low RSSI, high Jitter, long Round Trip delay,
and low Power Level, and give an alarm if the unit is not registered.
Note that the 2x jitter thresholds will only be used when the SM is oper-
ating in 2x/2x mode.
The default poll interval for this probe is 5 minutes. The default poll inter-
val is an automatic safeguard; polling more frequently has been shown
to adversely affect the device.
Parameters
Filename: com.dartware.wrls.canopysm.builtin.txt
Version: 1.6
- 556 -
Chapter 13: Probe Reference
Back to Top
Parameters
Filename: com.dartware.wrls.canopy.backhaul45old.txt
Version: 1.7
Back to Top
Parameters
- 557 -
Wireless
Filename: com.dartware.wrls.canopy.backhaul45.txt
Version: 1.9
Back to Top
The default poll interval for this probe is 5 minutes. The default poll inter-
val is an automatic safeguard; polling more frequently has been shown
to adversely affect the device.
Parameters
None.
Filename: com.dartware.wrls.canopybhm.txt
Version: 1.4
Back to Top
The default poll interval for this probe is 5 minutes. The default poll inter-
val is an automatic safeguard; polling more frequently has been shown
to adversely affect the device.
Parameters
- 558 -
Chapter 13: Probe Reference
Filename: com.dartware.wrls.canopybhs.txt
Version: 1.4
Back to Top
Canopy CMM-Micro
Parameters
None.
Filename: com.dartware.wrls.canopy.cmmmicro.txt
Version: 0.5
Back to Top
CB3 Bridge
This TCP probe queries a CB3 wireless bridge via a HTTP GET request.
Parameters
Quality Warning, Quality Alarm - enter thresholds (in percent) for Warn-
ing and Alarm.
Filename: com.dartware.wrls.cb3.old.txt
Version: 1.2
Back to Top
This TCP probe queries a CB3 Deluxe wireless bridge via a HTTP GET
request.
Parameters
- 559 -
Wireless
Filename: com.dartware.wrls.cb3.txt
Version: 1.5
Back to Top
Wireless > Inscape Data > AirEther AB54 Series AP (AP Mode)
This probe monitors Inscape Data's AB54, AB54E, AB54E Pro Mul-
tifunctional AP in Access Point Mode.
Parameters
Too Many Stations Warning >, Too Many Stations Alarm >,
Too Few Stations Warning <, Too Few Stations Alarm <
Filename: com.dartware.wrls.inscape.ab54.ap.txt
Version: 1.1
Back to Top
Wireless > Inscape Data > AirEther AB54 Series AP (Bridge Mode)
This probe monitors Inscape Data's AB54, AB54E, AB54E Pro Mul-
tifunctional AP in Point to Point or Point to Multipoint Bridge Mode.
Parameters
- 560 -
Chapter 13: Probe Reference
RSSI Warning <, RSSI Alarm < - enter thresholds for Warning and
Alarm.
Filename: com.dartware.wrls.inscape.ab54.bridge.txt
Version: 1.1
Back to Top
Wireless > Inscape Data > AirEther AB54 Series AP (Client Mode)
This probe monitors Inscape Data's AB54, AB54E, and AB54E Pro Mul-
tifunctional AP in Client Mode.
Parameters
Signal Strength Warning - the warning threshold for low signal strength
%.
Signal Strength Alarm - the alarm threshold for low signal strength %.
Link Quality Warning - the warning threshold for low link quality %.
Link Quality Alarm - the alarm threshold for low link quality %.
Filename: com.dartware.wrls.inscape.ab54.client.txt
Version: 1.1
Back to Top
Wireless > Inscape Data > AirEther AB54 Series AP (Repeater Mode)
This probe monitors Inscape Data's AB54, AB54E, AB54E Pro Mul-
tifunctional AP in Repeater Mode.
Parameters
- 561 -
Wireless
Too Many Stations Warning >, Too Many Stations Alarm >,
Too Few Stations Warning <, Too Few Stations Alarm <
Filename: com.dartware.wrls.inscape.ab54.repeater.txt
Version: 1.1
Back to Top
This probe monitors Inscape Data's CB54, CB54E, and CB5418 wireless
client device.
Parameters
Signal Strength Warning - the warning threshold for low signal strength
%.
Signal Strength Alarm - the alarm threshold for low signal strength %.
Link Quality Warning - the warning threshold for low link quality %.
Link Quality Alarm - the alarm threshold for low link quality %.
Filename: com.dartware.wrls.inscape.cb54.client.txt
Version: 1.1
Back to Top
MT Radio Uplink
This probe monitors a MikroTik router and its radio uplink interface. For
the AP it monitors general SNMP interface and traffic information, as
well as device utilization (CPU, Disk, Memory loads). For the radio uplink
interface it monitors name & ssid, frequency, tx/rx rates, strength, and
BSSID.
- 562 -
Chapter 13: Probe Reference
You must manually specify the OID index of the wireless uplink inter-
face. Using Telnet: 1) Login, 2) Enter "interface wireless print oid", 3)
The interface index is the last digit of the OIDs, 4) Type this number into
the "Wireless Interface" field below.
l High Use -- for CPU, Disk, or Memory loads exceeds 90% (default
setting of parameter).
Parameters
Filename: com.dartware.wrls.mt-1radio.txt
Version: 1.14
Back to Top
MT Routerboard
l High Use -- CPU Load, Disk use, or Memory use exceeding 90%.
l Unsafe Temperatures -- Safe ranges of -20°C to 50°C for Board &
Sensor temps., -20°C to 70°C for CPU temp.
l Unsafe Voltages -- Safe deviation of -/+ 5% for 12V & 5V, +/- 3%
for 3.3V and Core Voltage (either 1.8V or 2.0V).
Parameters
High & Low voltage thresholds - enter voltage values to trigger alarms,
or keep the default values.
- 563 -
Wireless
Filename: com.dartware.wrls.mt-routerboard.txt
Version: 1.6
Back to Top
MT Software Only
This probe monitors any device that uses MikroTik software (a wireless
access point), but does not monitor its wireless interfaces. It monitors
general SNMP interface and traffic information and device utilization:
CPU Load, Disk use, and Memory use (in percent).
l High Use -- CPU Load, Disk use, or Memory use exceeds 90%.
Parameters
Filename: com.dartware.wrls.mt-0radio.txt
Version: 1.5
Back to Top
WDS Bridge
This probe monitors a MikroTik router in WDS Bridge mode. The probe
monitors the Ethernet traffic information, as well as device utilization
(CPU, Disk, Memory loads). The probe also displays the signal strength
and tx/rx rates of the wireless link.
You must specify both the MAC address of the other AP, as well as the
ifIndex of the wireless interface. The MAC address must be entered as
six decimal numbers separated by "."
- 564 -
Chapter 13: Probe Reference
This probe will raise an alarm if the CPU, Disk, or Memory loads exceeds
the High Use Threshold.
Parameters
Associated AP MAC Adrs - the MAC address of Access Point to which the
router is connected.
Filename: com.dartware.wrls.mikrotik-wds.txt
Version: 1.3
Back to Top
Parameters
Filename: com.dartware.wrls.motorola.ptp400.txt
Version: 1.2
Back to Top
- 565 -
Wireless
Parameters
Filename: com.dartware.wrls.motorola.ptp600.txt
Version: 0.8
Back to Top
Gemini
Parameters
- 566 -
Chapter 13: Probe Reference
Filename: com.dartware.wrls.orthogon.gemini.txt
Version: 1.8
Back to Top
Spectra
Parameters
Filename: com.dartware.wrls.orthogon.spectra.txt
Version: 0.8
Back to Top
HTTP
This probe tests an HTTP server by downloading a specific web page and
scanning it for a specific string of HTML.
Parameters
URL Path - the full path of the desired file on the web server (e.g. "/in-
dex.html"). The first character must be a '/'.
- 567 -
Wireless
User ID - the user name you would type into the web browser's authen-
tication dialog. It this blank by default. Set this parameter to test a web
page that requires authentication.
Password - the password you would type into the web browser's authen-
tication dialog. It this blank by default. Set this parameter to test a web
page that requires authentication.
Filename: com.dartware.wrls.http.txt
Version: 1.5
Back to Top
Proxim AP-2000
Note: Some of the alarms/warnings of this probe will not function unless
the Proxim device is set to send traps to the InterMapper server.
Parameters
Filename: com.dartware.wrls.proximap2000.txt
Version: 1.4
Back to Top
- 568 -
Chapter 13: Probe Reference
Proxim AP-4000
Note: Some of the alarms/warnings of this probe will not function unless
the Proxim device is set to send traps to the InterMapper server.
Parameters
Filename: com.dartware.wrls.proximap4000.txt
Version: 1.4
Back to Top
Proxim AP-600
Note: Some of the alarms/warnings of this probe will not function unless
the Proxim device is set to send traps to the InterMapper server.
Parameters
- 569 -
Wireless
Filename: com.dartware.wrls.proximap600.txt
Version: 1.3
Back to Top
Proxim AP-700
Note: Some of the alarms/warnings of this probe will not function unless
the Proxim device is set to send traps to the InterMapper server.
Parameters
Filename: com.dartware.wrls.proximap700.txt
Version: 1.4
Back to Top
- 570 -
Chapter 13: Probe Reference
Note: Some of the alarms/warnings of this probe will not function unless
the Proxim device is set to send traps to the InterMapper server.
Parameters
Filename: com.dartware.wrls.proximap.txt
Version: 1.4
Back to Top
Tsunami GX
This probe sets the device to Alarm if the status of either of the device's
external inputs is in alarm. It also monitors the device's RFU status, IDU
and RFU temperatures, RFU cable status, IDU fan status, IDU syn-
thesizer status, RFU power status, RFU summary/minor relay status,
AIS injection status, link status, and the number of errors/sec.
The temperature warning and alarm threshold are used only if the Use
custom temperature threshold checkbox is selected.
Parameters
Use custom temperature threshold - check this to set your own tem-
perature thresholds.
- 571 -
Wireless
Filename: com.dartware.wrls.proximg4.txt
Version: 0.4
Back to Top
This probe monitors Proxim Tsunami MP.11 Base Station Unit (BSU).
This probe can be used to monitor all MP.11 models, including 2411,
2454-R, 5054, and 5054-R.
Note: Some of the alarms/warnings of this probe will not function unless
the Proxim device is set to send traps to the InterMapper server.
Parameters
Send retries pct high warning, Send retries pct too high alarm,
Send failures pct high warning, Send failures pct too high alarm,
Receive retries pct high warning, Receive retries pct too high alarm,
Receive failures pct high warning, Receive failures pct too high alarm,
Filename: com.dartware.wrls.proximtmpbsu.txt
Version: 1.2
Back to Top
Tsunami MP.11 SU
- 572 -
Chapter 13: Probe Reference
Note: Some of the alarms/warnings of this probe will not function unless
the Proxim device is set to send traps to the InterMapper server.
Parameters
Send retries pct high warning, Send retries pct too high alarm,
Send failures pct high warning, Send failures pct too high alarm,
Receive retries pct high warning, Receive retries pct too high alarm,
Receive failures pct high warning, Receive failures pct too high alarm,
Filename: com.dartware.wrls.proximtmprsu.txt
Version: 1.3
Back to Top
AN50
Parameters
Avg. Rx Signal strength too low alarm, Avg. Rx Signal strength low warn-
ing,
- 573 -
Wireless
Filename: com.dartware.wrls.redlinean50.txt
Version: 1.3
Back to Top
airBridge
Parameters
Link to Device Management Tool - the URL for the device's web manager.
Filename: com.dartware.wrls.airbridge.txt
Version: 1.5
Back to Top
Parameters
Frame errors (%) high warning, Frame errors (%) too high alarm
- 574 -
Chapter 13: Probe Reference
RTS errors (%) high warning, RTS errors (%) too high alarm
Filename: com.dartware.wrls.airclientnexuspro.txt
Version: 0.5
Back to Top
airClient Nexus
Parameters
Frame errors (%) high warning, Frame errors (%) too high alarm
RTS errors (%) high warning, RTS errors (%) too high alarm:
Filename: com.dartware.wrls.airclientnexus.txt
Version: 0.5
Back to Top
Parameters
- 575 -
Wireless
Frame errors (%) high warning, Frame errors (%) too high alarm,
RTS errors (%) high warning, RTS errors (%) too high alarm
Filename: com.dartware.wrls.airhaulnexuspro.txt
Version: 0.5
Back to Top
airHaul Nexus
Parameters
Frame errors (%) high warning, Frame errors (%) too high alarm,
RTS errors (%) high warning, RTS errors (%) too high alarm
Filename: com.dartware.wrls.airhaulnexus.txt
Version: 0.5
Back to Top
- 576 -
Chapter 13: Probe Reference
Parameters
Frame errors (%) high warning, Frame errors (%) too high alarm,
RTS errors (%) high warning,RTS errors (%) too high alarm
Filename: com.dartware.wrls.airhaul2nexuspro.txt
Version: 0.5
Back to Top
Parameters
Frame errors (%) high warning, Frame errors (%) too high alarm,
- 577 -
Wireless
RTS errors (%) high warning, RTS errors (%) too high alarm
Filename: com.dartware.wrls.airpointnexuspro.txt
Version: 0.5
Back to Top
airPoint Nexus
Parameters
Frame errors (%) high warning, Frame errors (%) too high alarm,
RTS errors (%) high warning, RTS errors (%) too high alarm
Filename: com.dartware.wrls.airpointnexus.txt
Version: 0.5
Back to Top
airPoint
- 578 -
Chapter 13: Probe Reference
This probe may not return complete information to SNMPv1 clients using
the community string "public". To fully utilize this probe, you must set
the community string to the one with the correct permissions.
Parameters
Link to Device Management Tool - enter the URL to the web manager for
this device.
Filename: com.dartware.wrls.airpoint.txt
Version: 1.5
Back to Top
Parameters
- 579 -
Wireless
Frame errors (%) high warning, Frame errors (%) too high alarm,
RTS errors (%) high warning, RTS errors (%) too high alarm,
Filename: com.dartware.wrls.airpoint2nexuspro.txt
Version: 0.5
Back to Top
This probe monitors a Trango M2400S access point (AP). It retrieves and
displays a number of traffic, physical, and radio status variables. It can
go into alarm or warning based on user-defined parameters for transmit
power, expected antenna mode, and expected channel. (This probe cal-
culates counters without using sysUpTime, which isn't available. MIB-2
traffic and interface information is also unavailable.)
Parameters
Tx power too low alarm, Tx power low warning - enter thresholds for
Warning and Alarm.
Filename: com.dartware.wrls.trango2400.txt
Version: 1.1
Back to Top
Trango M5800S
- 580 -
Chapter 13: Probe Reference
Parameters
Filename: com.dartware.wrls.trango10.txt
Version: 1.4
Back to Top
You must enter the password for the subscriber unit to retrieve the
information.
Parameters
Filename: com.dartware.wrls.trango.M5830SSU.txt
Version: 1.2
Back to Top
Trango M5830S
- 581 -
Wireless
Parameters
Filename: com.dartware.wrls.trango20.txt
Version: 1.4
Back to Top
This probe monitors a Trango M900S access point (AP). It retrieves and
displays a number of traffic, physical, and radio status variables. It can
go into alarm or warning based on user-defined parameters for transmit
power, expected antenna mode, and expected channel. (This probe cal-
culates counters without using sysUpTime, which isn't available. MIB-2
traffic and interface information is also unavailable.)
Parameters
Tx power too low alarm, Tx power low warning - enter thresholds for
Warning and Alarm.
Filename: com.dartware.wrls.trango900.txt
Version: 1.4
Back to Top
- 582 -
Chapter 13: Probe Reference
Eth High Traffic Bytes alarm, Eth High Traffic Bytes warning
Filename: com.dartware.wrls.trangoP5830SMU.txt
Version: 1.5
Back to Top
This probe monitors a Trango P5830S remote unit with firmware version
1.11 (040930) or later.
Parameters
Eth High Traffic Bytes alarm, Eth High Traffic Bytes warning
- 583 -
Wireless
Filename: com.dartware.wrls.trangoP5830SRU.txt
Version: 1.7
Back to Top
Sixth Generation AP
This probe monitors the sixth generation Access Point (AP) from Tran-
zeo. This series includes AP for the following models: 5A, 5Aplus, 6600,
6500, 6000, 4900, CPQ, CPQplus.
Parameters
Filename: com.dartware.wrls.tranzeo.gen6ap.txt
Version: 1.0
Back to Top
The probe monitors the received signal strength and compares it to the
warning and alarm thresholds below.
Parameters
Filename: com.dartware.wrls.tranzeo.gen6cpe.txt
Version: 1.2
- 584 -
Chapter 13: Probe Reference
Back to Top
The probe monitors the received signal strength and compares it to the
warning and alarm thresholds below.
Parameters
Filename: com.dartware.wrls.tranzeo.gen6pxp.txt
Version: 1.1
Back to Top
Tranzeo (AP)
This probe monitors a Tranzeo 1000, 2000, 3000, 400, or 4000-series all
in one device used as an Access Point (AP).
Parameters
Received Signal Level too low alarm, Received Signal Level low warning,
- 585 -
Wireless
Filename: com.dartware.wrls.tranzeoap.txt
Version: 1.3
Back to Top
Tranzeo (PXP)
This probe is meant to probe a Tranzeo 1000, 2000, 3000, 400, and 4000-
series all in one device used as a PXP (bridge), or as an SAI (station) in
router mode.
The probe retrieves and displays a number of variables for basic, eth-
ernet, wireless, and bridge information. It will go into alarm and warning
states based on user-defined parameters for Received Signal level,
Expected versus actual Station Channel, and incoming traffic on the radio
interface, as well as into alarm when the wireless or ethernet links are
reported down.
Parameters
Received Signal Level too low alarm, Received Signal Level low warning,
Filename: com.dartware.wrls.tranzeopxp.txt
Version: 1.3
Back to Top
- 586 -
Chapter 13: Probe Reference
Tranzeo (SAI)
This probe is meant to probe a Tranzeo 1000, 2000, 3000, 400, and 4000-
series all in one device used as an SAI (station).
The probe retrieves and displays a number of variables for basic, traffic,
and wireless information. It will go into alarm and warning states based
on user-defined parameters for Received Signal level, Expected versus
actual Station Channel, and incoming traffic on the radio interface, as
well as into alarm when the wireless or ethernet links are reported
down.
Parameters
Received Signal Level too low alarm, Received Signal Level low warning,
Filename: com.dartware.wrls.tranzeosai.txt
Version: 1.3
Back to Top
Parameters
Filename: com.dartware.wrls.tranzeo.58xx.backhaul.txt
Version: 1.5
Back to Top
- 587 -
Wireless
Parameters
Filename: com.dartware.wrls.tranzeo.ap.5A.44r.txt
Version: 1.4
Back to Top
Tranzeo AP-5A
Parameters
Filename: com.dartware.wrls.tranzeo.ap.5A.txt
Version: 1.4
Back to Top
Tranzeo Classic
Parameters
Filename: com.dartware.wrls.tranzeo.classic.txt
Version: 1.4
Back to Top
Parameters
- 588 -
Chapter 13: Probe Reference
l enter thresholds for Warning and Alarm for Quality and Signal
Strength.
Filename: com.dartware.wrls.tranzeo.cpe.200.177R.txt
Version: 1.4
Back to Top
Tranzeo CPE-200
This probe monitors a Tranzeo TR-CPE 200. It has thresholds for alarms
and warnings if the signal level gets too low.
Parameters
Filename: com.dartware.wrls.tranzeo.cpe.200.txt
Version: 1.7
Back to Top
Parameters
Filename: com.dartware.wrls.tranzeo.cpe.5A.44r.txt
Version: 1.5
Back to Top
- 589 -
Wireless
Tranzeo CPE-5A
Parameters
Filename: com.dartware.wrls.tranzeo.cpe.5A.txt
Version: 1.4
Back to Top
Tranzeo TR-CPE
Parameters
Filename: com.dartware.wrls.tranzeocpe.txt
Version: 1.3
Back to Top
CCU
This probe monitors a WaveRider CCU (access point). It retrieves and dis-
plays a number of variables for basic, traffic, and wireless information.
It will go into alarm and warning states based on user-defined
- 590 -
Chapter 13: Probe Reference
Parameters
Filename: com.dartware.wrls.waveriderccu.txt
Version: 1.1
Back to Top
EUM
Parameters
- 591 -
Wireless
Filename: com.dartware.wrls.waveridereum.txt
Version: 1.2
Back to Top
- 592 -
Chapter 13: Probe Reference
Experimental
l Experimental > Flow Exporter Status (Pg 593)
l Experimental > InterMapper (Pg 593)
l Experimental > sFlow v1.2 (Pg 594)
l Experimental > sFlow Vers. 1.3 (Pg 595)
This probe monitors a Flow Exporter and reports statistics about Flow
activity. It does this by retrieving information from the InterMapper
Flows server.
The normal state of the device is UP/OKAY. There are two error con-
ditions:
Parameters
None.
Filename: com.dartware.flow.exporter.txt
Version: 1.3
Back to Top
InterMapper
This probe monitors the status of the InterMapper polling engine. With
the default setting, this probe displays the results of 500 loops through
the polling engine. To measure activity at a finer-grain, decrease the
value of the Loops parameter. A value of '1' updates the statistics on
every pass through the main run loop.
The "Main Loop" frequency is the number of times that InterMapper per-
forms the main loop each second. The theoretical maximum loop fre-
quency is 66.667 loops per second, based on the current yield value of 15
msec. If it falls below 10 or even 5 loops per second, InterMapper may
report false outages.
- 593 -
Experimental
occurs per loop. This percentage will never be 100%. It should, however,
level out and remain steady over time.
On Unix systems, this probe reports Context Switches Per Loop (CSPL).
This is another measure of the overhead of InterMapper's processing as
it runs on your system. Fewer context switches per loop is better (ideal
= 0), since context switches carry overhead. A server with thousands of
devices and hundreds of mays may well have a CSPL greater than 2 dur-
ing normal operation. (This value is not available on Windows systems,
and is alway set to -1.)
InterMapper tracks the number of bytes sent out the main UDP polling
socket. Bytes/Loop is the average bytes sent per loop, averaged over the
last batch of N loops. Bytes Peak is the maximum number of bytes sent
in a *single* polling loop. (In the current implementation, the peak bytes
is checked on every loop, but only resets to 0 when you change the #
loops parameter; ie peak bytes is not the peak bytes of the last batch of
N loops.)
Parameters
Filename: com.dartware.tcp.intermapper.txt
Version: 0.11
Back to Top
sFlow v1.2
This probe's Status Window shows the sFlow version, address, and
address type of the sFlow exporter. It uses the sFlow MIB version 1.2,
with the Enterprise Number 4300 to retrieve statistics for sFlow versions
2 and 4.
Parameters
Filename: com.dartware.sflowv1.2.txt
Version: 1.2
Back to Top
- 594 -
Chapter 13: Probe Reference
This probe's Status Window shows the sFlow version, address, and
address type of the sFlow exporter. It uses the sFlow MIB version 1.3,
with the Enterprise Number 14706 for sFlow version 5.
It also shows the sFlow Receiver Table as an on-demand table. It lists all
devices receiving the sFlow records. (To view this on-demand table, you
must import the SFLOW-MIB version 1.3.)
Parameters
Filename: com.dartware.sflow.v1.3.txt
Version: 1.3
Back to Top
- 595 -
About Packet-Based Probes
The default timeout is three seconds, with a default probe count of three seconds.
Consequently, InterMapper will take nine seconds to declare a device is down
(three probes, waiting three seconds each). Both the timeout and the number of
probes can be set for each device.
This often gives rise to 21 second or 51 second outages. What's happening here is
that the device fails to respond to one set of probes (for example, after nine
seconds), but responds immediately at the next poll 30 or 60 seconds later. This
gives an outage duration to be (30-9=21) seconds or (60-9=51) seconds.
You may have created different maps that poll the same device. For Ping/Echo and
SNMP probes (built-in or custom), InterMapper polls a device only once if it is con-
sidered to be the same device, and shares the response among all the maps that
poll that device.
In order for two mapped devices to be considered the same and share the results
of a single probe, the following characteristics of the mapped device must be
identical:
l Probe Type
l Address
l Port
l Poll Interval
l Timeout
l Max tries
l Display Unnumbered Interfaces, Ignore Discards, Ignore Errors, Allow Peri-
odic Reprobe
l SNMP Version and read-only community string
- 596 -
Chapter 13: Probe Reference
For SNMP probes, the following flags in the probe file must be identical. (this is
nearly always the case, as it is implied by the probe type, but is still checked expli-
citly):
l MINIMAL
l NOLINKS
l LINKCRITICAL
- 597 -
About SNMP Versions
All SNMP-based probes can use one of version 1, 2c, or 3, at the user's choice. The
Probe Configuration window allows you to specify the SNMP version at the same
time you set all the other parameters for the probe.
The lower part of the Probe Configuration window displays the SNMP version
information. Select the version from the SNMP Version dropdown.
l Selecting SNMPv1 or SNMPv2c will show a field to enter the SNMP Read-only
community string.
l Selecting SNMPv3 changes the lower half of the probe configuration window
to let you specify all the authentication and privacy parameters. The initial set-
tings show the default settings taken from the Server Settings > SNMP pane.
- 598 -
Chapter 13: Probe Reference
See the SNMP Preferences (Pg 254) page for more details.
Note: Certain equipment requires SNMPv2 or SNMPv3, and probes can be built to
force that selection. If you try to set the SNMP version lower than the probe can
support, you will receive an error message.
- 599 -
Command-Line Probes
Command-Line Probes
Command-line probes execute a command as a command-line on supported plat-
forms. They usually call custom executables on the target machine.
Use the Command Line probe to execute a user-written program or script to test a
device. The result code returned from the program sets the device's condition.
When you create a custom command line probe, you usually start with the Nagios
Plugin probe.
For more information, see Command Line Probes in the Developer Guide.
- 600 -
Chapter 13: Probe Reference
Note: This NT Services monitoring is only available if the InterMapper server is run-
ning on a Windows XP, or 2003 computer. You cannot use this facility if you're
using a Macintosh or Unix/Linux computer to host the InterMapper server.
The NT Services
configuration window
displays the full list
of services that are
running on a remote
host. You can check
off one or many ser-
vices to monitor;
InterMapper will
then give an alert if
any of them fails.
The parameters to
the probe are:
l A list of NT ser-
vices on the tar-
get machine.
This list has red
and green
marks to indic-
ate whether the
service is cur-
rently running.
Checking the
box for the ser-
vice will cause
InterMapper to
NT Services Preferences Panel
send an alert if
that service
ever stops running.
l The Username and Password required to log onto the target machine.
The NT Services probe opens the Service Control Manager (SCM) on the target
machine; hence, some authentication is required before this can happen. There are
several ways to do this.
1. Using built-in username and password: InterMapper has the built-in abil-
ity to solicit from you a username and password for authentication. When you
- 601 -
Monitoring NT Services with the Windows NT Services Probe
choose the NT Services probe, it will prompt you for a username and pass-
word before attempting to connect to the target machine. If you have not
used one of the methods below, fill in a username and password at that point
and click OK. This will be all you need to do for authentication; the username
and password will be saved.
2. The NET USE command: Another way to authenticate is to use the NET USE
command to create a connection between the host machine and the target.
For instance, to monitor the services on a host at 192.168.1.140, enter the fol-
lowing:
You will be prompted for the password, and the connection will be made. (If
you have done this, when prompted for a username and password for NT Ser-
vices by InterMapper, you can leave them blank and click OK.)
Note: You must use the IP address and not the network name for the
machine. That is important, as the Windows OS will not see the DNS name or
the domain name as being the same as 192.168.1.140 when checking the con-
nections, and will not recognize that there is a connection when InterMapper
tries to query the services by IP address, returning an "access denied" error
instead.
- 602 -
Chapter 13: Probe Reference
your machine; let's name it InterMapper and give it a password. Make sure it
is a member of Administrators. (If you already have a username and pass-
word that exist on all machines that are to be targeted by the NT Services
probe as well as the InterMapper host and which has Administrator per-
missions everywhere, you can skip the previous step and substitute it for
InterMapper in the following.)
Go into the SCM and stop the InterMapper service if it is running. Right-click
and choose "Properties". Choose the "Log On" tab. Under "Log On As...", click
the radio button next to "This account:", and click "Browse..." to list the
accounts; choose InterMapper. Fill in the password for the account in "Pass-
word:" and "Confirm Password:". Click "OK".
On the target machine, create a new user, also named InterMapper, with the
same password, and also a member of Administrators.
Start InterMapper from the SCM on the original machine. You should now be
able to use NT Services probes. (When prompted for a username and pass-
word for NT Services by InterMapper, you can leave them blank and click
OK.)
- 603 -
Monitoring NT Services with the Windows NT Services Probe
- 604 -
Chapter 13: Probe Reference
Cisco IP SLA is supported on most IOS-based Cisco routers and switches. IP SLA
was previously known as Service Assurance Agent (SAA).
You can easily configure your Cisco routers and switches to be IP SLA agents or IP
SLA responders. An agent initiates IP SLA tests to a remote responder. A particular
agent can have multiple IP SLA tests running to many remote responders. A par-
ticular router or switch can be both an agent and a responder. For each IP SLA test
that has been configured the agent collects edge-to-edge network performance
information and stores it in the Cisco RTTMON MIB.
- 605 -
Cisco IP SLA Probe
The InterMapper Cisco IP SLA Jitter probe uses SNMP to collect the information
from the RTTMON MIB in the agent, allowing you to alarm jitter, latency, and
packet loss, and to chart these values. You can download a .zip of the probe.
The InterMapper Cisco IP SLA Probe is particularly useful for monitoring and meas-
uring QoS for VoIP and video conferencing applications. However, it is useful in
many other contexts including:
Documentation
An IP SLA Probe User Guide describes how to set up the IP SLA testing between
two Cisco routers/switches and how to configure the InterMapper probe to monitor
the values.
This page shows a sample Status Window for the probe. You can also see a screen-
shot with several graphs from a live installation.
- 606 -
Chapter 13: Probe Reference
When you specify a device to be tested with a Big Brother probe, InterMapper's
built-in Big Brother server listens for messages coming from a Big Brother client
on the corresponding machine.
l Port - The default port is 1984, but you may choose a different port. If you
choose a different port, make sure that the Big Brother client on the cor-
responding machine is also configured for the same port.
l Purple Time - This is the number of minutes to wait without a report before
indicating a problem. In an actual Big Brother server, this is thirty minutes;
Big Brother shows a device as purple if it goes this long without reports from
the device. InterMapper shows it as DOWN (blinking red).
In order for InterMapper to receive Big Brother messages from the remote client,
it must be configured correctly. In particular, the client must be configured so that
its BBDISPLAY is set to the IP address of the machine where InterMapper is run-
ning.
The Big Brother states will be mapped to InterMapper states as shown in the table
below:
At the moment, the only messages that InterMapper will process and represent are
"status" (and "combo") messages.
Note that the Big Brother server for a given port will not start until at least one
device has been configured for that port. Similarly, once the last device for that
port has been removed, the server for that port will shut down.
For more information about Big Brother, check the Big Brother web site at
http://www.bb4.com/download.html. "Big Brother System and Network Monitor" is
a trademark of BB4 Technologies, Inc. There's a good description of the Big
Brother message format at: http://www.bb4.org/bb/help/help/Status_Message_
Format.htm. You can also look through a large set of Big Brother clients that can
be downloaded freely.
- 607 -
Troubleshooting Network and Server Probes
Anytime InterMapper displays traffic for a link, (using the SNMP Traffic Probe (Pg
449), for example) it polls the following variables:
SNMPv1
When you set the SNMP Version to SNMPv1, the following variables are queried:
SNMP
MIB Variable OID
Version
ifInOctets 1.3.6.1.2.1.2.2.1.10 SNMPv1
ifInUcastPkts 1.3.6.1.2.1.2.2.1.11 SNMPv1
ifInNUcastPkts 1.3.6.1.2.1.2.2.1.12 SNMPv1
ifOutOctets 1.3.6.1.2.1.2.2.1.16 SNMPv1
ifOutUcastPkts 1.3.6.1.2.1.2.2.1.17 SNMPv1
ifOutNUcastPkts 1.3.6.1.2.1.2.2.1.18 SNMPv1
SNMP
MIB Variable OID
Version
ifAdminStatus 1.3.6.1.2.1.2.2.1.7 SNMPv1
ifOperStatus 1.3.6.1.2.1.2.2.1.8 SNMPv1
- 608 -
Chapter 13: Probe Reference
SNMP
MIB Variable OID
Version
ifInDiscards 1.3.6.1.2.1.2.2.1.13 SNMPv1
ifInErrors 1.3.6.1.2.1.2.2.1.14 SNMPv1
ifOutDiscards 1.3.6.1.2.1.2.2.1.19 SNMPv1
ifOutErrors 1.3.6.1.2.1.2.2.1.20 SNMPv1
SNMPv2c
When you set the SNMP Version to SNMPv2c, the following variables are queried:
SNMP
MIB Variable OID
Version
ifDescr 1.3.6.1.2.1.2.2.1.2 SNMPv1
ifType 1.3.6.1.2.1.2.2.1.3 SNMPv1
ifMTU 1.3.6.1.2.1.2.2.1.4 SNMPv1
ifSpeed 1.3.6.1.2.1.2.2.1.5 SNMPv1
ifPhysAddress 1.3.6.1.2.1.2.2.1.6 SNMPv1
ifAdminStatus 1.3.6.1.2.1.2.2.1.7 SNMPv1
ifOperStatus 1.3.6.1.2.1.2.2.1.8 SNMPv1
ifName 1.3.6.1.2.1.31.1.1.1.1 SNMPv2c
ifHighSpeed 1.3.6.1.2.1.31.1.1.1.15 SNMPv2c
ifPromiscuousMode 1.3.6.1.2.1.31.1.1.1.16 SNMPv2c
ifConnectorPresent 1.3.6.1.2.1.31.1.1.1.17 SNMPv2c
ifAlias 1.3.6.1.2.1.31.1.1.1.18 SNMPv2c
This variable set is polled to display statistics for the device's operation.
SNMP
MIB Variable OID
Version
ifAdminStatus 1.3.6.1.2.1.2.2.1.7 SNMPv1
ifOperStatus 1.3.6.1.2.1.2.2.1.8 SNMPv1
ifLastChange 1.3.6.1.2.1.2.2.1.9 SNMPv1
ifInUcastPkts 1.3.6.1.2.1.2.2.1.11 SNMPv1
ifInErrors 1.3.6.1.2.1.2.2.1.14 SNMPv1
ifInDiscards 1.3.6.1.2.1.2.2.1.13 SNMPv1
ifOutUcastPkts 1.3.6.1.2.1.2.2.1.17 SNMPv1
ifOutErrors 1.3.6.1.2.1.2.2.1.20 SNMPv1
ifOutDiscards 1.3.6.1.2.1.2.2.1.19 SNMPv1
sysUpTime 1.3.6.1.2.1.1.3 SNMPv1
ifHCInOctets 1.3.6.1.2.1.31.1.1.1.6 SNMPv2c
ifHCOutOctets 1.3.6.1.2.1.31.1.1.1.10 SNMPv2c
- 609 -
Troubleshooting Network and Server Probes
Note: In the SNMPv2c , the input and output MulticastPkts and BroadcastPkts MIB
variables replace NUcastPkts variables of the SNMPv1 probe, which are deprec-
ated. HCOctets replace the regular Octets counters. Pkts and errors still use the
MIB-II 32 bit counters.
InterMapper uses ifInOctets and ifOutOctets to compute the Receive and Trans-
mit bytes/second values, respectively.
The Receive and Transmit packets/second numbers are computed using the sum of
the (ifInUcastPkts + ifInNUcastPkts) and (ifOutUcastPkts +
ifOutNUcastPkts) respectively.
Q: A customer writes,
"I see the Received Discards/Minute and Percent Err values for an ATM
AAL5 interface are non-zero and I would like to know which variables
were used, and what calculation was used to arrive at these numbers.
"We are also graphing the Percent Err: value. This figure is showing
errors and my Cisco support folks wanted to know which MIB variables
go into the calculation of this percentage and how they are combined to
create this number."
- 610 -
Chapter 13: Probe Reference
The one-way percent errors under the Receive section are computed by totalling {
ifInUcastPkts, ifInNUcastPkts, ifInErrors, ifInDiscards } as follows:
where:
and:
Note: Either of 'dErrs' or 'dDis' may be forced to zero if you have "IgnoreIn-
terface Errors" or "Ignore Interface Discards" checked.
The one-way percent errors for outgoing traffic are similarly computed from the
{ ifOutUcastPkts, ifOutNUcastPkts, ifOutErrors, ifOutDiscards }
statistics.
The two-way Percent error number (just below Utilization on the Interface inform-
ation menu) is the probability given both one-way error percentages that a packet
will be lost making the round-trip across the link and back. If the probability of suc-
cessful transmission is T and the probability of successful receipt is R (and assum-
ing the act of transmission and receive are relatively independent), then the
probability of a successful round-trip is T * R. The probability of error is (1 - T*R).
T and R are computed from the complement of the one-way percent errors above.
When running InterMapper on Mac OS X, you need to disable DHCP and PPP and
assign a manually assigned static address to the computer running InterMapper.
- 611 -
Troubleshooting Network and Server Probes
lsof -i | grep bootpc' and press return. If configd is listed, you still
have DHCP running.
5. If InterMapper still marks the device as down after making these changes,
you may need to use a DHCP Message Type of "DHCP-Discover" instead of the
default "DHCP-Inform". This setting can be toggled in the DHCP/Bootp probe
parameters dialog.
If I look at the traffic on a link, wait five seconds, and look again, the
traffic rates are the same. Shouldn't these numbers be updated?
The traffic statistics are samples: the numbers do not change until after Inter-
Mapper probes the device again.
SNMP only supplies counts of bytes, packets, or errors, etc. that have passed
through or occurred in an interface. These counts increment "forever" (or until the
counter rolls over to zero like a car's odometer).
During each poll, InterMapper collects the total traffic and computes the difference
with the total traffic from the previous poll. It then divides by the amount of time
that has passed to compute the rate (per second or per minute).
Technical note: Even when a counter rolls over (e.g., from 999 to 000), Inter-
Mapper will compute the traffic rates accurately. Let's say the two successive
samples are 995 and 003. InterMapper subtracts the previous count (995) from the
new count (003), assumes that the "003" is actually "1003", and gets the proper dif-
ference of 8. Although the counters in the SNMP MIB variable are binary numbers,
the same arithmetic principles hold. Thus InterMapper can compute these rates
accurately.
To compute the elapsed time accurately, InterMapper uses the sysUpTime variable
of the device as a timestamp to calculate the time that has elapsed between sub-
sequent two polls. The time elapsed should roughly correspond to the poll interval;
however, it is possible for polls to be delayed occasionally so using the change in
sysUpTime to measure the elapsed time is more accurate.
- 612 -
Chapter 14
Note: Unless you want to do one of the following, you do not to take any of the
steps described in this topic:
l If you want to install and run InterMapper DataCenter from another machine.
l If you want to specify an outgoing email server for error and bug reporting.
l If you want to change the logging setup.
l From the Reports Server pane of InterMapper's Server Settings window, click
Configure...
l Go to this URL:
https://127.0.0.1:8182/
You can replace the generated certificate with one of your own by visiting the Ser-
vices List. Click the Change Settings link for the InterMapper DataCenter Daemon,
once initial setup is complete.
Before you can use InterMapper DataCenter from another machine, you must set
the password for the InterMapper DataCenter admin account.
Note: By default, you can log in to InterMapper DataCenter from the machine it is
installed on without any authentication. You can choose to force authentication
even on the local machine by unchecking the Skip authentication for local con-
nections box, and creating a password as described above.
- 613 -
Chapter 14: Using InterMapper DataCenter
If you are planning to use an existing database, you are now ready to configure it
(Pg 615). If you are planning to use InterMapper Authentication Server (Pg 623),
you are also ready to configure it now.
1. Click the Log button in the upper-left corner of the page. The Log Viewer
appears.
2. From the Logging Level dropdown menu, choose the level you want to use.
3. Click Save. The InterMapper DataCenter installation is complete.
InterMapper DataCenter can report problems and send bug reports to InterMapper
Support. To do this, you need to specify one or more SMTP hosts and user inform-
ation.
- 614 -
Using an Existing Database
If you prefer, you can use another instance of a PostgreSQL database, running on
the same machine or on another machine. See Configuring the Database below.
(You'll need an additional user account if you want to use pgAdmin, Perl, PHP,
Crystal Reports, or some other method to retrieve information from Inter-
Mapper Reports Server. If you wish, you can add them later.)
Note: The user you specify must have, at minimum, CREATE, TEMPORARY,
- 615 -
Chapter 14: Using InterMapper DataCenter
and CONNECT privileges in order for InterMapper to log data to the database.
D. If you want to add users, click Add to add a user. An unnamed user appears
in the User List at left.
- 616 -
Using an Existing Database
- 617 -
Chapter 14: Using InterMapper DataCenter
A data retention policy can be applied to a specific map, to one or more devices or
interfaces on a map, to an individual dataset, or to all maps on an InterMapper
Server. Policies also affect the way InterMapper stores chart data.
Use the Retention Policies pane of the Server Preferences section of the Server Set-
tings window to create and edit retention policies that can be used to specify how
data is stored for a particular device or map. For more information, see Retention
Policies (Pg 274).
- 618 -
Configuring InterMapper Database Logging Preferences
From the Logging Level dropdown menu, choose the logging level you want to use,
as follows:
l Full Debug - Log minor details such as values read from configuration files
and chunks of data arriving as part of directory responses.
l Connections (default) - Log authentication attempts, connections by the
InterMapper server, and outgoing data.
l Information -Log web admin panel logins, changes to configuration and
scheduled server tasks.
l Errors Only - Log only serious errors, indications of future errors, and pos-
sible security problems.
- 619 -
Chapter 14: Using InterMapper DataCenter
l From the InterMapper DataCenter's Home tab, click Overview. The Over-
view page appears, showing disk usage statistics.
- 620 -
Configuring Automatic Database Backups
To create a backup:
l Click Create Backup. A new backup file is created immediately. The backup
starts immediately. When finished, the backup file is listed in the Available
Backups box.
1. In the Available Backups box, click the backup file you want to restore.
2. Click Restore. Data from the selected backup is restored to the InterMapper
Database.
When a backup is underway, you can view its progress from the Automatic Data-
base Backups page. You can also cancel a backup while it is under way.
l While the backup is under way, go to the Automatic Database Backups page.
The progress bar appears.
l Click Abort to cancel the current backup.
- 621 -
Chapter 14: Using InterMapper DataCenter
Two tasks are run automatically to clear out data that is beyond its retention policy
expiration, and to reclaim unused disk space.
l Daily task - runs at 1AM local time each day. It applies retention policies,
then uses the PostgreSQL VACUUM command to mark free space for re-use
by the database. This is a relatively low-impact process, and does not pause
database operations. It does not release disk space for reuse by the operating
system.
l Weekly task - runs at 1AM local time each Sunday. It uses the PostgreSQL
CLUSTER command, and pauses database operations while it runs. This task
frees up unused database space, making it available to the operating system.
After you have run one of these tasks, the Disk Usage table shows the freed disk
space as available.
- 622 -
Using the InterMapper Authentication Server
Overview
IMAuth is not a replacement for InterMapper's local user database. You may con-
tinue to keep some user passwords in InterMapper's local user database for local
authentication while requiring others to be authenticated via IMAuth. For each
user, you must choose one method or the other.
Select the "Use External Authentication" check box in the Edit User or Create
User dialog to indicate that the user should be authenticated via IMAuth, in which
case you should not supply a password. For more information on creating and edit-
ing users, see Users and Groups (Pg 298).
You need to configure the InterMapper Authentication Server to talk to your dir-
ectory server. This is done from InterMapper DataCenter's web administration
page. To do this, start IMAuth Server as described above, then open a web
browser and navigate to: https://localhost:8182. You can also click Configure...
in the Reports Server pane of the Server Settings window.
- 623 -
Chapter 14: Using InterMapper DataCenter
IMAuth acts as a RADIUS client, and so it must be added to the clients section of
your RADIUS configuration file or, for Microsoft IAS, the clients section of the IAS
configuration pane. You are asked to specify a secret, and must then enter exactly
the same secret in the IMAuth RADIUS settings.
LDAP
If you encounter any problems, first try un-checking the Use SSL option, or choose
Whenever Necessary for the Use Plaintext option in the IMAuth LDAP settings. If
this works, it means your server wasn't built to include SSL or SASL DIGEST-MD5
password encryption. You'll need to either stay with the lower IMAuth security set-
tings, or upgrade your LDAP server.
Another thing to look at is the LDAP Base DN specified in the IMAuth LDAP settings.
This tells IMAuth where in your LDAP directory the user entries are located. This
depends on how your directory was set up, but usually takes the form:
ou=people,dc=example,dc=com, where example and com correspond to the
domain name your directory was set up with. IMAuth takes the Base DN and
attaches the user's name; for example:
cn=Jane,cn=Smith,ou=people,dc=example,dc=com.
ActiveDirectory
Since ActiveDirectory is built around the idea of domains rather than single serv-
ers, the username you use to authenticate must have your domain name attached
to it. For example, if your normal Windows logon name is janesmith and your
domain is example.com, the username you give when accessing a map with Inter-
Mapper or InterMapper RemoteAccess is [email protected].
Almost all ActiveDirectory versions support SSL. If you have provided your own
certificate, choosing the Whenever Necessary option for the Use Plaintext field in
the IMAuth LDAP settings doesn't have much impact on your security. If you really
do need the additional encryption, you must perform these steps:
1. Log in to your server as an administrator, and start the Active Directory Users
and Computers panel.
2. Open the properties for each user who needs to authenticate, and switch to
the Account tab.
3. Under Account options, check the Store password using reversible encryption
box.
Note: Windows cannot apply the change immediately, so you must get that
- 624 -
Using the InterMapper Authentication Server
In this case you might again need to use a different username. Instead of the usual
login name, you may need to use the user's full name. For example, instead of
janesmith you would use Jane M. Smith.
When setting up IMAuth, it's a good idea to try the normal login name, the login
name with your domain attached, and the user's full name, to see which login your
ActiveDirectory server accepts.
Kerberos
- 625 -
Chapter 14: Using InterMapper DataCenter
Use the Reports Server panel, available from the Server Configuration section of
the Server Settings panel, to start and stop collecting data. You can also configure
InterMapper to connect to a remote database server, and specify the intervals at
which data is stored. For more information, see Reports Server (Pg 285).
You can collect data for any device in any map. Use the Set Data Retention com-
mand, available from the Monitor menu or the device or interface's Set Info con-
text menu to specify how long the data from the device or interface is retained,
and at what resolution.
The default server-wide Data Retention Policy is 24 Hours (except for devices and
interfaces associated with charts created in 4.6 or earlier). You can also create and
select a different retention policy as the server-wide default policy:
l For all maps, choose Inherit to use the specified server-wide default policy,
as set in the Server Settings window. You can also specify a default Data
Retention policy for a map that is different from the server's default policy.
l For all devices, choose Inherit to use the specified map-wide default policy,
as set in the Map Settings window. You can also specify a default Data Reten-
tion policy for a device that is different from the map's default policy.
l For all interfaces, choose Inherit to use the specified device policy, as set in
the Device Info window. You can also specify a default Data Retention policy
for an interface that is different from the device's policy.
l For devices and interfaces associated with charts created in 4.6, the default
Data Retention policy is IM46Charts.
l If you do none of the above, the default server-wide policy is applied auto-
matically.
Note: Data Retention Policies are applied individually, not in sequence. For
example, specifying an hourly data expiration of two days now causes hourly
samples to be deleted after two days, instead of two days plus the raw and custom
expirations.
- 626 -
Data Collecting and Reporting
A device or interface's current Retention Policy is shown in the Status and Info win-
dows. In the Status window, the information appears as follows:
The Reports Server is the easiest way to get data from the Reports Server data-
base, but you can use your own method for retrieving data from the InterMapper
Database using SQL queries. There are several example reports written for Crystal
Reports and OpenRPT, as well as several perl scripts available. For more inform-
ation, see Retrieving Data From the InterMapper Reports Server in the Developer
Guide.
- 627 -
Chapter 15
File Locations
The locations of these files and folders differ slightly between operating systems
as described below.
- 628 -
Chapter 15: InterMapper Files and Folders
For detailed information on the contents of the InterMapper Settings folder, see
InterMapper Settings (Pg 632).
- 629 -
InterMapper Files and Folders
For detailed information on the contents of the InterMapper DataCenter folder, see
InterMapper DataCenter Folder (Pg 634).
l (Flows files)
/var/local/InterMapper_Settings/Flows
Linux l (Database)
/var/local/InterMapper_Settings/Flows/SESSIONDB/
- 630 -
Chapter 15: InterMapper Files and Folders
Making Backups
InterMapper saves its state the InterMapper Settings folder.
Note: When making backups of the InterMapper Settings folder on Windows install-
ations, it is important to stop the InterMapper Server before making a backup, or
make sure that your backup mechanism allows files to be accessible by Inter-
Mapper simultaneously. Opening certain types of chart or log files can cause them
to be inaccessible to InterMapper, causing the InterMapper Server to stop
abruptly.
A new version of InterMapper can use a file data structure which is different from
previous versions. To preserve the ability to "go back" to an earlier version, Inter-
Mapper creates a copy of the current maps when you install a new version of Inter-
Mapper, named with the new version number. This becomes the copy that contains
active maps.
The old maps are moved to a folder named with the previous version number. If
you need to revert to an earlier version of InterMapper, you can get your original
maps from the folder whose name corresponds with the version you want to run.
In subsequent releases, the folder that corresponds to the current version is used
automatically.
- 631 -
The InterMapper Settings Folder
been installed, (starting with 5.4) a new folder is created for each ver-
sion. Maps from a previous version are copied into the new folder,
which becomes the active maps folder. The folder for each new version
contains a Disabled folder and a Deleted folder.
n Enabled folder - Contains maps that have been disabled by
removing the check mark in the Map Files panel of the Server Set-
tings window.
n Disabled folder - Contains maps that have been disabled by
removing the check mark in the Map Files panel of the Server Set-
tings window.
o Deleted folder - Contains maps that have been removed using the
mand.
l MIB Files folder - Contains SNMP MIB files that ship with the product, or
have been added using theImport > MIB... command. InterMapper parses
the MIB files in this folder and uses the information to convert between vari-
able names and OIDs.
l Probes folder- Contains built-in and custom probes. Probes are text files
that add functionality to InterMapper so that it can test new devices. See Cus-
tomizing InterMapper's Probes for details about creating and customizing
probes.
- 632 -
Chapter 15: InterMapper Files and Folders
l Sounds folder - Add .aiff, .wav, and other sound files to this folder to make
them available for InterMapper notifications. For more information on sounds
and how to use them, see Configuring a Sound Notifier (Pg 142)
l Web Pages folder - Contains the template and target files that describe the
web pages that the InterMapper server displays. See Customizing Web Pages
for details about customizing these pages.
l InterMapper User List folder - Previous versions of InterMapper kept the
user list in a separate file. Now, these user and group settings have been
incorporated into the InterMapper Prefs file. You may leave this file in place
without affecting InterMapper's operation.
l Tools folder - Contains executable files (or aliases/links/shortcuts to them)
that will be used as command-line probes or notifiers.
l Fonts folder - (optional) Contains TrueType fonts used by the web server.
When you exit InterMapper, it leaves the files in the Temporary directory
alone, so debugging information can be collected. When InterMapper starts
up, it checks the Temporary directory, and deletes all files in it. Therefore,
InterMapper users should not rely on the contents of the Temporary directory
remaining long, and should not park files there.
- 633 -
InterMapper DataCenter Folder
Platform-specific folders
Mac OS
sbin - This contains a script used by launchctl to start and stop the InterMapper
DataCenter daemon.
Linux/Unix
sbin - This contains a script used by the platform's load daemon to start and stop
the InterMapper DataCenter daemon, as well as assorted other scripts.
- 634 -
Chapter 16
InterMapper exports data about the devices on its maps. This makes it possible to
use the map data in a number of ways, for example:
You can export data for all maps, for the current map, or only for selected items in
the current map.
Note: You can automate the exporting of map data by sending commands to Inter-
Mapper RemoteAccess through its command-line interface or through the HTTP
API. This allows you to interact with InterMapper through your own scripts. For
more information, see Command-line options for RemoteAccess, (in this manual)
as well as InterMapper HTTP API in the Developer Guide.
Map Save a copy of the map from the server on which it's
running to a file on a local computer. A standard File
Save dialog appears.
Data file Save a text file containing information about a map in
one of these formats:
- 635 -
Chapter 16: Importing and Exporting Maps
1. From the File menu's Export submenu, choose Data File... The Export Map
Data window appears as shown below.
2. From the Tabledrop-down menu, choose devices (device attributes), ver-
tices (appearance attributes), maps, notifiers, users, or schema (output
file attributes).
3. From the Fields box, click to choose the fields you want to export. Shift-click
to select a contiguous series, or Ctrl-click to choose non-contiguous fields.
4. Click Add>>. The selected fields appear in the Field Export Order box. If
you want to export all fields, click Add All.
5. In the Field Export Order box, drag the field names up or down to set the
order you want the fields to appear in the export file.
6. Click to choose Export data from all maps or Export this map.
7. If you want to export data only for the selected items on the map, click Only
export selected items.
8. From the Output format drop-down menu, choose Tab-delimited, CSV,
HTML, or XML. For information on these formats, see the table above.
9. Click Export. A standard File Save dialog appears.
10. Choose a name and location for the export file, and click Save. The export
file is saved in the specified location.
- 636 -
Importing Data
Importing Data
InterMapper can import data from a text file to update information about devices
on a map, or information about Users or Groups. This is useful for:
l New customers who want to import the devices/probe types from their cur-
rent monitoring system (or information that's already present in a spread-
sheet or other format) into InterMapper.
l Customers who make frequent updates to existing devices on maps.
l Customers who frequently add new devices to maps. They want to enter
information about new customers to a database, then export the new device
information to a file that can be bulk-imported into InterMapper.
l Customers who want to make systematic changes to their maps. They can
export the InterMapper map as, say, tab-delimited data, then edit columns in
a spreadsheet/database, then re-import, letting InterMapper merge the new
information onto the existing devices. This is useful for wholesale label
changes, switching IP addresses, etc.
l Customers who want to import a list of users from another source for authen-
tication purposes.
To import data:
Note: The import file contains the name of the map. If the map does not
exist, it is created automatically.
3. From the File menu's Import...submenu, choose Data File...A standard file
dialog appears.
4. Select the file you want to import and click Open. If the map data is valid,
devices are added or updated on the specified maps as appropriate. If the spe-
cified map does not exist, one is created automatically.
Note: You can automate the importing of map data by sending commands to
InterMapper RemoteAccess through its command-line interface or through
the HTTP API. This allows you to interact with InterMapper through your own
scripts. For more information, see Command-line options for RemoteAccess,
(in this manual) as well as InterMapper HTTP API in the Developer Guide.
- 637 -
Chapter 16: Importing and Exporting Maps
l The first line of the file specifies the format of the following lines -
it specifies the file format ("tab" in the example below), the table to be filled
("devices") and the order of the fields. Three fields must be specified:
MapName, Address, and Probe; the remaining fields are optional.
l Remaining lines contain the data for the devices you want to import
- Each device occupies a single line, and the data columns are separated by
tabs (a "tab-delimited" file.) Each column corresponds to a field in the fields
specification of Line 1.
The first line of the file determines the method you are going to use for importing,
and can provide you with a significant amount of control over how devices are
imported. There are two different methods you can use for importing; each uses a
different format for the first line of the file:
Notes:
l For either style of importing, data is set only in those fields whose Access
value is specified as "READ-WRITE" in the Device Attributes and Vertex Attrib-
utes topics, found in the in Advanced Data Importing (Pg 649) in the Refer-
ences section.
l Text files should be encoded in UTF8 format.
l Characters with values less than 255 can be imported directly.
l Character values greater than 255 must be escaped using the standard XML
format (&#[character code]).
- 638 -
Importing Data
The recommended format for creating an import file is a spreadsheet style format,
in which the first line contains tab-separated column names that correspond to the
remaining rows:
Notes:
l If you have created a spreadsheet-style import file, you can easily change it
to a Directive line-based file for updating the map.
l You can include columns in your import file from both the Device and Vertices
tables. InterMapper automatically applies the Vertex attributes appropriately.
The columns are imported in the order specified. The last value specified takes pre-
cedence over previous values in the same line. Because of this, Help/Systems
recommends that you use only one the following columns when importing. If more
than one of these is specified, and there are conflicts, the last column's values are
used:
l Address
l DNSName
l IMProbe
For a complete list of device attributes and corresponding field names, see Device
Attributes in Advanced Data Importing (Pg 649) in the References section.
The Directive-Line
Using the Directive Line technique, in addition to inserting new devices, you can
update specific attributes of existing devices, change their appearance or location,
and delete them. This technique is documented in Advanced Data Importing (Pg
649) in the References section.
- 639 -
Chapter 16: Importing and Exporting Maps
A benchmark is an
icon on a map that
specifies the latitude
and longitude of that
point. InterMapper
uses the bench-
marks to determine
the proper location
for icons on the
map.
To place a bench-
mark on a map:
1. Right-click (CTRL-click) a known location (on for which you know the actual
latitude and longitude) in the map's background image and choose Add
benchmark... The Add Benchmark Coordinates window appears.
2. Enter the latitude and longitude for the point. A small triangular icon appears
to represent the benchmark. InterMapper supports multiple formats for lat-
itude and longitude. (See below)
3. Follow steps 1 and 2 to enter a second benchmark to complete the geographic
information. Your map is now ready for you to import devices with specified
geographic coordinates.
- 640 -
Using Geographic Coordinates
l [+|-]dd.dd:mm.mm:ss.ss
l [+|-]dd.dd:mm.mm
l [+|-]dd.dd
l [+|-]dd.dd mm.mm ss.ss
l [+|-]dd.dd mm.mm
Allowable suffixes:
l s, n, e, w, S, N, E, W.
- 641 -
Chapter 16: Importing and Exporting Maps
You can create a tab-delimited file with information about the devices to be added
to the map. This information can include any of following fields: Name, IP Address,
DNS name, port, type of device, SNMP community string, latitude, longitude, and
many other fields. Fields left unspecified are filled with default values. For more
information, see Importing Data Into Maps (Pg 637).
l Line 1 specifies the format of the following lines - it specifies the file
format ("tab" in the example below), the table to be filled ("devices") and the
order of the fields. Three fields must be specified: MapName, Address, and
Probe: the remainder are optional.
l Remaining lines contain the data for the devices you want to import
- Each device occupies a single line, and the data columns are separated by
tabs (a "tab-delimited" file.) Each column corresponds to a field in the fields
specification of Line 1.
In this example import file, there are five fields to import. InterMapper places
these items on the map named "MapA", using the address specified to create HTTP
probes. They are placed at the indicated latitude and longitude.
- 642 -
Using Geographic Coordinates
Sources of Maps
There are a huge number of mapping services available through the web. Here are
several that we have found useful:
Web-based
Description
Service
Google http://www.Google.com/imghp?hl=en&tab=wi&ie=UTF-8&q=
Image Search Search their Images section for the word "map" plus the name
of the country, province, state, etc. you need. Free.
Maporama http://www.maporama.com
Attractive street maps with different styles and coloring that
are good for backgrounds. Large maps available. Free.
Mapblast http://www.mapblast.com
Another site showing street maps suitable for backgrounds.
Large maps available. Free.
National http://www.nationalatlas.gov
Atlas A source of national and state maps. Free.
ter- http://www.terraserver.com
raserver.com Aerial photographs. Clever interactive latitude and longitude
indicator using mouse rollover. 1 m/px resolution.
Microsoft http://msrmaps.com/
Research USGS Aerial photos, and topo maps to 1 m resolution. Clicking
Maps shows latitude and longitude of the clicked point. Also allows
large, medium, and small maps. Free.
US Census http://www.census.gov/geo/www/maps
Bureau Construct a map from Census data as well as street, political,
river/water data. Free.
Yahoo! List- http://dir.ya-
ing of Map hoo.com/Science/Geography/Cartography/Maps/Interactive/
Resources Yahoo! Search for interactive maps. Lists many interesting
mapping sites. Free.
dmoz Open http://dmoz.org/Science/Social_Sciences/Geo-
Directory graphy/Geographic_Information_Systems/
Links to many Geographic Information Systems sites. Free.
Geocode.com http://www.geocode.com/
An inexpensive geocoding service that converts street
addresses to latitude and longitude.
Radio Mobile http://www.cplus.org/rmw/english1.html
Software that predicts the performance of a radio system
based on topographic maps. Free.
- 643 -
Chapter 16: Importing and Exporting Maps
Each InterMapper map appears as a place in the left pane of Google earth. Items
are shown as follows:
l Devices are represented by their status badges (green, yellow, orange, red
circle icons)
l Network ovals are shown as small circles.
l Links between devices are shown as lines connecting the icons.
l A Status window for each of the above items displayed when you click the
item.
l Explicitly - by using Set Latitude and Longitude... for each device. You
can set latitude and longitude values for many devices at once by importing a
text file containing the correct information (Pg 642).
l Implicitly - When benchmarks are are placed on a map, the device's latitude
and longitude are inferred from the x/y position on the map, relative to the
established benchmarks. Use the Insert menu's Map Benchmark... (Pg
640). to add benchmarks. Use of benchmarks is inherently less precise than
using explicit coordinates.
In the case where both explicitly set coordinates and benchmarks are used, Inter-
Mapper uses the explicit coordinates and ignores the benchmarks.
How it works
- 644 -
Exporting Information to Google Earth
How to use it
The easiest way to get the URL is through the InterMapper web interface.
If everything is set up properly, the status badges for your devices hover over the
surface of the Earth in appropriate locations.
l Click the device's badge. The device's Status Window appears in the Google
Earth window.
- 645 -
Chapter 16: Importing and Exporting Maps
The images below show the original map, the mapped devices displayed from two
different zoom levels, and the status window for one of the devices.
- 646 -
Exporting Information to Google Earth
- 647 -
Chapter 16: Importing and Exporting Maps
- 648 -
Chapter 17
If you need more control over the import process, you can use the Directive line
technique instead of a spreadsheet-style import file. In addition to inserting new
devices, you can update specific attributes of existing devices, change their appear-
ance or location, and delete them.
Note: You can automate the importing of map data by sending commands to Inter-
Mapper RemoteAccess through its command-line interface. This allows you to inter-
act with InterMapper through your own scripts. For more information, see Using
the Command Line Interface in the Developer Guide.
The first line, known as the directive line, is formatted as in this example:
# format=tab table=devices fields=id,name,address modi-
fy=address match=id
Notes:
l You can generate a list of fields and descriptions for any data type by
exporting the Schema table. For more information, see Exporting Data
From Maps (Pg 635).
l You can include columns in your import file from both the Device and
Vertices tables. InterMapper automatically applies the Vertex attributes
appropriately to the vertex linked to the indicated device.
- 649 -
Chapter 17: Advanced Data Importing
Directive Format/Options
Parameter
Format Supported file formats:
l tab - tab-delimited
l csv - comma-separated
l xml - XML format (see an exported file for the
format)
Example:
format=tab
Table Available values for the table directive are listed in Data
types (Pg 655), below.
Examples:
table=devices
table=vertices
Example:
modify=ID,MapName,Address,Latitude,Longitude
Example:
match=MapName,Address
- 650 -
Introduction - The Directive Line
Examples:
Insert=MapPath,Address,Name,Latitude,Longitude
Example:
delete=MapName,Probe
- 651 -
Chapter 17: Advanced Data Importing
group.
Examples:
group-
=MapName,MapPath,A-
ddress,Name,Latitude,Longitude
- 652 -
Introduction - The Directive Line
The remaining lines of the file contain the data as specified in the fields definition
described above. Each column is separated by a tab, and columns must appear in
the order specified in the fields definition (for directive line imports) or must cor-
respond to the field names specified in the first line of the file (spreadsheet-style
imports).
Available values for the table directive are listed in Data types (Pg 655), below.
Note: The example above creates the devices and assigns probes, but does not set
the parameters for the probes. The most efficient way to do this is using the
IMProbe URL (Pg 687). It lets you specify the SNMP community string, the probe
by file name, and any parameters needed.
Use the group directive to create a device and add probes to it as a group. The fol-
lowing example adds six devices, with the last one having a probe group. Groups
are created in order - probes are added to the group until the IP address changes.
Note: Like the example above, this one creates the devices and assigns probes,
but does not set the parameters for the probes. The most efficient way to create
and configure a probe group is to use the IMProbe URL (Pg 687). It lets you specify
the SNMP community string, the probe by file name, and any parameters needed.
- 653 -
Chapter 17: Advanced Data Importing
InterMapper places new devices in horizontal rows across the top of the specified
map. If either X/Y coordinates or geographic coordinates are specified for the
device, InterMapper places it at the specified location on the map.
- 654 -
Introduction - The Directive Line
table=[data type]
l devices - imports data specific to devices. See the Device Attributes (Pg
656) table.
l vertices - You can also control other aspects of a device in a map, such as
the device's color, label, shape, or font. The vertices type imports data spe-
cific to the appearance of devices. See the Vertex Attributes (Pg 667) table.
l interfaces - imports data specific to the switch and router interfaces. See
the Interface Attributes (Pg 670) table.
l maps - imports data specific to maps. See the Map Attributes (Pg 675) table.
l notifiers - imports data to describe notifiers. See the Notifier Attributes (Pg
678) table.
l notifierrules - imports data to describe how a notifier is applied. See the
Notifier Rules Attributes table. (Pg 679)
l users - imports user account information. See the User Attributes (Pg 681)
table.
l retentionpolicies- imports user account information. See the Retention
Policy Attributes (Pg 682) table
- 655 -
Chapter 17: Advanced Data Importing
Device Attributes
Device attributes are supported as described in the table below. At minimum,
MapName and Address are required. To create a device by importing, the fol-
lowing is required:
For any attribute that is not in the file, a default value is used. For example, if no
probe is specified, the Automatic probe is used.
table=device
Notes:
Device Attributes
Field Name Description
MapName Type: TEXT
Access: READ-ONLY
Attributes: none
Description:
Name of the map containing the device.
- 656 -
Device Attributes
Id Type: TEXT
Access: READ-ONLY
Attributes: INDEX
Description:
A unique, persistent identifier for this device
instance. The id will be unique across all maps on
a single InterMapper server.
- 657 -
Chapter 17: Advanced Data Importing
- 658 -
Device Attributes
- 659 -
Chapter 17: Advanced Data Importing
SYSTEM }
- 660 -
Device Attributes
- 661 -
Chapter 17: Advanced Data Importing
Description:
The device's SNMPv3 user name.
- 662 -
Device Attributes
- 663 -
Chapter 17: Advanced Data Importing
Description:
16-bits integer.
- 664 -
Device Attributes
Access: READ-ONLY
Attributes: none
Description:
System uptime.
- 665 -
Chapter 17: Advanced Data Importing
Access: READ-ONLY
Attributes: none
Description:
The time in seconds remaining until the timed
acknowledgement expires, if any.
- 666 -
Vertex Attributes
Vertex Attributes
Use the vertices data type to control the appearance of devices in your map, such
as the device's color, label, shape, or font.
table=vertices
Id Type: TEXT
Access: READ-ONLY
Attributes: INDEX
Description:
A unique, persistent identifier for this vertex instance. The id
will be unique across all maps on a single InterMapper server.
- 667 -
Chapter 17: Advanced Data Importing
Attributes: none
Description:
Font size in points.
- 668 -
Vertex Attributes
- 669 -
Chapter 17: Advanced Data Importing
Interface Attributes
The interfaces data type imports data specific to the switch and router inter-
faces.
table=interfaces
Interface Attributes
Field Name Description
MapName Type: TEXT
Access: READ-ONLY
Attributes: none
Description:
The name of the map to which the interface
belongs.
- 670 -
Interface Attributes
Access: READ-ONLY
Attributes: none
Description:
The interface index (i.e. ifIndex) of the interface,
as an integer.
- 671 -
Chapter 17: Advanced Data Importing
- 672 -
Interface Attributes
Access: READ-ONLY
Attributes: none
Description:
The status of the interface (e.g. UP, DOWN, or
ADMIN-DOWN).
- 673 -
Chapter 17: Advanced Data Importing
Attributes: none
Description:
Customer-supplied name, for referencing an
external database.
- 674 -
Map Attributes
Map Attributes
The maps directive contains data to describe maps. All fields are READ-ONLY.
table=maps
- 675 -
Chapter 17: Advanced Data Importing
- 676 -
Map Attributes
Attributes: none
Description:
True if the map is currently running.
- 677 -
Chapter 17: Advanced Data Importing
Notifier Attributes
The notifiers data type contains data to describe notifiers. All fields are READ-
ONLY.
table=notifiers
- 678 -
Notifier Rules Attributes
table=notifierrules
Up Type: BOOLEAN
Access: READ-ONLY
Attributes: none
Description:
True if user is notified of UP events.
- 679 -
Chapter 17: Advanced Data Importing
Attributes: none
Description:
True if user is notified of WARNING events.
- 680 -
User Attributes
User Attributes
The users data type imports user account information.
table=users
- 681 -
Chapter 17: Advanced Data Importing
table=retentionpolicies
- 682 -
Retention Policy Attributes
Description:
How long five-minute sample data is retained by the data-
base in days; -1 = forever.
- 683 -
Chapter 17: Advanced Data Importing
About D-Sets
When you export data, you can export a generic set of information about a probe
or notifier. This information is in XML format, contained in an export field in the fol-
lowing export tables:
l ProbeXML - If this field is included in the export, a D-set is included for each
selected device on the map.
l NotifierXML - If this field is included in the export, a D-set is included for each
active notifier associated with the map.
ProbeXML D-set
This D-set contains information about a specific probe. Depending upon the probe
type, it may have more or fewer <d> clauses. Here is an example:
NotifierXML D-set
This D-set contains information about a specific notifier. Depending upon the noti-
fier type, it may have more or fewer <d> clauses. Here are some examples:
<dset type='notifier'>
<d name='method'>smtpmail</d>
<d type='param' name='email_addr'>[email protected]</d>
<d type='param' name='subject'>This is a subject</d>
<d type='param' name='message'>This is a message.</d>
</dset>
<dset 'notifier'>
<d name='method'>audible</d>
<d type='param' name='down_sound'>name of the sound (as
string)</d>
<d type='param' name='up_sound'></d>
<d type='param' name='crit_sound'></d>
- 684 -
About D-Sets
<dset type='notifier'>
<d name='method'>snmptrap</d>
<d type='param' name='address'></d>
<d type='param' name='community'></d>
</dset>
<dset type='notifier'>
<d name='method'>snpppager</d>
<d type='param' name='pager_id'></d>
<d type='param' name='message'></d>
</dset>
<dset type='notifier'>
<d name='method'>modempager</d>
<d type='param' name='pager_id'></d>
<d type='param' name='message'></d>
</dset>
<dset type='notifier'>
<d name='method'>winpopup</d>
<d type='param' name='popup_id'></d>
<d type='param' name='message'></d>
</dset>
<dset type='notifier'>
<d name='method'>cmdline</d>
<d type='param' name='cmdline'></d>
<d type='param' name='success'></d>
<d type='param' name='message'></d>
</dset>
<dset type='notifier'>
<d name='method'>syslog</d>
<d type='param' name='address'></d>
<d type='param' name='facility'></d>
- 685 -
Chapter 17: Advanced Data Importing
<dset type='notifier'>
<d name='method'>group</d>
<d type='param' name='id_list'></d>
</dset>
- 686 -
The IMProbe URL Specification
When you export data from InterMapper, you can include the IMProbe field in the
export file. The IMProbe field contains the IMProbe URL, which in turn contains all
configuration information for a probe in URL-encoded format. You can use the
IMProbe URL to change the parameters of probes editing the parameters of the
URL, and then importing the URL into the map.
For example, you could change the username and password for all of your HTTP
probes in all maps at once by:
1. Exporting the data, including the MapName, Address, and Id, and IMProbe
fields for all maps.
2. Finding and replacing the username and password parameters in each URL.
3. Re-importing the text file.
The URL format specifies the information necessary to define a probe using the
IMProbe scheme:
URL: 'improbe://'[community'@']address[':'port]'/'probe
['?'parameters]
The minimal information required for an IMProbe URL is the Address information,
Probe type, and Authentication information.
l Address information
l DNS name
l IP address
l port number (optional)
l Probe type
l canonical probe name
l probe-specific parameters (optional)
l Authentication information
l SNMP community name (optional)
The probe may be a canonical InterMapper probe name specified in full, ie.
com.dartware.radius, com.dartware.http.redirect, or a unique probe suffix
may be specified, ie. radius, http.redirect.
The parameters are the parameters for the probe, encoded as for a GET request.
To make it simpler to create IMProbe URL's manually, the matching of parameter
names is simplified. Before matching parameter names, the parameter names are
converted to lower-case, and any spaces and underscores are removed. For a para-
meter named Shared Secret, this means that IMProbe parameters
- 687 -
Chapter 17: Advanced Data Importing
If the parameters section contains a parameter name that is not defined for the
probe, the parameter is ignored. If a probe parameter is left out of the IMProbe
URL, it is set to its default value from the probe file.
Examples
Both of the IMProbe URLs below specify that the host netopia.example.com should
be tested with the built-in Ping probe:
improbe://netopia.example.com/com.dartware.ping
improbe://netopia.example.com/ping
improbe://netopia.example.com/com.dartware.radius?shared_secret-
t=secret&user_name=im&password=pw
improbe://neto-
pia.example.com/radius?sharedsecret=secret&username=im&password=pw
The URLs below specifies the SNMP probe, testing a device at 192.168.1.1, using
the community string of 'public'. The second URL a test against port 1611 instead
of the default port 161 used in the first URL:
improbe://[email protected]/com.dartware.snmp
improbe://[email protected]:1611/snmp
The IMProbe URL format uses the Common Internet Scheme Syntax as specified
in section 3.1 of RFC 1738. The following characters are illegal and must be
encoded with %hh:
The following characters are also considered unsafe and should be encoded with
%hh:
<>"#%
The following characters are reserved for special purposes and should not appear
unencoded except when used as delimiters in the URL:
- 688 -
Chapter 18
Note: To access the web server remotely, (that is, from a different machine con-
nected to the network) you must configure the InterMapper firewall to permit the
connection. You must also configure any other firewalls protecting the machine
that is running InterMapper to allow traffic to the specified port. For more inform-
ation, see The Web Server (Pg 289) in the Server Settings section.
l The header, which shows the map name or other title and a navigation bar for
going to other pages. This is usually the same for every page.
l The content of the page, which varies, depending on which page is selected.
l The footer of the page, which shows the time the page was created.
- 689 -
Chapter 18: Using the Web Server
Use the menu at the top of the InterMapper Web Page to access the available fea-
tures of the web page. The example above shows a web page for a particular map.
The image below shows the InterMapper Web Server menu, found at the top of
each page.
Click any of the menu items at the top of the page to view the page. Here is a brief
description of each page:
l Home Page - Click the InterMapper logo to return to the Home page. View a
list of open maps and the charts associated with those maps. Mouse over a
map link to see a preview of a map. Click the link to view the map.
l Error - View a list of InterMapper errors.
l Full - View a list of devices and networks associated with all open maps.
l Outages - View a list of current outages (devices and networks that are cur-
rently down) and previous outages (devices and networks that failed in the
past, but have returned to service).
l Device List - View a list of devices and networks associated with all open
maps.
l Statistics - View information about the current version of InterMapper under
which the Web Server is running.
l Help (menu) - Choose from a menu of options that allow you to get inform-
ation about the InterMapper Web client and the current version of Inter-
Mapper. View and download files in the InterMapper Settings folder, view the
User and Developer Guides, and connect to the InterMapper Telnet server.
- 690 -
The Home Page
Note: A map on a web page is actually a "snapshot" image of the current state of
the map at the time you request the page. The map image is static, so you need to
refresh the page to see changes in the map state. You can use the Interval drop-
down menu button to select the page's refresh interval.
- 691 -
Chapter 18: Using the Web Server
Click any link, device, or network to view detailed information about that item.
This is the same information that appears in a Status window. Here are typical dis-
plays:
Device Status
Device Information
Name: router.company.net.
DNS Name:router.company.net.
Address: 192.168.1.1
Status: UP
Protocol:Ping/Echo
Up Time: n/a
Availability: 100% (of 1 hour, 29 minutes, 12 seconds)
Packet Loss: 0.0% (of 143 total attempts)[ Reset]
Recent Loss:None
Last updated Jun 23, 12:16:42; interval: 30 seconds
Network Status
Network Information
Name: 192.168.1.0/24
IP Net:192.168.1.0/24 (255.255.255.0)
Sum In: 2 pkt/sec 548 byte/sec 0 error/min
Sum Out: 3 pkt/sec 316 byte/sec 0 error/min
Comment:
This is the network in the office.
It has an IP address of 192.168.1.0, and a subnet mask of
255.255.255.0.
- 692 -
The Home Page
Link Status
Interface Information(ifIndex = 1)
Device Name:router.company.net.
Description:EN1
Type: 10 MBit ethernetCsmacd(MTU=1500)
Status: UP for 4 days, 13 hours
Address: 192.168.1.1 (255.255.255.0)
MAC Address:00-00-C5-76-E2-EC
Interface Statistics
Utilization: 0.01% (of10 MBit bandwidth)
Percent Err: 0.0% (59 pkts w/o error)
Transmit Statistics (0.01% utilization)
Pkt/Second: 0(5.88% multicast)
Byte/Second: 73(590 bps)
Err/Minute: 0(0 errors)
Disc/Minute: 0(0 discards)
Percent Err: 0.0% (17 pkts w/o error)
Receive Statistics (0.01% utilization)
Pkt/Second: 1(59.5% multicast)
Byte/Second: 93(748 bps)
Err/Minute: 0(0 errors)
Disc/Minute: 0(0 discards)
Percent Err: 0.0% (42 pkts w/o error)
Last updated Jun 23, 12:21:02; sample: 37.94 seconds.
Map Status
When you click a Map Status item, the map associated with that device appears,
rather than an information window.
- 693 -
Chapter 18: Using the Web Server
- 694 -
The Error and Full Pages
Use the Full Page to view all devices, networks, and links being monitored by
InterMapper, not just those with problems.
Both the Error and Full web pages have the same format, shown below.
l Click a link in the left column of either page to view detailed information
about the link, device, or network.
The Home Page (Pg 691) topic shows typical Device and Network Status.
- 695 -
Chapter 18: Using the Web Server
The top line shows a summary of items being monitored in all open maps. They
are, in order:
- 696 -
The Error and Full Pages
The first detailed section of the page shows devices that are down, or are in alarm
or warning states. The Device section shows:
The second detailed section of the page shows networks and links that are down,
or are in alarm or warning states. The Link section shows:
- 697 -
Chapter 18: Using the Web Server
l Click an active link on the Outages Web page to view detailed information as
described in the Map Web Page topic.
- 698 -
The Device List Web Page
l Click a link to view detailed information about a device. The example below
shows a typical Device List web page.
- 699 -
Chapter 18: Using the Web Server
Web Device List. This shows the status of all the devices InterMapper is mon-
itoring, sorted by severity of their status.
- 700 -
Viewing a Chart
Viewing a Chart
Use the Chart web page to view the selected chart.
When view a map's page, a list of the charts associated with the map appears. The
list appears only if charts have been created.
A typical chart
- 701 -
Chapter 19
Here is summary of the features and functions available from the Telnet Server, as
shown through the server's help system. For each command listed below, click
[ details ] to view the server help for that command:
ERROR
- Shows a report of all devices and links that exceed some
threshold. This
report is updated every minute. For detailed information about
the fields
and columns of this report, type "help error". This is the
default command
when you connect.[ details ] (Pg 704)(Abbreviations: "E", "ERR")
FULL
- Shows a report of all devices and links being monitored. [
details ] (Pg 704) (Abbreviations: "F")
NODE <name-prefix>
- Shows a report of the named device using the same format as the
"ERROR"
report. This report is updated every time InterMapper polls the
device.
[ details ] (Pg 704) (Abbreviations: "N")
BUS <name-prefix>
- Shows a report of the named network or segment using the same
format as
the "ERROR" report. This report is updated every minute.
[ details ] (Pg 704)(Abbreviations: "B")
DOWN- Lists all devices that are down. The same functionality is
also provided
by the ERRORS command. [ details ] (Pg 705)
LDOWN- Lists all interfaces (ie links) that are down. The same
functionality is
- 702 -
Chapter 19: Telnet Server Command Reference
LOG [ ]
- Displays the last entries from the event log window and con-
tinuously
displays new log lines. [ details ] (Pg 707)
KALID
- Displays a list of the maps, log, lists, and other shared resources
open by each
Remote connection.
[ details ] (Pg 707)
HELP [ <topic> ]
- Without a parameter, the help command displays this help text. If
you include the
name of the command as the parameter, it displays detailed inform-
ation about the
format of the report generated by it. [ details ] (Pg 706)
QUIT- End the telnet session and disconnect. [ details ] (Pg 707)
RELOAD
- Closes all map files and reopens them. This command is only imple-
mented in the
server/daemon version of InterMapper. [ details ] (Pg 708)
- 703 -
Telnet Server Command Reference
TELNET
- Displays a list of current connections to the Telnet server. [
details ] (Pg 708)
USERS [<UID>] - Displays a list of users with user IDs. Include the
user ID to delete the user.
WEB
- Displays a list of current connections to the Web server. [ details
] (Pg 709)
Command Details
> help error
The ERROR, FULL, NODE, and BUS commands emit a report with three
parts:
(1) a status line summarizing the condition of the entire network
(2) a node report
(3) a link report.
Example:
Jul 31 11:11:58 2 nodes, 1 down, 8 links, 0 down, 461 pk/s,
141 K by/s
Name Stat SysUpTime Probe Address
egg-1 DOWN 0+00:00:00 ICMP 127.110.13.210
Name Prt Stat TPkt TBytes TErr TDis RPkt RBytes RErr RDis
Util
Segment
egg-1 1 UP 46 13790 0 0 67 10152 12* 0
1% 127.0.13.0/24
egg-1 2 UP 78 8330 0 0 586 144524 14* 0
12% 127.0.14.0/24
(1) THE STATUS LINE
Jul 31 11:11:58 2 nodes, 1 down, 8 links, 0 down, 461 pk/s,
141 K by/s
In order, these fields are:
- 704 -
Chapter 19: Telnet Server Command Reference
- 705 -
Telnet Server Command Reference
> help
HELP [<topic>]
- Without a parameter, the help command displays this help text. If
you
include the name of the command as the parameter, it displays
detailed
information about the format of the report generated by it.
- 706 -
Chapter 19: Telnet Server Command Reference
> help kalid
Displays a list of the maps, log, lists, and other shared resources
open by
each Remote connection.
Here is some sample output:
+ CKaliOpenMapList [2d6008] user='Guest' [ADMIN]
- [485d58] [email protected]:58619
+ CKaliOpenLogList [351cd8] addr='198.115.166.18' user='Guest'
[ADMIN]
- [485d58] [email protected]:58619
+ CKaliOpenSoundSetList [351d68]
- [485d58] [email protected]:58619
This indicates that the remote connection [485d58] is responsible for
an "open
map list", an "open log list", and an "open sound list". Essentially,
this
means that client will be notified of any changes to those lists. If
this user
had opened a map, you would see them registered for that "open map";
i.e. they
would be notified of any changes.
Multiple connections may be registered for the same resource, the out-
put above
only shows the server state with one connection.
> help ldown
The LDOWN command lists all interfaces which currently have the
'DOWN'
status. The LDOWN report does not include interfaces which are hid-
den
and therefore not being polled.
Each line has the following format:
mm/dd hh:mm:ss DOWN <Device-Name>:<ifIndex>:<ifDescr>
<ifIndex> is the index of the interface in the interface table,
and <ifDescr> is a description of the interface.
> help log
Displays the last <num-lines> entries from the event log window and
continuously displays new log lines.
The format of the LOG output is exactly the same as the format of the
"Event Log" window of the InterMapper program.
> help quit
QUIT
- End the telnet session and disconnect.
- 707 -
Telnet Server Command Reference
- 708 -
Chapter 19: Telnet Server Command Reference
Note: The IN, OUT, and LOGIN@ stats are not implemented for the
TELNET command.
Note: The IN, OUT, and LOGIN@ stats are not implemented for the WEB
command.
- 709 -
Chapter 20
Command-line Options
Command-line Options for InterMapper
Usage:
*For Mac OS and Linux, you may need to use the full path to the executable
(/usr/local/bin/intermapperd) in order for some options to work correctly.
Argument Description
-h -? --help Display this help text and exit.
-v --version Print the version number.
-f <file> Use the specified configuration file.
-A <user-addr> Add the specified 'user[:pass]@address' to the
access list.
- 710 -
Chapter 20: Command-line Options
You can call InterMapper RemoteAccess from a command line, and control a sig-
nificant number of functions. This can be useful for automating the updating of
maps, or for various testing purposes.
Argument Description
-host --host <HOST> connect to the specified HOST
-port --port <PORT> connect to the specified PORT on HOST
(defaults to 8181)
-map --map <MAP_ load the specified map(s) from HOST (sep-
NAME> arate map names with ":")
-import --import import the specified file (use - for stdin)
<FILE_NAME>
-importmap --import- import the specified map.
map <FILE_NAME>
-export --export export the specified data to stdout.
<EXPORT-SPEC>
Note: Data for all maps is exported.
-exportmap --exportmap export the specified map
<MAP_ID>
Note: The easiest way to get the map ID is
to look in the Maps folder in the Inter-
Mapper Settings folder. Each map name
has a prefix that begins with "g". The text
between the "g" and the hyphen ("-") is the
Map ID.
-f --file <FILE_NAME> open the specified shortcut file
-d --debug <DEBUG_ use the specified configuration file to con-
CONFIG_FILE> figure debugging output
- 711 -
Command-line Options for RemoteAccess
- 712 -
Chapter 20: Command-line Options
Windows Users
The syntax for Windows users is essentially the same as the Linux/Unix examples
below, except that the command line requires the full Windows path to Inter-
Mapper's Java installation (rather than any other installations of Java that might
exist on the machine.) The following example sets the working directory to the .jar
file, then invokes java with the .jar file:
Remember to use this approach for all of the examples below, replacing java with
the full path to the InterMapper Java installation.
- 713 -
Command-line Options for RemoteAccess
The stdin form of the --import option allows Unix users to create self-contained
executable files that import stuff:
#!/usr/bin/java
-jar intermapper_remoteaccess.jar --host big.dartware.com --import -
#import blah blah
blah
blah blah
blah
blah blah
blah
- 714 -
Chapter 20: Using InterMapper With Splunk
System Requirements
Installation Overview
In order to use Splunk and InterMapper together, you need to do the following:
1. Prepare InterMapper. This includes enabling the Web server, adding a syslog
notifier for Splunk, and setting the syslog message for compatibility with
Splunk.
2. Set up InterMapper to send syslog notifications to Splunk.
3. Install the InterMapper App for Splunk.
Before you can use Splunk with InterMapper, you have to set up InterMapper to
allow Splunk to access it. The steps are as follows:
Before you can use Splunk, you need to enable the InterMapper web server.
1. From the Edit menu, choose Server Settings... The Server Settings window
appears.
2. In the left pane of the Server Settings window, click Web Server. The Web
Server configuration panel appears.
3. In the Web Server configuration panel, click Start.
Note: You can choose to run the web server on a different port, but will need
to enter that port in the Splunk application when you set it up.
4. Add an access control list entry to allow web server access by the Splunk host
machine. Access is based on IP address.
5. Add one or more access control list entries to allow web server access by any
users of the Splunk application. Access is based on IP address or address
range.
You need to add a user account to InterMapper that Splunk can use to log in to the
InterMapper server.
- 715 -
Using InterMapper With Splunk
To add a user:
1. In the left pane of the Server Settings window, click Users. The Users panel
appears.
2. Click the + button and choose Add User... The User Information dialog
appears.
3. In the Name box, enter a user name for the Splunk Server.
4. In the Automatic Login text box, enter the IP address of the Splunk server.
5. Click OK. The Splunk Server user appears in the user list.
6. Drag the Splunk Server user to the Administrators group. The Splunk Server
user requires elevated privileges to export details about InterMapper maps.
Splunk acts as a syslog server. You need to create a syslog notifier that Inter-
Mapper can use to send syslog entries to Splunk.
1. From the Server Settings window, click Notifier List. The list of existing noti-
fiers appears.
2. +
Click the button. The Configure Notifier window appears.
3. Give the notifier a name, such as "SplunkLog".
4. From the Notifier Type dropdown menu, choose Syslog.
5. Enter the Splunk server's IP address in the Send syslog message to box.
6. Click Edit Message, then edit the syslog message as follows:
This format allows Splunk to extract syslog data and make it available in Splunk.
Once you have created the Splunk notifier, you need to attach it to all devices in
InterMapper.
1. From InterMapper's Window menu, choose Device List. The Device List win-
dow appears, showing a list of devices.
2. Click the Notifier View button near the left end of the window's toolbar. A
set of checkboxes appears for each device.
3. From the dropdown menu just to the right of the View selection buttons,
choose the Splunk syslog notifier you just created.
4. For each state you want to record in Splunk, hold Alt and click a check box in
the column for that state. All check boxes are selected.
5. Recommended settings for Delay, Repeat time, and Count:
- 716 -
Chapter 20: Using InterMapper With Splunk
Delay = none
Repeat time = 5 minutes
Count = infinite
Hold Alt, click the dropdown menu for each column, then release the Alt key
and choose the value from the dropdown menu. It is set for each device in the
list.
Notes:
l Set your Splunk notifier to be attached to new devices by default from the
Default Notifiers panel of the Map Settings window.
l To send data to Splunk for only a single map, you can view devices in the
map's Notifier View and attach only the devices in that map to the Splunk noti-
fier.
Note: One and only one device using this probe should exist on an Inter-
Mapper server. Running multiple instances of this probe uses InterMapper
server resources unneccessarily, with no benefit to the InterMapper App for
Splunk.
%SPLUNK_HOME%\etc\apps\InterMapper\default
The probe sends switch port data in CSV format to Splunk; the data is then inter-
preted and indexed in Splunk.
Assuming a clear network route between InterMapper and Splunk, and that you are
running Splunk as root, indexing of syslog data by Splunk begins nearly imme-
diately.
The InterMapper App for Splunk automatically configures Splunk to receive and
interpret syslog data from InterMapper.
- 717 -
Using InterMapper With Splunk
1. From Splunk's Apps menu (in the Web UI), choose Find More Apps... The
Browse More Apps page appears.
2. Enter "InterMapper" in the search box, and click the Search button or press
Enter. The InterMapper App for Splunk appears.
3. Click the Read More link. The description page for the InterMapper App for
Splunk appears.
4. Click Download, log into your Splunk account, and save the file in a location
accessible to your browser.
5. From the Web UI or your Splunk installation, choose Manage Apps... from
the Apps menu. The Apps Manager page appears, showing all currently
installed Splunk Apps.
6. Click Install App from File. The Upload an App page appears.
7. In the File box, click Browse, and navigate to the App file you downloaded.
8. If you have installed a previous version, click to select Upgrade App.
9. Click Upload. The app is installed. You will be asked to restart your Splunk
server.
10. Click OK to restart your Splunk server.
11. From the Apps menu, choose InterMapper. A configuration notice appears.
12. Follow the links to the Configuration page.
13. Enter the IP address and port of the InterMapper web server in the form "
[address]:[port]", and the name of a default map, and click Save.
14. After a few moments, the InterMapper page appears with the default map.
- 718 -
Chapter 21
Troubleshooting InterMapper
l How do I change the community string? (Pg 719)
l How do I monitor a fixed IP address? (Pg 719)
l I still can't make my router talk... (Pg 719)
l My switches are always orange and showing lots of errors (or discards). Why?
(Pg 720)
l What does it mean when InterMapper says a "subnet mask is discontiguous"?
(Pg 720)
l Why do network labels sometimes have a "/2*"? (Pg 721)
l Why won't a device connect to the proper subnet oval? (Pg 721)
l There are two separate network ovals on my map where there should only be
one... (Pg 721)
l Some network ovals have more than one IP network number... (Pg 721)
l Does InterMapper support unnumbered IP links? (Pg 722)
l What does it mean when a Status Window shows [[ifIndex not in ifTable]] ?
(Pg 722)
l How can I find out how many devices I'm monitoring with InterMapper. Do I
have to count all the boxes on each map? (Pg 722)
l I get an error message: "This InterMapper Server already appears to be asso-
ciated with the InterMapper Database. Existing UUID is associated with a dif-
ferent URL". (Pg 725)
You can open the Show Info window on a device as described in the Monitor menu
(Pg 390) reference topic.
1. Select the devices for which you want to change the community string.
2. From the Monitor menu, choose Set Community. The Set Community win-
dow appears.
3. Enter a Community string and click OK.
Use this procedure to set the Read-Only community string for one or more devices
at once.
If you still can't make the router work with InterMapper, try the following:
l From the Help Menu's Diagnostics submenu choose Server Log, or from the
Window menu's Logs submenu, choose Debug. Look for any messages
- 719 -
Chapter 21: Troubleshooting InterMapper
My switches are always orange and showing lots of errors (or discards).
Why?
We frequently hear of devices that appear to have high levels of discards and/or
errors. They are usually orange on the map, and the status window shows a mes-
sage like this:
The most likely reason that InterMapper shows a high rate of discards from a
device is that the device is actually reporting these errors. It's common that when
InterMapper reports errors (from its SNMP queries), the manufacturers' own mon-
itoring tools will report zero errors. (It's also normal that the affected devices are
operating normally, without problems, in this state.)
1. Use the vendor's own network monitoring tool (by telnetting in, using a web
browser, etc.) to see if errors are being reported through the native man-
agement interface. It's possible that there actually is a problem.
2. This may be a bug in the SNMP implementation of the device. You can check
with your vendor to see if there's a firmware upgrade that addresses the prob-
lem.
3. To test InterMapper's accuracy, use another SNMP console to check out the
particular MIB variables for the device. InterMapper monitors the
ifInDiscards and ifInErrors MIB variables (and the corresponding
ifOutxxxx variables) listed on the Network and Server Probes (Pg 608) page
to compute its error & discard figures.
You can monitor these same variables with your SNMP Console to see if the
same errors are reported there.
4. Run a ping test through the device that's reporting the errors.
l If packets are actually being discarded, you'll see a higher than normal
packet rate of dropped packets.
l If packets aren't being dropped, it's another clue that the values repor-
ted by SNMP are incorrect.
5. As a workaround, if you've satisfied yourself that the error reports are bogus,
you can instruct InterMapper to ignore the discards and/or errors. To do this,
Get Info on the affected device and check the "Ignore Interface Errors" or
"Ignore Interface Discards" box as desired.
- 720 -
Troubleshooting InterMapper
In usual network configurations, a device's subnet mask contains one bits in the
left side of the number, and zero bits on the right. InterMapper can then use the
convention that a subnet mask is described as the number of bits in the subnet
mask, and uses the notation of "/24" to indicate a subnet mask of 24 one-bits, or
"255.255.255.0". For more details, see the IP Addressing FAQ. (Pg 727)
A subnet mask that has zero bits interspersed with the one bits in the left half of
the value is often a configuration error. InterMapper points this out when you
click and hold on a link: the status window resembles the figure at the right.
Normally, the address line contains the IP address and the subnet mask. This
example shows a device whose IP address and subnet mask are set to the same
value. This error is shown in the status window.
This is another indication that there's a problem with the subnet mask. The fig-
ure at the right shows the network oval with a discontiguous subnet mask. The
/2* indicates that the subnet mask has zero bits in the left half; clicking on the
link will give a status window similar to the one above.
This example comes from an HP printer that has a bug in its SNMP implementation.
The subnet mask of the printer is actually configured properly, and the printer is
working. However, the SNMP software in the printer is reporting the incorrect
value (it's reporting the IP address) for the subnet mask. Help/Systems has repor-
ted this to HP.
There are two separate network ovals on my map where I only expect
one...
Examine the network's Status window to determine whether the subnet masks are
the same in both ovals. If the subnet masks are different, one of the devices con-
nected to the oval with the "wrong" subnet mask probably has a misconfigured sub-
net mask. (Look for the device that is being polled with SNMP.)
Note: For devices polled with ICMP echoes, InterMapper tries to guess whether it
should draw a link to the network that contains the IP address. If both network
ovals look equally good, it may draw a link to the "wrong" one, or alternate
between them.
It's possible for a router or host to have two or more configured IP addresses for a
particular interface. This form of secondary IP addressing can be common if your
addressing is in transition. Rather than bringing everything to a halt to change IP
addresses, a network administrator will support two IP subnets on the same logical
wire. All the devices in the subnet can then have their IP addresses changed at
their leisure, rather than forcing everyone to change them all at once. When all the
- 721 -
Chapter 21: Troubleshooting InterMapper
addresses have changed, the administrator usually gets rid of the old network num-
ber.
It's also possible that InterMapper is only reporting what it knows, and the inform-
ation it is using is incomplete. This may be true of multi-point network tech-
nologies (like frame-relay clouds). If you find a situation where InterMapper is
reporting multiple networks on a logical network and you know it's wrong, please
send us email ([email protected]) so we can figure out a way to make
InterMapper's depictions more accurate.
We would also like to hear about a network with multiple IP network numbers
where InterMapper does not show them correctly.
Yes.
1. From the Monitor menu, choose Set Behavior... The Set Behavior window
appears.
2. Select the Display unnumbered interfaces check box.
3. Click OK. Unnumbered interfaces are now shown.
For more information, see the Set Behavior (Pg 387) window reference section of
the Monitor Menu reference topic.
What does it mean when a Status Window shows [[ifIndex not in ifT-
able]] ?
Then the interface description for ifIndex 2 will be listed as "[[Not in ifTable]]".
How can I find out how many devices I'm monitoring with InterMapper.
Do I have to count all the boxes on each map?
The Server Information pane of the Server Settings window shows the number of
devices you are monitoring.
This problem is related to having only one "target" address for each device, even
though InterMapper knows the addresses of the other ports. When a device is
- 722 -
Troubleshooting InterMapper
discovered using TCP/IP, it gets added with a target address in IP. You can't switch
to use RTMP because that's an AppleTalk-only protocol.
- 723 -
Chapter 21: Troubleshooting InterMapper
To send a SIGQUIT message, type the following in a terminal window (pid is the
process id for InterMapper RemoteAccess):
The thread dump will be sent to stderr. On MacOS X, this is always the Console,
unless you are running from the Terminal.
Windows Systems
If you have launched InterMapper RemoteAccess from the command line (e.g.,
java -jar <InterMapper RemoteAccess>) press Ctrl-Break in the Command Prompt
to force the stack trace.
On Windows, this is the equivalent of /dev/null unless you are running from a Com-
mand Prompt or have redirected stdout/stderr to a file via the Debug Window's
Redirect System Output... menu item.
- 724 -
Troubleshooting InterMapper DataCenter
If you are certain that the installation of InterMapper which has generated this
error is the same installation that was associated with the UUID previously, or if
you know it should replace it, you can choose "Force".
Note: It is important to pay attention to this error; map ids, device ids, etc., are
only unique within a given server; if you associate a completely different install-
ation of InterMapper with an existing UUID, the information about maps, etc. on
the old server will be replaced or updated by information from the new server.
When that occurs, datapoints from completely different datasets may be asso-
ciated as if they were from one dataset.
- 725 -
Chapter 21: Troubleshooting InterMapper
About IP Addresses
Note: InterMapper now supports 128-bit IPv6 addresses. Most of the information
in this topic is still relevant and accurate. In addition, you can enter an IPv6
address anywhere in InterMapper that you can enter a 32-bit IPv4 address.
32-bit IPv4 Addresses are written as a sequence of four numbers separated by ".",
like this: 208.123.246.35. Each of the four numbers in the IP address can take the
value between 0 and 255.
Every computer on the Internet must have a unique IP address. ISPs purchase
large blocks of consecutive IP addresses, and then allocate smaller ranges of these
addresses to their customers. Thus, a particular company might be assigned all the
254 IP addresses in the range 208.123.246.1 to 208.123.246.254. (The addresses
".0" and ".255" are not usually assigned.) Companies then assign the IP address to
individual computers within the organization.
Computers send information through the Internet by dividing the data to send into
small chunks ("packets") and transmitting them to the other device. All this hap-
pens without your doing anything - the web browser, e-mail program, etc. all take
care of these low level details.
When your computer wants to send to another computer, it creates the packet,
then places the other computer's address in the destination address of the packet,
places its own address in the source address of the packet, and then sends the
packet off, either directly to the destination computer, or to a nearby router that
takes responsibility for routing the packet.
There's an analogy with the post office here. Packets are like envelopes, with des-
tination addresses and return addresses. Routers are like post offices: they check
the destination address and have the responsibility for delivering the packet to the
final destination computer or to another router that's closer to the destination.
- 726 -
About IP Addresses
A subnet is a range of IP addresses. The special attribute of a subnet is that all the
computers within the subnet (a "sub-network") can talk directly to each other, and
don't need a router to communicate.
But how does your computer know whether the packet's destination is within its
subnet? The answer is that your computer uses the subnet mask to determine the
members of the subnet.
The chart below associates the number of IP addresses in a subnet to the subnet
mask. For example, the subnet mask "255.255.255.0" represents 254 consecutive
IP addresses. If your computer's IP and the destination computer's IP addresses
are in the same subnet address range, then they can send packets directly to each
other. If they're not in the same range, then they must send their data through a
router for delivery.
What does the "/24" mean? How does that relate to my subnet mask?
- 727 -
Chapter 21: Troubleshooting InterMapper
The Internet Assigned Numbers Authority (IANA) has reserved several blocks of IP
addresses that an organization may assign for its own private internet. These
blocks are defined in RFC 1918 (http://www.ietf.org/rfc/r fc1918.tx-
t?number=1918).
The Internet Assigned Numbers Authority (IANA) has reserved the fol-
lowing three blocks of the IP address space for private internets:
We will refer to the first block as "24-bit block", the second as "20-bit
block", and to the third as "16-bit" block. Note that (in pre-CIDR nota-
tion) the first block is nothing but a single class A network number, while
the second block is a set of 16 contiguous class B network numbers, and
third block is a set of 256 contiguous class C network numbers.
- 728 -
Quick Intro to IPv6 Address Formatting
** Global Unicast address are all currently being assigned with a 2000::/3
prefix. Other three-bit prefixes are reserved for future use.
*** Site-Local Unicast and IPv4-compatible prefixes are deprecated. Use ULA and
IPv4-mapped addresses, respectively.
- 729 -
Chapter 21: Troubleshooting InterMapper
About DNS
l What resolver does InterMapper OSX use for its DNS? (Pg 730)
l InterMapper sometimes won't show a device's DNS name... (Pg 730)
l What is a FQDN? (Pg 730)
What resolver does InterMapper OSX use for its DNS?
InterMapper uses two different DNS resolvers. When you add a device using the
Add Device... command, InterMapper uses the system's resolver, configured in
the OSX Network settings panel. When you use the "DNS Check" feature , Inter-
Mapper does its own DNS operations, via UDP packets, to the domain name serv-
ers listed in the DNS Monitor Preferences panel. InterMapper's built-in domain
name resolver assumes that the domain name is fully-qualified. The interval for
verifying the domain name is determined by the TTL in each DNS response (with
the minimum interval specified in the DNS Monitor preferences panel).
When you discover devices, InterMapper initially looks up the FQDN name from
the IP address (address --> name), then it settles down to monitoring the domain
name (name --> address). InterMapper's built-in DNS resolver doesn't handle par-
tially-qualified or invalid domain names; they fail to resolve.
From the Edit menu, you can choose the Set Info submenu, then choose Set
Address... to change the DNS option for each affected device fromResolve
name to address to Resolve address to name. With this setting InterMapper
always resolves the address to a name, and you don't see errors with names that
aren't fully-qualified domain names.
What is a FQDN?
Tip: Even though you enter a FQDN when specifying a computer, you can use the
Short, Smart Name when constructing a label for a device (Pg 414).
Tip: Technically, a FQDN requires a "." at the end. Just as the search domain is
tacked onto the end of a partial domain name, most user software adds the trailing
"."
- 730 -
SNMP Information
SNMP Information
l What is SNMP? (Pg 731)
l What is the 'Read-only Community String'? (Pg 731)
l Why can't I get SNMP information from a device? (Pg 732)
l How can InterMapper query a particular MIB variable? (Pg 732)
l Do all tables have an index? (Pg 733)
l Where can I read more information about SNMP? (Pg 734)
l How do I interpret an unknown enterprise number? (Pg 734)
l Is there a way to scan a network for all SNMP devices? (Pg 734)
What is SNMP?
SNMP stands for the Simple Network Management Protocol. At its heart, SNMP is a
set of rules that allows a computer to get statistics from another computer across
the Internet.
Computers keep track of various statistics that measure what they're doing. For
example, routers can keep track of the number of bytes, packets, and errors that
were transmitted and received on each interface (port). Web servers might keep a
tally of the number of hits they have received. Other kinds of equipment have con-
figuration information that's available through SNMP.
The various values that can be retrieved from a MIB are called MIB variables.
These variables are defined in the MIB for a device. Each MIB variable is named by
an Object Identifier (OID), which usually has a name in the form of numbers sep-
arated by periods ("."), like this: 1.3.6.1.xxxx.x.x.x.x...
For example, the MIB-II (pronounced, "MIB two") has a variable that indicates the
number of interfaces (ports) in a router. It's called the "ifNumber", and its OID is
1.3.6.1.2.1.2.1.0
InterMapper can query a device for the MIB variables and display the results.
When a device receives a SNMP Get-Request for this ifNumber OID, it responds
with the count of interfaces.
Note: The trailing ".0" in the example above is technically part of the OID.
Although you will often see OIDs written without it, InterMapper requires that it be
present wherever you enter an OID.
The SNMP Read-Only Community String is like a password. It is sent along with
each SNMP Get-Request and allows (or denies) access to device. Most network
vendors ship their equipment with a default password of "public". (This is the so-
called "default public community string".) Many network administrators will
change the community string to keep intruders from getting information about the
- 731 -
Chapter 21: Troubleshooting InterMapper
network setup. This is a good idea. Even if it's only read-access, SNMP can divulge
a lot of information about the network that could be used to compromise it.
If there's a "read-only community string", you might expect that there is a"Write
community string". You'd be correct. There is also a SNMP Set-Request, which is a
command to set certain SNMP MIB variables (e.g., certain OIDs) to a specified
value. These writes are protected by the write community string (which should
never be set to 'public'!). Many SNMP-speaking devices also have IP address filters
that ignore requests (read and write) unless the source address is on an access
list.
l Wrong DNS name/IP address - (not likely, but we have to mention it)
l No connectivity - Can you ping the device from InterMapper?
l No SNMP agent on the device - Many devices or computers have optional
SNMP capabilities that must be installed separately.
l Is the SNMP agent disabled? - Many devices allow you to disable the
SNMP capability totally, or from certain ports.
l If the SNMP agent is based on net-snmp or UCD-snmp package - be
sure that the configuration file specifically lists InterMapper's IP address/sub-
net as an allowed client
l In a custom probe, have you specified the OID properly? - (See the
OID Format FAQ (Pg 732) for details.)
l Wrong Community string - (have you tried 'public' ?)
l Access lists: does the equipment only allow SNMP access from cer-
tain addresses?
l Firewalls: does a firewall block the SNMP port between your Mac
and the equipment?
l Bugs in the SNMP agent on the equipment - InterMapper uses SNMP
Get-Next-Requests in several places. We've seen certain equipment that fails
when queried this way.
If you're sure that you've checked all these things and you still can't get SNMP
information, please get back to us at [email protected]. We may have
some tricks up our sleeves. (Or we may wind up learning something!)
- 732 -
SNMP Information
There are two kinds of MIB variables: scalar values and table entries.
l Scalars have a single value, such as the interface number shown above. For
example, the ifNumber MIB variable of a router is a single number that rep-
resents the total number of its interfaces (ports).
l Table values, on the other hand, provide the same pieces of information for
different items, such as the traffic for each of a router's ports, or information
about each of the TCP connections in a device.
InterMapper can read and display both scalar variables and table variables in its
custom SNMP probes.
Scalar values must have a ".0" suffix in their OIDs. For example, the OID for
ifNumber in MIB-II is often written as "1.3.6.1.2.1.2.1". In custom probe files, it
should be represented as "1.3.6.1.2.1.2.1.0". (This ".0" is technically part of the
OID - it's convenient not to write it, though.)
Table variables are generally suffixed with the index of the row. (This isn't always
true: see the note below). For example, the Cisco Environment Monitoring MIB
defines two variables for the input air temperature and input voltage as the first
rows in each of these tables:
ciscoEnvMonTemperatureStatusValue 1.3.6.1.4.1.9.9.13.1.3.1.3
ciscoEnvMonVoltageStatusValue 1.3.6.1.4.1.9.9.13.1.2.1.3
If you add a suffix ".1" to each of these, you'll get the value of the first row; add
".2" to as a suffix, you'll get the second row, etc.
As noted above, some tables don't have a separate index column. These rows are
named (their OIDs are specified by) data in the row. For example, the OID for
tcpConnState row, the status of a particular TCP connection is
"1.3.6.1.2.1.6.13.1.1". Its index is the source and destination IP address and port
(all four values) which are appended to the tcpConnState OID. Thus, the full OID
for the state of a TCP connection from 9.8.7.6 port 543 to 123.45.67.89 port 8765
would be:
1.3.6.1.2.1.6.13.1.1.9.8.7.6.543.123.45.67.89.8765
- 733 -
Chapter 21: Troubleshooting InterMapper
Here's a great site to start learning about MIBs and all the cool things you can do
with them:
http://www.snmpworld.com/
Another is:
http://netman.cit.buffalo.edu/
http://www.simple-times.org/
http://www.simpleweb.org/
A: The "1.3.6.1.4.1..." prefix of the OID indicates that the trap is from a private
enterprise MIB. You can find out what enterprise by downloading the Enterprise
Numbers RFC from:
http://www.iana.org/assignments/enterprise-numbers
You should contact the Citrix company (or read their MIB) to find out the exact
interpretation of the trap's OID.
InterMapper will do a very good job of finding SNMP-speaking devices if you know
the devices' SNMP Read-only Community string. Detailed instructions for scanning
a subnet are available from the network scanning page. Be sure to set the default
SNMP Read-only Community String as shown in the SNMP Preferences. (Pg 254)
InterMapper may not be able to find a device for any of these reasons. (Pg 732)
- 734 -
About WINS Names
l InterMapper (all platforms) queries devices for a NetBIOS (WINS) name. This
name is used as the device's smart name if the DNS name is unknown or con-
tains the word "DHCP".
l When adding a device that is in the same LAN as InterMapper server, you can
use the device's NetBIOS/WINS name. To cause a name to be treated as a
WINS name, place "\\" in front of the name when adding a device. The name
is not looked up in the DNS.
Note: InterMapper does not use the WINS server - it only resolves local
device names.
- 735 -
Chapter 21: Troubleshooting InterMapper
InterMapper FAQs
How can I stop the InterMapper server from polling for a while?
The easiest way to stop InterMapper's polling for a while is to disable all the maps.
To do this:
Alternatively, you can disable maps individually from the Map List by right-clicking
on a map in the list and selecting the ‘Disable’ command.
How can I stop the InterMapper server? How can I restart it?
On Windows, InterMapper installs an icon in System Tray (lower right corner) that
does much the same thing.
We recommend you read the Readme file on the Downloads page for information
specific to your version.
1. Install InterMapper on the new server, and stop the InterMapper ser-
vice/daemon when installation is complete.
2. Stop the InterMapper service/daemon on the old server and copy your Inter-
Mapper Settings folder to the new platform, replacing the one created when
you installed InterMapper on the new server.
3. On the new server, start the InterMapper service/daemon.
The default location for the InterMapper Settings folder depends upon the platform
where installed:
Note: If you are migrating from Mac OS X PowerPC to Mac Intel, Windows or any
other Intel-based system, please contact [email protected] prior to
installing on the new platform. Additional steps are necessary in order to preserve
the historical chart data when migrating between these platforms.
- 736 -
InterMapper FAQs
Each version of InterMapper comes with its own uninstaller. Find the original dis-
tribution file (or retrieve the current version from http://www.in-
termapper.com/files) and use its uninstall feature.
The message "intermapperd dead but subsys locked" means that intermapperd is
not running; the daemon has either crashed or was sent an explicit kill command
by the root user. Furthermore, the InterMapper lock file /var/-
lock/subsys/intermapperd exists when intermapperd isn't running.
/etc/init.d/intermapperd restart
rm /var/lock/subsys/intermapperd
but this isn't required because the restart command does this.
Q: When I use HyperTerminal to telnet into InterMapper's server, I don't see char-
acter echoes. Why not?
With your InterMapper session loaded, choose File->Properties. Click the Settings
tab. Click the ASCII Setup... button. Check the box labelled "Echo typed characters
locally". When connecting to earlier versions of InterMapper, you should also
check the box labelled "Send line ends with line feeds". Later versions of Inter-
Mapper do not require this (although it won't hurt.) Click Ok to close the ASCII
Setup dialog, then click Ok to put away the Properties dialog. Remember to save
your session to make the new settings permanent.
- 737 -
Chapter 21: Troubleshooting InterMapper
Start your telnet session with InterMapper. Press Ctrl+] to enable the client to pro-
cess setup commands. Type "SET LOCAL_ECHO" and press Enter to turn on local
echoing. Press Enter again to return to your session. I'm not aware of any way to
save this setting for future sessions, so you'll need to do this each time.
One free Windows telnet client we have had good luck with is Putty. Putty is avail-
able at http://www.chiark.greenend.org.uk/~sgtatham/putty/. Putty requires no
configuration to work correctly with InterMapper. You may find this nicer to use
than either of the built-in options that come with Windows.
You can use the built-in serial port to drive an external modem that can in turn
send page notifications. To do this, you must disable the getty process that's usu-
ally listening on that port.
/System/Library/StartupItems/SerialTerminalSupport
ENABLE_SERIAL_TERMINAL=$TRUE
ENABLE_SERIAL_TERMINAL=$FALSE
Re-init the system, and there should be no getty and InterMapper will get to the
modem just fine. (Thanks to Charlie Winchcombe for this tip.)
- 738 -
InterMapper Flows FAQs
- 739 -
Chapter 21: Troubleshooting InterMapper
Cross-platform Questions
These questions relate to the differences between the implementations on various
platforms.
It is also possible to copy your InterMapper Settings folder and maps directly from
one platform to another. This will preserve the attached notifiers for devices in
your maps, but the procedure is slightly more complicated:
If you have any icon files in your "Custom Icons" folder, you will need to convert
these to "data-fork" based resource files. You can use the Custom Icon Conversion
Script (Pg 740) on a MacOS X computer to convert the file format. If that's not con-
venient, then send a note to [email protected]. We will do the conversion
and return the new file to you.
You must double-check your modem pager settings on the new platform; the loc-
ation of the modem device stored in the preferences file will be completely dif-
ferent.
How can I use custom icons from my Mac Classic installation on OSX?
- 740 -
Cross-platform Questions
Drag your icon files onto this droplet program, and they will be converted to a form
usable by the MacOS X version of InterMapper. Drag the resulting files to the
/Library/Application Support/InterMapper Settings/Custom Icons folder.
How can I stop the InterMapper server from polling for a while?
The easiest way to stop InterMapper's polling for a while is to disable all the maps.
To do this:
How can I stop the InterMapper server? How can I restart it?
When using the Traditional InterMapper on MacOS X, simply quit the application.
That will stop the polling. If you're using one of the server-based InterMapper ver-
sions (on OSX, Windows, or Unix/Linux), you'll need to stop the InterMapper ser-
vice/daemon separately from InterMapper or InterMapper RemoteAccess.
This script will be installed in different directories, depending on the operating sys-
tem.
l MacOS X: /Library/StartupItems/InterMapperServer/InterMapperServer
command
l Most versions of Linux: /etc/init.d/intermapperd command
l FreeBSD: /usr/local/etc/rc.d/intermapperd.sh command
Each server-based version of InterMapper comes with its own uninstaller. Find the
original distribution file (or retrieve the current version) and use its uninstall fea-
ture.
- 741 -
Index
16-bit 728
Access Control Examples 303
2
Access Control Process 280
20-bit 728
ACK 202, 206, 236, 705
24-bit 728
Acknowledgements 202, 389, 427
24 Hour Time 228, 272
Acknowledge-message 236
3
Acknowledge Message
32-bit subnet 727 Window 389
- 742 -
Index
- 743 -
Apps to BEGIN IMPORTS
- 744 -
Index
Benchmarks 640 C
Setting 640 Can't obtain/lock PixMap 236
Big Brother Probes 607 Capacity/bandwidth 610
Big Brother State 607 Census 643
Big Brother System 607 Certificate 310
Big.dartware.com 714 Certificate Authority 310
Bits 148 Certificate Signing Request win-
Block 203, 726 dow 312
- 745 -
Chart Defaults to Comment
Comment 388
- 746 -
Index
- 747 -
Create Log File window to DDis
New Map 57 D
New User 298 D<name 712
Reverse Connection 431 Daemon 25, 740
Sub-maps 71 start 740
Create Log File window 232 stop 740
Critical 89, 134, 143 Dartware
Cross-platform Questions 740 DARTWARE-MIB
CSR 277, 310 DEFINITIONS 179
Dbug 238
DDis 611
- 748 -
Index
- 749 -
Developer Guide to Disable
- 750 -
Index
DNS 58, 60, 65, 106, 166-167, 179, Double-click Actions 83, 387
238, 260, 262, 312, 398, 407,
Down 89, 129, 133, 154, 167, 179,
416, 427, 596, 602, 642, 687,
206, 236, 246, 388, 440, 596,
726, 730, 735
702
change 730
generate 89
determine 238
set 388
DNS-Related Messages 238
DOWN-ACK 705
DNS Check 730
DOWN list 705
DNS Monitor Preferences 263, 730
Down Thresholds 89
Setting 262
Downloadable 19
DNS Monitor prefs 730
Downloading 734
DNS Name 416, 655, 692
Enterprise Numbers RFC 731
DNS x.x.x.x 238
Drag 119, 278
DNS z.z.z.z 238
firewall 278
DNS/WINS Settings 262
Dropdown menu 43, 78, 400
Use 262
Dt 239
DNSName 639, 650, 656
DUcast 611
enter 65, 388
Duplicate 131, 309
monitoring 730
processing 238
see 602
- 751 -
E-mail to Encrypted
E-mail 9, 39, 129, 133, 139, 144, Edit Device Label window 106
241, 248, 264, 726 Edit E-mail Message window 145
Configuring 144 shows 144
enter 144, 264 Edit Label 268
outgoing 264 Edit List 147, 153
send 129, 133, 144, 264 Edit Map 95, 384
specify 129 Edit menu 39, 86, 99, 104, 106, 118,
Use 144 132, 140, 153, 211, 250, 253,
257, 268, 271, 283, 290, 292,
E-mail Notification Message 144 308, 311, 374, 380, 730
E-Mail Notifier 144 From 730
Configuring 144 Use 374
E-Mail Preferences 264 Edit Message 141, 147, 155, 162, 165
Setting 264 Edit Network Label dialog 106
Echo 404 Edit Network Label window 106
Edit 42, 65, 79, 106, 131, 145, 180, Edit Notifiers 92, 133
186, 188, 211, 220, 257, 265,
268, 277, 298, 308, 384, 387 Edit window 80
- 752 -
Index
Enter 55, 65, 68, 73, 83, 89, 125, downloading 734
144, 155, 162, 167, 202, 226,
Env 712
262, 264, 271, 278, 283, 290,
292, 300, 303, 377, 388, 405, ERR 237
411, 432, 598, 719, 730-731
Err/Minute 693
Address Ranges 278
Error 208, 237, 695, 702
Community 719
Setting 208
DNS 65, 398
Error Page 695
e-mail 144, 264
Error/min 692
FQDN 730
ERRORS 702
Host 264
Errors-per-minute 208
ID 155
Errors-To 264
IP 155, 299, 303, 404, 430
ErrorThe ERROR 702
IP Address 167
ESCAPED_MESSAGE 160
IP subnet 68
Ethernet 99, 116, 422, 610
iPing 162
represent 116
list 262
Ethernet 10/100 722
Map Name 73
Evaluation Serial Number 19
Multiple Licenses 24
Request 19
Name 375
Event 146, 257
OID 731
Event Log 235, 703
SNMP Community 405
Event Log file 202, 235, 260, 655
SNMP Read-only 598, 731
Event Log Messages 236
subnet 125
Event Log window 235, 237, 427
TCP 283, 290, 292
open 235
URL 55, 83, 290
- 753 -
EventLog file to Format/Options
EventLog file 206 File Menu 46, 57, 59, 85, 374-375
- 754 -
Index
G Handle 78
URL 78
General Messages 237
HCOctets 610
General Rules 436
Help 247-248, 702
Generate 89, 311
Help Menu 374, 430
1,024-bit 311
Use 374, 430
CSR 310
Helper App 55, 83
Down 89
Helper Applications 78
Warning 89
Editing 79
- 755 -
Helper Applications Customize window to IfInErrors MIB
- 756 -
Index
- 757 -
Includes to InterMapper Prefs file
Includes 21, 57, 78, 687 Interfaces window 195, 206, 387
- 758 -
Index
- 759 -
Invalid Probe Human Name to Label Position
- 760 -
Index
- 761 -
Logs submenu to Map List window
viewing 374 Map 41, 53, 57, 68, 99, 124, 180,
181, 208, 296, 303, 305, 375,
Logs submenu 235, 246, 257
631, 635, 640, 649, 691
Long-term Packet Loss 200
Switches 124
Longitude 388, 640, 650
Understanding 181
Loopback 727
Map's Colors 87, 266
Lost Packets 439
Setting 86
Lower-left 414
Map's Default Device Thresholds 89
Lower Bounds 227, 271
Setting 86
M
Map's Default Notifiers 92
Mac 187, 732 Specifying 92
MAC Address 693 Map's Default Traffic Thresholds 91
Mac OS 142, 611, 628-630 Setting 86
Mac OSX 150 Map Access 281, 305
Macintosh 436, 601 Controlling 305
MacOS 25, 78, 262 Map Access Panel 305
function 26 Map Access Permission Levels 306
InterMapper 262 Map Area 45
MacPing Map Attributes 675
find 719 Map Background 99
Mailto MyProbe 242 Setting 99
Main Logger 130 Map Benchmark 404
Syslog 129 Map Data 637
Management Information Base 731 Map Edit 384, 391
Managing 301 Map Editable 180
Users 298 Making 180
Manual Entry 58 Map Editor 181, 374, 404
Manually-connected 69 Map Files 296, 632
remove 69 Map Legend 44
- 762 -
Index
Map Settings 86, 132, 211, 253, 380 Menu Bar Application 25
Matches 278, 280, 300, 601, 650 Modem Pager Settings window 153
- 763 -
Monitor menu to Network. Add Network
- 764 -
Index
Notifier List 92, 129, 131, 133, 140, Numeric Pager 153
153, 162, 308
Notification Using 153
edit 308
O
open 130
OBJECT IDENTIFIER 179, 731
Use 131, 308
- 765 -
OCTET STRING to Paging Services list
- 766 -
Index
Paging Settings window 148 PNG 99, 103, 243, 375, 635, 640
- 767 -
Print Sharing to Redirect
- 768 -
Index
- 769 -
RPkt to Send E-Mail
- 770 -
Index
Server Configuration Overview 277 Set 86, 99, 101, 136, 142, 146, 208,
226, 254, 257, 262, 264, 268,
Server Information 251, 722
276, 279, 388, 607, 640, 690,
Server Information Overview 251 719, 727, 730
- 771 -
Set Address to Show/Hide Checkbox
- 772 -
Index
Chicago 71 If 60
SNMP 58, 60, 129, 143, 167, 177, SNMP Information 731
182, 185, 239, 254, 388, 405,
SNMP MIB 610, 732
- 773 -
SNMP MIB-II to Specifying
- 774 -
Index
Spreadsheet-style Import file 639, Status window 183, 185, 202, 206,
649 387, 722
SSLCACertificateFile 313 Stop 25, 60, 237, 282, 289, 291, 740
InterMapper 25
- 775 -
Sub-maps to Tab-Delimited TEXT File
pkts 704 T
Sum In 692 Tab-Delimited TEXT File 375
- 776 -
Index
- 777 -
Tlnt TELNET to Unknown HTTP Command
Top Rx 186 U
Top Tx 186 UCD-snmp 732
TotalErrors 611 UDP 256, 439, 611, 730
TotalPkts 611 UDP Port 162 Check 254
TPkt 697, 704 Un-Acknowledge 204-205, 387
Traceroute 65, 405 Un-hiding Detail 128
Traditional 101 UNAC 236
service/daemon 740 Unacknowledge 203, 206
Traditional InterMapper on Undo 380
MacOS 741
Undo/Redo 381
Traffic 91
Unencoded 688
Traffic Thresholds 208
Unencrypted 254
Transition 146
Uninstall 741
particular device state sends mul-
tiple notifiers 146 Uninstaller 741
Transmit bytes/second 608 Unix 150, 162, 166, 262, 714, 740
- 778 -
Index
- 779 -
Using Auto-discover to VLAN
- 780 -
Index
Warning 44, 89, 129, 133, 143, 182, Window>Logs>Debug menu 433
439 Windows 25, 59, 68, 78, 142, 150,
Alarm 130 162, 262, 276, 404, 411, 436,
601, 631, 702, 740
generate 89
Windows 2003 25
WAV 142, 633
Windows CA 313
Web 280, 282, 303, 305, 383
Windows menu 221, 223, 235, 246,
Web-based Service 643 257, 374, 425
Web Device List 700 Charts submenu 223
Web Page 633, 689 Logs submenu 257
Customizing 690 Use 374
Reloading 690 Windows Networking 604
Web Server's Stop button 289 Windows NT 601
Web Server firewall 290 running 601
addresses 290 Windows NT Services Probe 601
Web Server Messages 243 Windows NT/2000/XP 373, 741
Web Servers 104, 289, 689 Windows Only 165
access 290 Windows OS 601
Connecting 290 Windows popup window 25
start 289 Windows Server 2003 604
stop 289 Windows XP 25
use 290 running 601
Using 689 Windows, Unix 436
Week 228, 272 WINDOWS/Profiles/user/IMRemote
Show Day 228, 272 724
- 781 -
WINS to Zoom
Setting 262
Enter 262
leave 263
WINS/NetBIOS 263
X-axis 272
XCoordinate 654
XP 601
XP Home
running 601
Y-axis 228
YCoordinate 654
Choose 425
In On 180
- 782 -