Skip to main content

GNS3 API Utility

A powerful command-line utility for managing GNS3v3 servers, with advanced template-based exercise creation for educational environments.

Features

Template-Based Exercise Creation

  • Server-based templates: Use existing projects on the server as templates
  • File-based templates: Import .gns3project files as templates
  • Interactive selection: Fuzzy picker for choosing templates
  • Automatic duplication: Templates are duplicated for each student group
  • Smart fallback: Prioritizes server templates over file imports

Educational Workflow

  • Class management: Create classes with multiple student groups
  • Exercise deployment: Deploy identical lab environments for all groups
  • Access control: Automatic ACL setup for student access
  • Resource management: Efficient project and node management

Developer Tools

  • CLI first: Powerful, scriptable interface
  • JSON support: Easy integration with other tools
  • OpenAPI: Full API documentation
  • Go implementation: Fast, static binary with no dependencies

Getting Started

Check out the Quick Start guide to get up and running.