netmonitor/README.md

26 lines
825 B
Markdown

# Netmonitor - track routers, switches and clients on a network
This script maps the active client devices in a network, by talking to
the router and switches. Each client is tracked by MAC address, VLAN and
network outlet.
## Configuration
- `router.conf`
Contains the name or IP address of the router. Only one allowed.
- `secret.conf`
Contains the snmp secret used to authenticate with the router.
- `switches.conf`
Lists the names or IP addresses of switches to be monitored,
one per line.
- `vlans.conf`
Lists the VLAN numbers to be monitored, one per line.
When reading `switches.conf` and `vlans.conf`, the script ignores
everything after the first word on each line, so each item can be
commented:
```
some.switch.example the switch under my desk
another.switch.example the other one
```