ehlers
/
gns3api-python
1
0
Fork 0
Code Issues Pull Requests Releases Activity
gns3api - Simple python module to access the GNS3 API
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 Commits
1 Branch
0 Tags
64 KiB
 
Branch: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Bernhard Ehlers eff0ee17ee
Update repository URL 		9 months ago
.gitignore Support package management 3 years ago
LICENSE Initial commit 5 years ago
README.md Support only Python3, drop Python2 2 years ago
get_console Applications don't need to handle OSError, gns3api takes care 2 years ago
gns3api.py Check for valid method 1 year ago
setup.py Update repository URL 9 months ago
start_nodes Applications don't need to handle OSError, gns3api takes care 2 years ago
test_api Applications don't need to handle OSError, gns3api takes care 2 years ago

README.md

gns3api - Simple python module to access the GNS3 API

This module provides an easy access to the GNS3 API, see https://gns3-server.readthedocs.io/ .

Warning: The module is not yet stable, it may change at any time.

Usage:

  • create an API object
    api = gns3api.GNS3Api()
  • access the API
    data = api.request('POST', '/v2/version', {"version": "0.1"})

Restrictions:

  • Notifications are not supported

Requirements:

  • Python 3.x
  • GNS3 2.x

Installation:

Either copy gns3api.py into the same folder as your program or install it with python setup.py install.

Examples:

test_api is a small program to test some basic API calls.

get_console is a simple application to get the console port of a node.

start_nodes starts the nodes of a project one by one.