{"id":19756758,"url":"https://github.com/thebracket/router_mapper","last_synced_at":"2025-02-28T02:18:55.377Z","repository":{"id":210086513,"uuid":"725692995","full_name":"thebracket/router_mapper","owner":"thebracket","description":"Experimental SNMP code to read routers and figure out a hierarchy from IP address and gateway information","archived":false,"fork":false,"pushed_at":"2023-12-05T14:28:42.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-10T22:41:05.210Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thebracket.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-30T17:15:21.000Z","updated_at":"2023-11-30T17:15:35.000Z","dependencies_parsed_at":"2023-12-05T15:55:32.091Z","dependency_job_id":null,"html_url":"https://github.com/thebracket/router_mapper","commit_stats":null,"previous_names":["thebracket/router_mapper"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebracket%2Frouter_mapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebracket%2Frouter_mapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebracket%2Frouter_mapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thebracket%2Frouter_mapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thebracket","download_url":"https://codeload.github.com/thebracket/router_mapper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241088972,"owners_count":19907664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T03:16:50.437Z","updated_at":"2025-02-28T02:18:55.348Z","avatar_url":"https://github.com/thebracket.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Router Mapper\n\n\u003e This is experimental. Please don't expect much at this point.\n\nThis project queries SNMP data from routers. It obtains:\n\n* The router's system description data\n* All IP addresses associated with the router\n* The router's default gateway\n\nThis information is then combined into a tree (which can be multi-headed), and a hierarchy of routers is determined based on gateway-IP mappings.\n\n## Usage\n\nIn the base directory, copy `router_list.csv.example` to `router_list.csv` and edit the file to include routers you want to query. For example:\n\n```csv\n# List of IP addresses and SNMP communities to query.\n# IPv6 is supported for reading - but really not recommended at this point.\n# Rename this file from .example to .csv, and put actual data into it.\nIP, Community\n192.168.1.1, public\n```\n\n\u003e It's a great idea to rename your `public` community to something else.\n\nOnce that's in place, you can run the tool with `cargo run` (or `cargo run --release` to go faster). You will see output similar to the following:\n\n```\n2023-11-30T17:05:49.443446Z  INFO router_mapper: Router Mapper 0.0.1 is Starting\n2023-11-30T17:05:49.761790Z  INFO router_mapper: Queried 9 routers in 0.32 seconds\nPaquin-Edge\n----\u003e A router\n----\u003e A router\n-------\u003e A router\n-------\u003e A router\n----------\u003e A router\n-------------\u003e A router\n-------------\u003e A router\n-------\u003e A router\n```\n\nEventually, this is intended to be a useful addition to the LibreQoS network mapping system. For now, it's a toy. Enjoy.\n\n## Configuration\n\nThe tool will run on its own, but if you want to adjust options you need to create a file\nnamed `router_mapper.toml`. In this file, you can set options:\n\n```toml\nenable_next_hop_lookup = true\n```\n\nThe `enable_next_hop_lookup` option enables compatibility with networks that combine two routing protocols, for example OSPF for local addresses and an iBGP routing reflector system. The actual `0.0.0.0` route won't be correct for these hierarchies---so an additional hop lookup is performed. It should be harmless on other systems.\n\n## Notes\n\nCurrently using a fork of `csnmp`, because the original crashes on duplicate entries in a table. Routing tables are *allowed* to have multiple entries.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebracket%2Frouter_mapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthebracket%2Frouter_mapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebracket%2Frouter_mapper/lists"}