Topologies

Creating a Topology

1. Navigate to Topologies in the sidebar
2. Click Add Topology
3. Enter a name and paste or upload YAML content
4. Save

Editing

Click on a topology, then open the Edit tab to modify the YAML directly in the browser. Changes are saved to the database.

YAML Format

Topologies use the same YAML format as the npm library. See the YAML Reference for the full syntax.

name: My Network

nodes:
  - id: router1
    label: Core Router
    type: router
  - id: switch1
    label: Distribution Switch
    type: l2-switch

links:
  - from: { node: router1, port: ge-0/0/0 }
    to: { node: switch1, port: ge-0/0/1 }
    standard: 10GBASE-T

Multi-File Topology

For large networks, you can split the definition across multiple YAML files by putting a file: reference on a subgraph. Each referenced file becomes a navigable sheet in the viewer.

name: Campus Network

subgraphs:
  - id: core
    label: Core
    file: ./core.yaml
  - id: building-a
    label: Building A
    file: ./building-a.yaml

links:
  # Node ids come from the referenced files
  - from: { node: core-sw, port: eth1 }
    to: { node: bldg-a-sw, port: uplink }
    standard: 10GBASE-SR

Each referenced file (e.g. core.yaml) is a normal topology definition with its own nodes, links, and optional nested subgraphs. Links in the parent file connect nodes defined inside the referenced files by their node ids.

Linking Data Sources

In the topology Settings tab:

1. Add a Metrics Source (Zabbix or Prometheus) for real-time link utilization and node status
2. Add a Topology Source (NetBox) to auto-generate or merge topology data
3. Configure Node Mapping to associate topology nodes with monitored hosts

Sharing

Click the Share button on any topology to generate a public link. Anyone with the link can view the topology without logging in.

To revoke access, delete the share token in the topology settings.