README.md

switchmng

switchmng is a documentation service for network switches.
It allows configurations of network switches like VLAN assignments on ports to be documented in a structured way and exposed via REST. It is meant to be used as a building block in configuration management for network switches. In the future switchmng might be able to query switches in a vendor-specific way to apply configuration from switchmng or to update information in switchmng.

switchmng is written in python and builds heavily on SQLAlchemy and Flask.

Usage

Using switchmng is easy! Start a local test server:

$ python -m switchmng webserver -i 127.0.0.1 -p 8000

Query switchmng:

$ curl 127.0.0.1:8000/switches/core-b-sw2/ports/2
{
  "data": {
    "name": "2",
    "target": "core-b-sw1",
    "vlans": [
      1005,
      107,
      103,
      72,
      4005,
      4007,
      9
    ]
  },
  "status": 200
}

$ curl 127.0.0.1:8000/vlans/107
{
  "data": {
    "description": "internal-b_fw0",
    "tag": 107
  },
  "status": 200
}

Installing

Install all dependencies via pip:

$ pip install -r requirements.txt

License

switchmng is distributed under the MIT license.