A unified REST API to provide vendor-agnostic network automation
Project description
Netman
Netman is a unified REST API that provides vendor-agnostic network automation. It abstracts the vendor-specific bits and leaves you with a clean and simplified API.
Python code usage
switch_factory = SwitchFactory(MemoryStorage(), ThreadingLockFactory())
switch = switch_factory.get_anonymous_switch(
model="cisco",
hostname="hostname_or_ip",
username="username",
password="password",
)
switch.add_vlan(1000, name="myvlan")
REST API usage
First, start the service
tox
.tox/py27/bin/python netman/main.py
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
Then you can access it by http
curl -X POST http://127.0.0.1:5000/switches/hostname_or_ip/vlans -d '{"number": 1000, "name": "myvlan"}'
-H "Content-Type: application/json"
-H "Netman-model: cisco"
-H "Netman-username: username"
-H "Netman-password: password"
Disaggregated mode
Netman supports a disaggregated mode. This is a special mode of operation where netman will use a remote netman server to access the network equipment. This mode is particularly useful in the case where your network equipment is not available to your main netman server. You can start a server somewhere, let's say at 192.168.1.1, running netman as described above. And use the proxy like this for direct code usage :
switch_factory = SwitchFactory(MemoryStorage(), ThreadingLockFactory())
switch = switch_factory.get_anonymous_switch(
model="cisco",
hostname="hostname_or_ip",
username="username",
password="password",
netman_server="http://192.168.1.1")
switch.add_vlan(1000, name="myvlan")
Or when invoked using the REST API, you can call the main server and provide the proxy netman server to be used.
curl -X POST http://127.0.0.1:5000/switches/hostname_or_ip/vlans -d '{"number": 1000, "name": "myvlan"}'
-H "Content-Type: application/json"
-H "Netman-model: cisco"
-H "Netman-username: username"
-H "Netman-password: password"
-H "Netman-Proxy-Server: http://192.168.1.1"
Docker usage
From your computer, start a Netman container and a fake-switch container in order to mock a switch Netman will configure.
$ docker-compose up -d
Create a Vlan
curl -X POST http://localhost:32771/switches/netman_tsr1.yul1.example.net_1/vlans -d '{"number": 1000, "name": "myvlan"}'
-H "Content-Type: application/json"
-H "Netman-model: cisco"
-H "Netman-username: root"
-H "Netman-password: root"
Get information of an existing Vlan
curl -X GET http://localhost:32771/switches/netman_tsr1.yul1.example.net_1/vlans/1000
-H "Content-Type: application/json"
-H "Netman-model: cisco"
-H "Netman-username: root"
-H "Netman-password: root"
Contributing
Feel free to raise issues and send some pull request, we'll be happy to look at them!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file netman-1.4.13.tar.gz.
File metadata
- Download URL: netman-1.4.13.tar.gz
- Upload date:
- Size: 183.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c3bd00b85c0ab1d4398e1d8c4290034d739e14b04ada434f5f34b71c140a3e4f |
|
| MD5 | ae33737d3ced6c53e2c0cafbeef51116 |
|
| BLAKE2b-256 | 679ef3014c5f7c580694d2569103b565cd1f3abb1dfd852bff3d9b02cc041ba9 |
File details
Details for the file netman-1.4.13-py2-none-any.whl.
File metadata
- Download URL: netman-1.4.13-py2-none-any.whl
- Upload date:
- Size: 120.6 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e51221a9f31e92e9e8602c1d4afb26df19493e3a0bfb6f0756aca62b7ad59f87 |
|
| MD5 | 8628fc48e3e67c3baf1333fe86e0bb3a |
|
| BLAKE2b-256 | b95a1208686d6380e89b92be7d03b5bec21a4b869ebda23779d0d0a9e28b141e |
