Giter Club home page Giter Club logo

nesi's Introduction

Network Equipment Simulator (NESi)

(former Softboxen)

GitHub license GitHub build GitHub build

The NESi project which originated from softboxen, a project originally created by our co-developer Ilya Etingof, aims to support different network devices of various vendors like Alcatel or Huawei.

The goal of the project is to simulate the presence of a large number of network devices (such as switches, routers, modems etc) on the network. These simulated devices expose their management interfaces and support command-line dialogues in a reasonably convincing way. The main use-case for the software is to create a testing environment for network management and automation.

For more information on softboxen or NESi please refer to our local documentation.

NESi at FOSDEM 2021 - Request for Papers

The NESi team will organize a devroom for Network monitoring, discovery and inventory. Click here for more information

Features

GitHub build GitHub build GitHub build GitHub build GitHub build GitHub build

Supported Vendors

  • Alcatel (nearly feature complete)
  • Huawei (nearly feature complete)
  • Edgecore (nearly feature complete)
  • Keymile (nearly feature complete)
  • Pbn (not implemented yet)
  • Zhone (work in progress)

Supported network components

  • Subracks
  • Cards
  • Ports
  • ONTs
  • CPEs
  • Vlans
  • Interfaces

Download

The NESi package is distributed under terms and conditions of 2-clause BSD license.

Furthermore the previous softboxen project is freely available as a GitHub repository or can be downloaded from PyPI.

Installation

Either clone the repository with the following command:

$ git clone [email protected]:inexio/NESi.git

After that, make sure you have installed the required python packages found in the requirements.txt. An easy way to do this is with the following command:

$ pip install -r requirements.txt

How to use NESi

The easiest way to play with the example CLI is to run two terminals on the NESi repo - one that starts up the REST API server and populates the example model in the underlying DB, and another that simulates the devices Command Line Interface and runs against the REST API server.

REST API terminal:

$ ./bootup/restapi.sh --keep-running [--recreate-db]

CLI terminal:

First we collect the uuid´s of all boxes

% ./bootup/box.sh --list-boxen

Vendor Alcatel, model 7360, version FX-4, uuid d8da2c00-ed28-11ea-9cc7-8c8590d3240c

Second we connect to one box with the specific uuid

% ./bootup/box.sh --box-uuid d8da2c00-ed28-11ea-9cc7-8c8590d3240c

      _   _ ______  _____ _ 
     | \ | |  ____|/ ____(_)
     |  \| | |__  | (___  _ 
     | . ` |  __|  \___ \| |
     | |\  | |____ ____) | |
     |_| \_|______|_____/|_|


Hint: login credentials: admin/secret

login:admin
Password:secret
Last login on 01.03.2020

Interactive menus will guide you through the implemented commands.

How to use debug mode

First we configure a debugger in our IDE. Therefore we add a Python Debug Server with pydevd_pycharm.

Host name   : localhost
Port        : 3001

After that we first start our debuger and add the argument '--debug' in our CLI terminal:

% ./bootup/box.sh --box-uuid <box-uuid> --debug

How to start tests

Tests can be started with the following command structure:

% ./bootup/restapi.sh --test-alcatel-commands 

For other vendors replace 'alcatel' with your desired vendor, or use:

% ./bootup/restapi.sh --help

For more information see test_structure.rst

How to add new simulated CLI

For more information on this matter, please refer to the developer's documentation.

Issues

If you find any bug or a feature you think should be implemented, you can open up an issue. We will take care of the problem as fast as we can!

Contributing

Contributions to the project are welcome.

We are looking forward to your pull requests, suggestions and fixes.

Happy Coding!


Copyright (c) 2020

Original Software Design by Ilya Etingof.

Software adapted by inexio.


All rights reserved.

nesi's People

Contributors

unkn0wn-user avatar dinker1996 avatar connyko65 avatar lostboi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.