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 connected objects

Custom Color

User-defined fixed color

Script

Color determined by an NXSL script

Interface Utilization

Color reflects bandwidth utilization of the underlying interface (eight-step gradient from green through yellow and orange to red)

Interface Status

Color reflects the operational status of the underlying interface

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.

Format strings support the following placeholders:

  • %s — current DCI value as string (standard printf-style conversions such as %d and %.2f also work)

  • %*s or %{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.

Routing Algorithms

Algorithm Description

Map default

Use the routing algorithm configured for the map (Direct or Manhattan)

Direct

Straight line between objects

Manhattan

Right-angle routing (horizontal and vertical segments only)

Bend points

Manual routing with user-placed waypoints

Link Styles

Style Description

Map default

Use the line style configured for the map

Solid

Continuous line

Dash

Dashed line

Dot

Dotted line

Dashdot

Alternating dashes and dots

Dashdotdot

Alternating dashes and double dots

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

Physics-based layout where connected objects attract and unconnected objects repel

Radial

Objects arranged in concentric circles around the graph root

Horizontal Tree

Hierarchical layout with objects arranged left-to-right

Vertical Tree

Hierarchical layout with objects arranged top-to-bottom

Sparse Vertical Tree

Variant of the vertical tree layout

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

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

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.

Object Display Mode

Controls how objects appear on the map:

Mode Description

Icons

Standard icons (default)

Small Labels

Compact text labels without icons

Large Labels

Larger text labels

Status Icons

Show only status-colored icons

Floor Plan

Objects positioned on a floor plan background

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.