https://github.com/tux-00/network_miner

Network Miner generates a network map by sending SNMP requests (LLDP/CDP/EDP).
https://github.com/tux-00/network_miner

cdp edp lldp network network-diagram network-map snmp

Last synced: 3 months ago
JSON representation

Network Miner generates a network map by sending SNMP requests (LLDP/CDP/EDP).

• Host: GitHub
• URL: https://github.com/tux-00/network_miner
• Owner: tux-00
• License: gpl-3.0
• Created: 2015-08-05T12:48:00.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-02T07:09:51.000Z (almost 8 years ago)
• Last Synced: 2024-07-27T16:45:42.110Z (6 months ago)
• Topics: cdp, edp, lldp, network, network-diagram, network-map, snmp
• Language: PHP
• Homepage:
• Size: 1.04 MB
• Stars: 37
• Watchers: 9
• Forks: 12
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Network Miner

=============

[![Code Climate](https://codeclimate.com/github/tux-00/network_miner/badges/gpa.svg)](https://codeclimate.com/github/tux-00/network_miner)

Network Miner generates a network map by sending SNMP requests (LLDP/CDP/EDP).

![D3.js display](http://i.imgur.com/RkQj2EF.png)

## Table of contents:

- [Installation](#installation)

- [Test files](#test-files)

- [Roadmap](#roadmap)

- [Wiki](#wiki)

# Installation

**Prerequisite**

* LLDP, EDP or CDP need to be enabled on your SNMP devices.

* You need a web server with the php snmp plugin/package enabled.

* SNMP SysName need to be matching with a DNS record.

**Installation**

* Clone this repository into your sites location (e.g. /var/www/) :

`git clone https://github.com/tux-00/network_miner.git`

* Download dependencies :

`cd network_miner`

`bower install`

Refer to [bower.io](http://bower.io/) for informations about installation.

* Run index.php in your web browser.

**Docker**

To use the docker image just pull the repository :

```docker pull tofu00/network_miner```

and run the image :

```docker run -d -it -p 80:80 tofu00/network_miner```

You can change the port mapping with the *-p* paramater.

# Test files

You can test the Network Miner rendering without the appropriate environment.

To test Network Miner, you need first to overwrite *data/snmp_data.json* with the content of a test file located in [test/data/](test/data/).

Now comment these lines in *data_mining.php* to avoid the scan and the overwrite of *snmp_data.json*:

```php

recursive_search($FIRST_DEVICE, 1);

file_put_contents('./data/snmp_data.json', json_encode(array('nodes' => $nodes,

 'links' => $links)),

 LOCK_EX);

```

**JSON data faker**

If you want to submit data for testing purpose you can use the [json_data_faker.py](test/data/json_data_faker.py) Python 2.7 script to fake every device names in your JSON file.

To use this script you need to install *faker* module with `pip install fake-factory`.

Just put the script at your json files location and execute it: `python json_data_faker.py`.

The script will scan the current folder, find the json files and replace device names.

# Roadmap

* Get SNMP informations from a specific device

* Autorefresh map data

* Save maps as PDF, PNG ...

* Icinga plugin

# Wiki

For more information, see the [Wiki](https://github.com/tux-00/network_miner/wiki) section.