LD Port Report Project aka Switch Port Mapper Tool

The Port Report Project is essentially a Switch Port Mapper Tool or a Switch Port Mapping Tool like a few other commercial products out there, except The Port Report Project is free. Right now there is no GUI or WEB interface for the project but it is in the works.

This project started off as being a simple 150 line script that did something quite simple… Its only purpose was to find MAC Addresses on a switch. Then I was asked could you also search by IP, so I added that. Now I was asked to search by Port, so I added that. Well you get where this is all going…. My goal now is to build the equivalent of other commercial port mapping tools, but Open Source….

On this page I will be keeping all the updates to this Project, so please keep checking back every now and again for updates.
You can get any revision of the Port Report tool here http://www.linuxdynasty.org/Port-Report-Project/

Any issues with the LD Port Report Project, please discuss here in the forums
This script requires, Pysnmp and Pyasn1. If you have python-setuptools, you can install it by running this..
easy_install pysnmp, easy_install pyasn1

Three things you will need for this script to work..

  1. Pysnmp
  2. Pyasn1
  3. SNMP Access to the switch you want to talk too and its community string.
To make your life easier you should do the following
  1. install python-setuptools
  2. then run easy_install pysnmp
  3. and easy_install pyasn1
  4. or you can download the 2 modules manually.
    pysnmp and pyasn1
  5. then unzip the 2 files and in each directory run python setup.py install

I am using the following revisions from the python cheese shop pysnmp 4.1.12a and pyasn1 0.0.9a

For revision 1.12 and above….. If you installed pyasn1 and pysnmp using easy_install. Please uninstall it now and install the newest revision and run python setup.py install Instead of using easy_install.
Revision history and Examples below…..
Revision 1.13 10/01/09

  • Fixed line 348 as per christianha. return nmac.lower()
    This fix will allow you to pass a MAC in all uppercase and still match though the switch is responding in lowercase.
    00 E0 B8 81 E8 B7 will now match 00 e0 b8 81 e8 b7

Revision 1.12 09/18/09

  • The report option of the script can now follow cdp neighbors using the –follow option or -f.
    When you run the command below it will create ONE CSV file per cdp neighbor it scanned.
    I was able to scan from my core Switch down to the last neighbor in the line ( 44 Neighbors in just under 20 minutes. )
    Which equaled to a little over 4K Mac Addresses
    For instance…port_report.py -d -c public -r -f

Revision 1.11 09/13/09

  • More code clean up and another increase in speed.
  • Also port_report can now follow EtherChannel
  • Added better verbosity
  • Added Sanity Checking for cdp neighbors


Revision 1.10 09/09/09

  • Code Clean up and a slight increase in speed ( by a few seconds ) during the search by mac or ip

Revision 1.9
Code changes and Added CDP Support

  • Detect CDP Neighbors during the scan for MAC Addresses or IP Addresses

Revision 1.8
Here is a quick update…..

  • I just add dns reverse lookups to the output of this script.

Revision 1.7
Adds support to the following devices..

  1. Cisco
    • Catalyst 6509 w/ Supervisor 720 running IOS
    • Catalyst 3560
    • Catalyst 3550 (SMI)
    • Cisco CIGESM series Chassis Blades
    • Cisco Catalyst 2960
  2. Foundry
    • Foundry Server Iron
  3. Nortel
    • Nortel Passport 8600
    • Nortel 5520 Ethernet Routing Switch
  4. HP
    • HP Procurve 5406xl


Revision 1.6
New additions to this revision ….

  • Support for HP Procurve Switches, ( Tested on the newer versions of HP )
  • combined switch_report.py in port_report.py.
  • Added –verbose flag

Previous Releases….

  • Search by MAC or IP or PORT



Below is an example of the integrated CDP following of switches using the -m ( –mac ) option


Below I will show you an example of the listing of MAC Addresses per Port using the n (–pname) option

Below is an example of running the –report option.. Also the report option will save the output to disk in a CSV file.

Below is an example of searching by IP Addresses -i (–ip)..

This entry was posted in Port Report Projects and tagged , . Bookmark the permalink.

Leave a Reply