Network Maps
Network maps provide graphical visualization of your network infrastructure in NetXMS. Maps display objects and the connections between them, with real-time status updates reflected through colors and icons.
Map Types
NetXMS supports several map types: Custom, Layer 2 Topology, IP Topology, Internal Communication, OSPF Topology, and Hybrid Topology.
See Network Maps Reference for a full description of each map type, link properties, element types, and display options.
Creating Maps
To create a new network map:
-
Right-click on Network Maps in the object tree
-
Select Create > Network map…
-
Enter a name and, optionally, an alias for the map
-
Select the map type
-
Select the canvas type: Graph (free-form canvas) or Geographical (objects placed on a geographic map at their location coordinates)
-
Optionally select a Template network map (see Template Maps)
-
Click OK
For topology-based maps (Layer 2, IP, OSPF, Hybrid), you can configure:
Seed Objects
Topology maps are built starting from one or more seed objects. The map generator discovers connected objects outward from each seed.
-
Seed node — the starting point for topology discovery
-
Discovery radius — how many hops from the seed to include, enabled with a checkbox and set from 1 to 255. When not set, the server configuration variable
Topology.DefaultDiscoveryRadius(default: 5) applies — discovery is never unlimited.
Setting a small discovery radius helps create focused maps for specific network segments rather than visualizing large parts of the infrastructure.
Template Maps
When creating a new network map, you can select an existing map as a template. The template provides initial configuration for the new map including:
-
Map settings (background image/color, canvas size, display mode)
-
Link defaults (routing algorithm, color, width, style)
-
Filter and link styling scripts
-
Discovery radius
-
Decoration elements (group boxes, images)
-
Text box elements
Object elements and links are not copied from the template — only visual settings and decorations are inherited.
This is useful for establishing consistent map styles across the organization. Create a "master" map with your preferred settings and decorations, then use it as a template for all new maps.
Editing Maps
Adding Objects
Objects can be added to custom maps in two ways:
-
Drag and drop — drag nodes from the object tree directly onto the map canvas
-
Context menu — right-click on the map background and select Add object… (Ctrl+Alt+A), then choose from the object selector
Selecting Objects
Click an object to select it, and Ctrl-click to add objects to the selection. To select several objects at once, hold Shift and drag a rectangle on the map; all elements fully enclosed by the rectangle are selected. Hold Shift+Ctrl while starting the drag to add them to the current selection instead of replacing it.
Adding Links
To create a link between two objects on the map:
-
Select both objects (click the first, then Ctrl-click the second)
-
Right-click and choose Link selected objects (Ctrl+L)
Link Properties
Links have configurable properties including name, connector labels, color source, routing algorithm, and label position.
For the full link properties reference (types, color sources, routing algorithms, styles), see Network Maps Reference.
Decorations
Maps support decorative elements that help organize and annotate the visualization.
DCI Container
A DCI container displays live DCI values on the map.
To add a DCI container:
-
Right-click on the map background
-
Select Add DCI container…
-
Configure the DCIs to display and their format
See DCI Container Properties Reference for configuration details.
DCI Image
DCI images display different images based on DCI values, allowing conditional visualization.
To add a DCI image:
-
Right-click on the map background
-
Select Add DCI image…
-
Define rules with value conditions and assign an image from the image library to each
-
Rules are evaluated top-to-bottom; the first match wins
Text Box
Text boxes display static text on the map. They can include a drill-down link that navigates to another map or dashboard when clicked.
To add a text box, right-click on the map background and select Add decoration > Text box.
Layers
Map elements — objects, decorations, DCI containers, DCI images, and text boxes — can be put on named layers, so that groups of elements can be shown or hidden together. Layers work on graph and geographical maps.
To put elements on a layer, select them, right-click, and open the Set layer submenu:
-
Select an existing layer (shown with a check mark when all selected elements are on it)
-
New layer… — enter the name of a new layer and put the selected elements on it
-
No layer — remove the selected elements from their layers
The Set layer submenu is available only when you have the Modify access right on the map. The layer assignment is saved in the map. An element is on at most one layer, and layer names are case-sensitive. A layer exists as long as at least one element is on it. Links have no layer: a link is hidden when the element at either of its ends is hidden.
To show or hide layers, use the Layers submenu in the map background context menu or in the view menu:
-
Show all and Hide all change the visibility of all layers
-
Each layer has a checkbox that shows or hides its elements
-
No layers is shown when no element of the map is on a layer
Elements without a layer are always shown. Anyone who can open the map can show and hide layers; on a map with automatic layout, the layout is calculated again for the shown elements after each change.
Which layers are hidden is saved for each map in the preferences of the management client, not in the map, so it does not change what other consoles show: the desktop client keeps it in its local preferences, and the web client keeps it on the web server for the browser (identified by a cookie). A network map element on a dashboard always shows all layers.
Layers are kept when a map is cloned, and decorations and text boxes copied from a template map keep their layers.
In the REST API, the layer is the layer property of each element of the map; an update replaces the whole list of elements and links, so send them all, with their layers.
An object that a map with automatic update removes and adds again comes back without its layer.
Layout and Display Options
Map Size
The map canvas size is set in the map properties, on the Map Background page, in the Size group: select Fit to screen to follow the visible area, or clear Fit to screen and set Width and Height in pixels. Width and Height are disabled while Fit to screen is selected.
A map with no size set uses the Objects.NetworkMaps.DefaultWidth and Objects.NetworkMaps.DefaultHeight server configuration variables.
The Increase horizontal size, Decrease horizontal size, Increase vertical size, and Decrease vertical size actions on the map toolbar change the size by 25%, and Fit to screen sets it to the visible area at the current zoom. These actions set a fixed Width and Height; they do not select the Fit to screen option of the map properties.
Automatic layouts other than Sparse vertical tree keep objects within the map size, or within the visible area on a map set to Fit to screen, so a large map on a small canvas gets overlapping objects. For example, 1500 objects on a 1920x1080 canvas leave about 37x37 pixels per object, while an object with its label takes about 150x60 pixels. Increase the map size to avoid this. Sparse vertical tree spaces objects 100 pixels apart and grows past the map size instead.
When an automatic layout is applied to a map set to Fit to screen, its available area is the visible area divided by the current zoom factor. Zooming out increases the area available to the next layout run; zooming alone does not rearrange the objects.
Grid
Grid options help align objects precisely:
-
Show grid — display grid lines on the canvas
-
Snap to grid — continuously snap objects to the grid as they are moved
-
Align to grid (Ctrl+Alt+G) — one-shot action that repositions the existing objects onto the grid
The grid size is fixed at 96 pixels.
Layout Algorithms
Automatic layout is controlled from the map’s Layout menu: the Enable automatic layout checkbox turns it on or off, and one of five algorithms can be selected — Spring, Radial, Horizontal tree, Vertical tree, or Sparse vertical tree. When automatic layout is disabled, objects stay where they were placed manually.
See Layout Algorithms Reference for details on each algorithm.
Display Options and Zoom
Maps support display options for status visualization (background, icon, frame), object display modes, and zoom levels from 10% to 200%.
See Display Options Reference for all options.
Public Access
Maps can be shared via a public URL that does not require authentication. This is useful for displaying network status on monitoring screens or kiosk displays.
To enable public access:
-
Right-click on the map in the object tree
-
Select Enable public access… (requires the Access control access right on the map)
-
A dialog displays the access token and direct access URL
-
Copy the URL for use in browser kiosk mode or embedding
Public Access URL Format
The generated URL follows this pattern:
https://<server>/nxmc-light.app?auto&kiosk-mode=true&token=<token>&map=<mapId>
Where:
-
<server>— the NetXMS WebUI server address (configured via theBaseURLserver configuration hint) -
<token>— a persistent authentication token issued for the built-inanonymoususer account -
<mapId>— the numeric object ID of the network map
The URL opens the map in a lightweight, read-only viewer suitable for embedding in iframes or running in browser kiosk mode. The map refreshes automatically.
There is no dedicated action to revoke public access.
To disable it, remove the anonymous user from the map’s access control list and delete the $anonymousAccessToken custom attribute from the map object.
Public maps display in read-only mode with automatic refresh.
| Public access maps are visible to anyone with the URL. Do not display sensitive information on publicly shared maps. |
Delegated Access
When a user has access to a map but not to all objects shown on it, NetXMS can use delegated access: the user must be granted the Delegated read access right on those objects' access control lists. Objects accessed this way are displayed with limited information (name and status only, no detailed properties).
This allows creating overview maps visible to a broader audience while maintaining object-level access control.
Map Background
The map background can be set to:
-
None — no background image; a solid background color can be configured
-
Image — a static image (floor plans, rack diagrams, site layouts) from the Image Library
-
Geographic map — map tiles displayed behind the canvas (see Geographical Maps)
When using an image background, objects can be positioned over specific locations on the image, making the map function as an interactive floor plan or site diagram.
For maps whose main purpose is geographic display, prefer the Geographical canvas type selected at map creation — it places objects on the map at their geolocation coordinates automatically.
Object Filter Script
For auto-generated topology maps, you can define an NXSL filter script that controls which discovered objects appear on the map. The filter applies to all object types placed on the map, not only nodes.
The candidate object is the script’s context: it is available as $object for any object type, and additionally as $node when the object is a node.
The map object itself is available as $map.
The script must return true to include the object or false to exclude it.
Example — show only objects in a specific container:
container = FindObject("Production Servers");
return (container != null) ? container.isDirectChild($object) : false;
Example — exclude objects with specific names:
return not ($object.name ~= "^test-.*");
See NXSL Reference for the complete scripting language documentation.
Link Styling Script
Link styling scripts allow dynamic modification of link appearance based on runtime data. The script runs for each link on the map and can modify color, width, and style. Links flagged Exclude from automatic updates are skipped.
The only variable provided to the script is $link — the link object.
The $endpoint1 and $endpoint2 variables are not available here; they exist only in a per-link color provider script (configured as the link’s color source), which is the right place to derive a link’s color from the status or data of its endpoint objects.
The color provider script also receives $link, so it can read link properties when choosing the color.
Example — style links based on their name:
if ($link.name != null && $link.name ~= "backup") {
$link.setColorConfig(2, 0x808080); // Gray for backup links
} else {
$link.setColorConfig(2, 0x00A000); // Green for all other links
}
Reference
For a full reference of element types, NXSL classes, and all configurable properties, see Network Maps Reference.