Network Maps Reference
This page provides a complete reference for network map properties, link types, element types, layout algorithms, and display options in NetXMS.
For procedures on creating and editing maps, see Network Maps.
Map Types Reference
| Map Type | Description |
|---|---|
Custom |
Manually created map with user-placed objects and links |
Layer 2 Topology |
Auto-generated map showing physical (switching) topology |
IP Topology |
Auto-generated map showing Layer 3 (routing) topology |
Internal communication topology |
Shows internal communication paths between NetXMS components (agents, proxies, server) |
OSPF Topology |
Auto-generated map from OSPF routing data |
Hybrid Topology |
Builds Layer 2 topology, then connects remaining unlinked segments using OSPF and IP topology data |
Link Properties
Each link has configurable properties:
| Property | Description |
|---|---|
Label |
Optional display label for the link |
Connector Name 1 |
Label shown at the first endpoint |
Connector Name 2 |
Label shown at the second endpoint |
Interface (per connector) |
Interface associated with each endpoint, selected per connector |
Color Source |
How the link color is determined |
Routing Algorithm |
How the link line is drawn on the map |
Line style |
Line style for the link (map default, solid, dash, etc.) |
Line width (0 for map default) |
Line width in pixels |
Label Position |
Percentage along the link where the label appears (0-100) |
Exclude from automatic updates |
Exclude this link from automatic topology updates and the link styling script |
Link Types
On auto-generated topology maps, links are assigned a type based on the detected connection between objects. On custom maps, links default to the Normal type.
| Link Type | Description |
|---|---|
Normal |
Standard network connection |
VPN |
VPN tunnel connection |
Multilink |
Aggregated link (LAG/port channel) |
Agent Tunnel |
Agent tunnel connection |
Agent Proxy |
Agent proxy communication path |
SSH Proxy |
SSH proxy communication path |
SNMP Proxy |
SNMP proxy communication path |
ICMP Proxy |
ICMP proxy communication path |
Sensor Proxy |
IoT sensor proxy path |
Zone Proxy |
Zone proxy communication path |
WiFi Client |
Wireless client association (generated on Layer 2 and Hybrid topology maps when "Include WiFi clients" is enabled) |
Link Color Sources
| Color Source | Description |
|---|---|
Default |
Uses the default link color from map settings |
Object Status |
Color reflects the worst status of the objects selected for the link. Include active thresholds into calculation also takes the most severe active threshold of the link’s data sources into account. Include interface utilization into calculation can replace the status color with the interface utilization color (see below), based on the highest outbound utilization among the interfaces selected for the link; a Critical status takes precedence |
Custom Color |
User-defined fixed color |
Script |
Color determined by an NXSL script |
Interface Utilization |
Color reflects the higher outbound utilization of the link’s two interfaces, in eight bands: gray (under 1%, or no utilization data), then purple from 1%, dark blue from 10%, light blue from 25%, green from 40%, yellow from 55%, orange from 70%, and red from 85% |
Interface Status |
Color reflects the operational status of the underlying interface |
Interface Utilization
The server calculates the inbound and outbound utilization of an interface from its traffic DCIs: DCIs whose related object is the interface and whose system tag starts with iface.inbound. or iface.outbound..
Tags ending in .util hold a percentage; tags ending in .bits or .bytes hold a rate in bits or bytes per second, which is divided by the interface speed (bytes are converted to bits first).
The interface speed must be known (non-zero) for any of them, including .util.
Only outbound utilization feeds the link color; one link end with a valid value is enough.
The DCIs created by the Interface Traffic templates (see Interface Traffic Template Attributes) have both. For a DCI created by hand, select the interface as Related object and an interface traffic Interpretation on its Other Options property page (see DCI Reference); without these settings, the DCI does not update the interface’s utilization.
Link Data Sources
Links can display DCI values as labels. Configure data sources in the link properties to show real-time metrics (bandwidth, error counters, etc.) directly on the map.
Each data source has a Position on the link (Center or next to one of the two endpoints) and a Data direction (None, or one of the two directions between the link endpoints); a value with a direction is shown with a direction arrow. The data direction can also be set from NXSL.
Format strings support the following placeholders:
-
%s— current DCI value as string (standardprintf-style conversions such as%dand%.2falso work) -
%*sor%{m}s— value scaled with multipliers; whether decimal (K, M, G, …) or binary (Ki, Mi, Gi, …) multipliers are applied is determined by the DCI’s measurement unit -
%{u}s— value with the DCI’s units appended -
%\{u,m}s— value with units and multipliers combined -
%%— literal percent sign
The long flag forms %{units}s and %{multipliers}s are also accepted.
Element Types
| Element Type | Description |
|---|---|
Object |
Network object (node, subnet, container, etc.) |
Decoration (Group Box) |
Visual grouping rectangle |
Decoration (Image) |
Static image from image library |
DCI Container |
Live DCI value display |
DCI Image |
Conditional image based on DCI value |
Text Box |
Static text with optional drill-down |
DCI Container Properties
| Property | Description |
|---|---|
DCI List |
One or more DCIs to display, each with a format string |
Background Color |
Container background color |
Text Color |
Color of the DCI values text |
Border Color |
Color of the container border |
Show Border |
Whether to draw a border around the container |
Each DCI in the list has a format string that controls how the value is displayed.
The format string uses %s as a placeholder for the current DCI value; %\{u,m}s appends units and applies multipliers (see the format placeholders above).
For table DCIs, you must also specify the column name and instance value to identify which cell to display.
Layout Algorithms
| Algorithm | Description |
|---|---|
Manual |
Objects are placed manually by the user (default for custom maps) |
Spring |
Force-directed layout that starts from the radial arrangement and avoids adding link crossings. The result is the same every time and on every machine |
Radial |
Objects arranged in concentric circles around the center of each connected part of the map |
Horizontal Tree |
Hierarchical layout with objects arranged left-to-right, starting from the center of the graph |
Vertical Tree |
Hierarchical layout with objects arranged top-to-bottom, starting from the center of the graph |
Sparse Vertical Tree |
Vertical tree starting from the center of the graph. In map views, objects are spaced 100 pixels apart and, unlike the other automatic layouts, the layout does not fit the map size and can grow past it. In dashboards, the tree is first fitted to the available area, then objects that overlap in a row are moved at least 10 pixels apart and parent objects are centered over their children |
Display Options
| Option | Description |
|---|---|
Status background |
Show status color as background behind objects |
Status icon |
Overlay status indicator icon on objects |
Status frame |
Draw colored frame around objects reflecting status |
Translucent label background |
Draw object labels with a translucent background |
Show link direction |
Draw direction indicators on links |
Display traffic data |
Show interface traffic data on links: a single label in the middle of the link shows the value for each direction with arrows parallel to the link; the value for each direction is taken from the first link end that has an interface traffic DCI for it |
Merge parallel links / Number of links to show unmerged between objects |
When more than the given number of links (1-100, default 2) of the Normal type connect the same two map elements, they are drawn as one merged link whose labels and tooltip list all member links and whose color is that of the most critical member. Merged links have no properties or bend point editing. Map views without a map object (ad-hoc L2/IP topology maps, dashboard map elements) use the default of 2 |
Disable link texts update |
Do not automatically update link labels from topology data |
Calculate map status based on contained object status |
Calculate the map object’s own status from the statuses of objects on the map |
The view menu of every map view also has a Merge parallel links toggle that switches merging off or on for that view.
Map options also define defaults applied to links that use map defaults — default routing algorithm, color, style, and width — and, for auto-generated maps, topology generation options.
NXSL Classes
Network map scripting uses the following NXSL classes:
-
NetworkMap— represents the map object; provides read-only attributes only and has no methods -
NetworkMapLink— represents a link between elements; link manipulation is done through its methods
There is no NXSL class for map elements.
See NXSL Reference for class documentation.