gns3-client is a Python library that can be used to interact with a GNS3 server using its HTTP REST API. A GNS3 server manages emulators or hypervisors such as Dynamips, VirtualBox or Qemu/KVM.
This library does not aim at explaining nor documenting in any way the GNS3 server API. Please check the GNS3 server official documentation for further information.
Tests provide a very good starting point.
You'll need a GNS3 server appliance or virtual machine to use the library. Instructions on how to install a server appliance or virtual machine can be found on the GNS3 website.
pip install gns3-client
You'll need a GNS3 server appliance or virtual machine to test the library. Instructions on how to install a server appliance or virtual machine can be found on the GNS3 website.
Location of this test server is provided via these 2 environment variables:
| Environment variable name | Description | Example |
|---|---|---|
GNS3_SERVER_URL |
The URL of the GNS3 test server | http://gns3.example.com:3080/v2 |
You then simply need to perform a python -v tests/.
In this version, all CRUD operations of the following object types have been implemented:
- projects
- templates
- nodes
- links
- drawings
Please read CONTRIBUTING.md for details on our code of conduct.
poetry build
poetry publish
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Olivier Desnoë - Initial work - Albatross Networks
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details