1
0
Fork
You've already forked netjsond
0
A small web service providing NetJSON data extracted and/or generated from different kinds of systems that does not natively do so themselves
  • Rust 100%
2021年06月20日 01:34:03 -04:00
src Keep up with (a tiny) API change 2021年06月20日 01:34:03 -04:00
.gitignore Hello World 2021年06月16日 17:25:23 -04:00
Cargo.toml Hello World 2021年06月16日 17:25:23 -04:00
README.md Hello World 2021年06月16日 17:25:23 -04:00

NetJSOND

A small web service providing NetJSON data extracted and/or generated from different kinds of systems that does not natively do so themselves.

It does not currently provide an accurate layer 2 graph, however, layer 3 is accurately captured by bostn, which transforms BIRD's OSPF state to a NetJSON NetworkGraph. Limited layer 2 information is provided by ustn which adds information from Ubiquiti's UISP and UniFi controllers to the NetworkGraph.

Endpoints

In alphabetical order:

Graph

  • /graph/: Full NetJSON NetworkGraph of the network. This service adds a node_number JSON number property to NetworkGraph nodes. For other custom properties, please see ustn and bostn documentation.

Failure modes

  • Graph hasn't been loaded yet (the daemon was restarted and hasn't cached a graph yet): HTTP status code 503 and an error message: {"err":503,"msg":"Loading relevant information, try again in 30 seconds"}

Planned endpoints

  • /graph/ospf/: NetworkGraph of OSPF routers

  • /graph/uisp/: NetworkGraph of UISP devices

  • /graph/unifi/: NetworkGraph of UniFi devices

  • /routes/: NetJSON NetworkRoutes for the node you're connecting from

  • /routes/all: non-standard collection of NetworkRoutes for all routers on the network