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:

  1. Right-click on Network Maps in the object tree

  2. Select Create > Network map…​

  3. Enter a name and, optionally, an alias for the map

  4. Select the map type

  5. Select the canvas type: Graph (free-form canvas) or Geographical (objects placed on a geographic map at their location coordinates)

  6. Optionally select a Template network map (see Template Maps)

  7. 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.

Cloning Maps

An existing map can be cloned to create a full copy, including all objects, links, and settings.

To clone a map:

  1. Right-click on the map in the object tree

  2. Select Clone…​

  3. Enter a name for the new map

Unlike template maps, cloning copies all map elements including objects and links.

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, then choose from the object selector

Adding Links

To create a link between two objects on the map:

  1. Select both objects (click the first, then Ctrl-click the second)

  2. 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.

Group Boxes

Group boxes visually group related objects on the map. They appear as labeled rectangles behind the grouped objects.

To add a group box:

  1. Right-click on the map background

  2. Select Add decoration > Group box…​

  3. Enter a title and configure the appearance

Images

Static images can be placed on the map for branding, floor plans, or annotation purposes.

To add an image:

  1. Right-click on the map background

  2. Select Add decoration > Image…​

  3. Choose an image from the Image Library

DCI Container

A DCI container displays live DCI values on the map.

To add a DCI container:

  1. Right-click on the map background

  2. Select Add DCI container…​

  3. 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:

  1. Right-click on the map background

  2. Select Add DCI image

  3. Define rules with value conditions and assign an image from the image library to each

  4. 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.

Layout and Display Options

Map Size

The map canvas size can be configured to accommodate large topologies. By default, the map auto-sizes to fit its content.

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:

  1. Right-click on the map in the object tree

  2. Select Enable public access…​

  3. A dialog displays the access token and direct access URL

  4. 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 the BaseURL server configuration hint)

  • <token> — a persistent authentication token issued for the built-in anonymous user 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.

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.