Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Wyko/netcrawl

Netcrawl is a tool designed to discover and poll one or more devices, inventory them, and then provide useful data on the processed devices.
https://github.com/Wyko/netcrawl

cdp cisco netmiko

Last synced: 5 days ago
JSON representation

Netcrawl is a tool designed to discover and poll one or more devices, inventory them, and then provide useful data on the processed devices.

Host: GitHub
URL: https://github.com/Wyko/netcrawl
Owner: Wyko
Archived: true
Created: 2017-01-26T02:34:42.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2017-03-29T17:26:18.000Z (over 7 years ago)
Last Synced: 2024-08-01T19:53:09.661Z (3 months ago)
Topics: cdp, cisco, netmiko
Language: Python
Homepage: http://netcrawl.readthedocs.io
Size: 5.4 MB
Stars: 54
Watchers: 11
Forks: 10
Open Issues: 9
Metadata Files:
- Readme: README.rst

Awesome Lists containing this project

README

========
NetCrawl
========
---------------------------------------
Network Information Gathering Made Easy
---------------------------------------

Netcrawl is a tool designed to discover and poll one or more devices,
inventory them, and then provide useful data on the processed devices.

*This package is still in development.*

Features
--------

- **Switchport Tracing**: Discover which devices and interfaces have seen a
particular MAC
- **Wireless Audit**: Discovers likely matches for rogue wireless devices
among physically connected devices on a subnet
- **MAC Audit**: Discover potential unauthorized switches on your network
- SSH and Telnet connections to network devices
- Automatically backs up device configurations
- Stores a neighbor database to find layer two connection mappings
- Auto-detect system type of newly discovered devices
- Works with Nmap to allow for discovery of both neighboring and
seperated devices
- Securely stores credentials using `keyring`_ and `cryptography`_
- Can use multiple credentials in case the first fails
- Stores device inventory using a PostgreSQL database
- Offers a single device scan to quickly get data on one device
- Concurrently runs multiple subprocesses to quickly scan devices
- Multiple ``netcrawl`` top-level processes can run concurrently to
scan different network segments (do not use ``-c`` while doing this),
or to run an Nmap scan and inventory hosts as they are discovered.

Example
--------

Scan one host with no logging output
+++++++++++++++++++++++++++++++++++++

.. code-block:: console

C:\netcrawl>run.py -sS -t 10.1.120.1 -v0

Device Name: my-device-dist-1
Unique Name: MY-DEVICE-DIST-1_EC032
Management IP: 10.1.120.1
First Serial: Name: [Switch System], Desc: [WS-C4500X-32], Serialnum: [JAE14350G30]
Serial Count: 28
Dynamic MAC Count: 920
Interface Count: 88
Neighbor Count: 22
Config Size: 26573

Locate a device on the network
+++++++++++++++++++++++++++++++

.. code-block:: console

C:\netcrawl>locate_mac.py 00FEC89232B0

* Netmiko_ - SSH and Telnet connection manager
* Manuf_ - OUI lookup

Authors
--------

* **Wyko ter Haar** - *Initial work* - Wyko_

.. _Wyko: https://github.com/Wyko
.. _Manuf: https://github.com/coolbho3k/manuf
.. _Netmiko: https://github.com/ktbyers/netmiko
.. _keyring: https://pypi.python.org/pypi/keyring
.. _cryptography: https://cryptography.io

.. |Build Status| image:: https://travis-ci.org/Wyko/netcrawl.svg?branch=master
:target: https://travis-ci.org/Wyko/netcrawl
.. |Coverage Status| image:: https://coveralls.io/repos/github/Wyko/netcrawl/badge.svg?branch=master
:target: https://coveralls.io/github/Wyko/netcrawl?branch=master
.. |Documentation Status| image:: https://readthedocs.org/projects/netcrawl/badge/?version=latest
:target: http://netcrawl.readthedocs.io/en/latest/?badge=latest