Rev 66 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed
v3.0.1
This script polls network switch ports to see which MAC addresses are assigned to them, then polls the arp table
on one or more routers to determine the IP address. It then uses reverse DNS to look up the name of the device
The script requires snmp to be installed (no MIB files required), and uses the perl module YAML::Tiny. On a Debian based
system, this can be installed with the command:
apt-get libyaml-tiny-perl snmp
The results are saved in a YAML file and used to initialize the internal structures if it exists, so when a device
goes off the network, the information that it was there remains available (and the date/time it was last seen). As of v3.0.1
this can be modified with the 'ttl' entry in the configuration, ie 'ttl: 4d' will remove an entry if it has not been seen for
4 days.
Since the data is stored in a YAML file, a second script, mapSwitchesCSV .pl was created to convert to a tab delimited text
file for human viewing and/or script processing.
There is also a script, csv2html which will convert the csv file (actually, tsv) to an HTML table embedded in a static web
page, optionally with some titles and a css file.
All three executables (mapSwitches, mapSwitchesCSV.pl, csv2html) respond to --help with a brief description
Files:
mapSwitches - the main file which connects to each device in config, gathers data, and updates persistent storage
mapSwitchesCSV.pl - converts stored data into a CSV (default is tab delimited)
mapswitches.cron - sample cron file to gather information hourly and generate a CSV once a day
mapswitches.css - sample csv file
csv2html - reads a tsv/csv file and emits a static web page with data shown in tabular format
The following files are not required for the system to run
mapSwitches.config.yaml.sample - sample configuration file
README - This file
makeConfig.pl.sample - generate configuration file from hash. Easier for perl programmers
pingall.pl - utility to ping all available ports on a /24 network. Used to artificially refresh arp table
The configuration file MUST be created before running the script. It can be manually created
(rename mapSwitches.config.yaml.sample to mapSwitches.config.yaml and edit) or generated makeConfig.pl.sample
(edit hash, then run)
The following file is created on first run.
mapSwitches.yaml
This is the persistent storage. It can be safely deleted at any time to reinitialize the system.
We generally set this to be run hourly, and we then generate a tab delimited text file once a day. See the sample cron file
for how we do it.
Script does not need any special permissions so can be run as any user.
mapSwitchesCSV.pl accepts two positional parameters. The first is the delimiter for the output, the second is a character to
encapsulate the columns. Default is a tab for delimiter and no encapsulation.
Tested under Devuan Jessie, connecting to HP Procurve and OpnSense router, and on HP A5120 with IPFire router