Skip to content

Getting Topology In

Everything Topolograph does starts with your link-state database. There are three ways to get it in — pick the one that matches how hands-on you want to be.

flowchart LR
    subgraph Network
      R[Router<br/>OSPF / IS-IS]
    end
    R -->|copy/paste<br/>show ... database| F[Text file]
    R -->|OSPF/IS-IS adjacency<br/>over GRE| W1[Watcher]
    R -->|BGP-LS update| GB[GoBGP + forwarder] --> W2[Watcher]
    F --> T[Topolograph]
    W1 --> T
    W2 --> T

Choosing a method

  • Text file upload

    Copy the show ... database output from one router and paste it in. Nothing to deploy; nothing touches the network.

    Best for: audits, one-off analysis, offline what-if planning.

    Text file upload

  • GRE session

    A Watcher forms an OSPF/IS-IS adjacency over a GRE tunnel and forwards live link-state changes. Works with any router that can build a GRE tunnel.

    Best for: continuous monitoring of an existing network.

    GRE session

  • BGP-LS session

    The router exports its OSPF/IS-IS topology over BGP-LS; GoBGP and the Watcher forwarder turn it into a live feed. No GRE tunnel.

    Best for: modern networks, multi-area/level, easy deployment.

    BGP-LS session

At a glance

Text file GRE session BGP-LS session
Live updates ❌ snapshot only ✅ ✅
Deploy a Watcher ❌ ✅ ✅
Tunnel required — ✅ GRE ❌
Router config none GRE tunnel + OSPF/IS-IS BGP-LS export
Carries TE attributes ✅ (opaque LSA) ✅ ✅
Good for monitoring/alerting ❌ ✅ ✅

Programmatic upload

All three methods put a topology snapshot into the same place. You can also push LSDB text through the REST API and Python SDK — including collecting it from devices over SSH automatically.

What about monitoring?

GRE and BGP-LS sessions are powered by the OSPF Watcher and IS-IS Watcher. Once a Watcher is connected, it doesn't just feed the graph — it also records every change as an event you can search, visualize and alert on. That side of the Watchers is covered in Real-Time Monitoring.