Skip to content

Commit 8486579

Browse files
authored
v2.54 BGP-LS is onboarded
Updated README.md to enhance clarity and detail about Topolograph's features and usage.
1 parent e362a5a commit 8486579

1 file changed

Lines changed: 40 additions & 23 deletions

File tree

README.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,38 @@
11
# Topolograph
2-
Topolograph.com is a Web Python-based tool, which is aimed at visualizing OSPF/ISIS topology and working with the OSPF/ISIS network offline! No any logins and passwords!
3-
The Topolograph visualizes OSPF/ISIS network topology based on LinkState DataBase scrapped from a single network device ( thanks OSPF/ISIS =). You can upload a txt file or boot up docker's version of Topolograph on your PC and the Topolograph takes OSPF via NAPALM's methods by itself. Then you can build the shortest path from a source to a destination, get backup paths, emulate link outage along the path or change OSPF/ISIS link cost on the fly! Additionally, you can simulate a device outage and see appropriate network reaction. Build reports about the network.
4-
Once you upload your OSPF/ISIS to Topolograph - you save the state of your network. After any changes on a network (i.e. redistribution from BGP to OSPF via route-maps with prefix-lists) - upload the network once again and compare them between each other.
5-
![](https://github.com/Vadims06/topolograph/blob/5bd6912d90260da6c412cae7b78e5b1024e61131/functional-topolograph-role.png)
6-
7-
### Real-Time monitoring
8-
Watcher agent for real-time monitoring of changes happened in OSPF/IS-IS domain
9-
* [OSPF Watcher](https://github.com/Vadims06/ospfwatcher) repo
10-
* [IS-IS Watcher](https://github.com/Vadims06/isiswatcher) repo
11-
## Available option
12-
* Do not require any logins and passwords - accept LSDB from txt file or via Rest API
13-
* Docker version is available. Launch local copy of Topolograph site on your PC
14-
* Once you get your network graph - build the shortests paths
15-
* Simulate a link outage and discover backup paths or backup of backup paths...
16-
* Simulate a router shutdown. Look at traffic flow around the failed router
17-
* Find the most loaded nodes and edges, fault tolerant nodes.
18-
* Check network reaction to IGP cost change on a link
19-
* Compare the network state at different times
20-
* Discover backuped/not-backuped networks in Analytics/Network heatmap
21-
* Discover asymmetric paths
22-
* Build arbitrary topologies based on YAML. Yaml file topology visualization.
2+
3+
Topolograph is a web-based Python tool designed to visualize OSPF and IS-IS network topologies and analyze them offline — with no logins or passwords required.
4+
5+
Topolograph builds OSPF/IS-IS network topology based on Link-State Database (LSDB) data collected from a single network device (thanks to the distributed nature of OSPF and IS-IS 🙂).
6+
You can upload LSDB output as a text file, or establish a GRE or BGP-LS session using OSPF Watcher or IS-IS Watcher, and visualize the topology in a local, Dockerized Topolograph UI.
7+
8+
Once uploaded, the topology represents a snapshot of your network state.
9+
After making changes — for example, redistributing routes from BGP into OSPF using route-maps and prefix-lists — you can upload the updated topology and compare it with the previous one to clearly see what has changed.
10+
11+
![](https://github.com/Vadims06/topolograph/blob/5bd6912d90260da6c412cae7b78e5b1024e61131/functional-topolograph-role.png)
12+
13+
## Key Features
14+
15+
- No logins or passwords required — accept LSDB data from text files or via REST API
16+
- Docker version available — run a local instance of Topolograph on your PC
17+
- Visualize OSPF and IS-IS network topologies
18+
- Build shortest paths between any nodes
19+
- Discover backup paths, including secondary backup paths
20+
- Simulate link failures and analyze network reaction
21+
- Simulate router failures and observe traffic flow around failed nodes
22+
- Analyze network behavior when IGP link costs change
23+
- Identify the most loaded nodes and links, as well as fault-tolerant elements
24+
- Compare network states across different points in time
25+
- Detect asymmetric routing paths
26+
- Discover backed-up and non-backed-up networks using the Analytics / Network Heatmap
27+
- Build and visualize arbitrary topologies using YAML-based definitions
28+
29+
## Real-Time Monitoring
30+
31+
Topolograph supports real-time monitoring of changes in OSPF and IS-IS domains using Watcher agents:
32+
33+
- [OSPF Watcher](https://github.com/Vadims06/ospfwatcher)
34+
- [IS-IS Watcher](https://github.com/Vadims06/isiswatcher)
35+
2336

2437
# Supported vendors for OSPF visualization
2538
| Vendor | LSA1 | LSA2 | LSA5 | NAPALM support |
@@ -60,10 +73,13 @@ LSA 1 and LSA 2 is mandatory and have to exist in the same file. LSA 5 is option
6073
| Huawei | display isis lsdb verbose | YES, but need tested LSDB for checking it | No, (need tested LSDB for adding it) |
6174
| ZTE | show isis database verbose | YES, but need tested LSDB for checking it | No, (need tested LSDB for adding it) |
6275

76+
# Visualization via BGP-LS
77+
* Please check README of [IS-IS Watcher](https://github.com/Vadims06/isiswatcher) how to setup BGP-LS session.
6378

6479
### How to start
6580
- run commands specifically to your vendor (from Supported vendors table) on a single device ( if you have multiple areas - do it on ABR) save all commands output in a single file with .txt or .log extension and upload the file to Topolograph
66-
- upload programmatically via Rest API. Multi devices LSDBs are supported via API only (v2.34).
81+
- upload programmatically via Rest API. Multi devices LSDBs are supported via API only (v2.34).
82+
- get topology via [OSPF Watcher](https://github.com/Vadims06/ospfwatcher) or [IS-IS Watcher](https://github.com/Vadims06/isiswatcher)
6783

6884
### Expected file's extension
6985
- .txt
@@ -73,7 +89,8 @@ LSA 1 and LSA 2 is mandatory and have to exist in the same file. LSA 5 is option
7389
**YouTube**
7490
* OSPF Watcher. Real time Monitoring with instant notification. https://youtu.be/2IHbxmDVMA0
7591
* IS-IS Watcher. Track the whole IS-IS domain from a single router https://youtu.be/7ZQFSe1szk8
76-
* OSPF/IS-IS AI Agent: MCP for Network Protocols, https://youtu.be/92YBRXqZWUo
92+
* OSPF/IS-IS AI Agent: MCP for Network Protocols, https://youtu.be/92YBRXqZWUo
93+
* BGP-LS in Action: Monitoring IS-IS networks via IS-IS Watcher and Topolograph, https://youtu.be/gL0iqXgPJlE
7794

7895
## Upload OSPF LSDB to the Topolograph and Building the shortest paths
7996
This demo shows how to get OSPF topology visual and interact with it.

0 commit comments

Comments
 (0)