1.4.2

Fix #419

.coveragerc

@@ -0,0 +1,2 @@
+[paths]
+source = gns3server

.gitignore

@@ -1,5 +1,8 @@
 *.py[cod]
 
+#py.test
+.cache
+
 # C extensions
 *.so
 
@@ -24,6 +27,7 @@ pip-log.txt
 # Unit test / coverage reports
 .coverage
 .tox
+.cache
 nosetests.xml
 
 # Translations
@@ -40,3 +44,10 @@ nosetests.xml
 
 # Gedit Backup Files
 *~
+
+#Documentation build
+docs/_build
+
+#VPCS
+vpcs.hist
+startup.vpcs

.travis.yml

@@ -1,29 +1,14 @@
 language: python
-
-env:
-  - TOX_ENV=py33
-  - TOX_ENV=py34
-
-before_install:
-  - sudo add-apt-repository ppa:gns3/ppa -y
-  - sudo apt-get update -q
-
+python:
+- '3.4'
+- '3.5'
+sudo: false
+cache: pip
 install:
-  - pip install tox
-  - sudo apt-get install vpcs dynamips
-
+- python setup.py install
+- pip install -rdev-requirements.txt
+- pip install coveralls
 script:
-  - tox -e $TOX_ENV
-
-branches:
-  only:
-    - master
-
-notifications:
-  email: false
-  irc:
-    channels:
-      - "chat.freenode.net#gns3"
-    on_success: change
-    on_failure: always
-
+- py.test -v -s tests --cov gns3server --cov-report term-missing
+after_success:
+- coveralls

AUTHORS

@@ -1 +1,2 @@
-Jeremy Grossmann
+Jeremy Grossmann
+Julien Duponchelle

CHANGELOG

@@ -0,0 +1,586 @@
+# Change Log
+
+## 1.4.2 17/02/2016
+* Fix missing format in IOU export
+* Fix number of arguments to the UDP errors on VBOX
+* Add verification when UDP tunnel is created in a VirtualBox VM. Ref #899.
+* Fixes VMware linked clone cleanup bug. Fixes #420.
+* Removed docker support from 1.4 (drop unused code)
+* Fix a crash if you create a file named IOS in the image dir
+* Disallow creating project with " in the path
+* Always look at the registry to find vmrun.exe on Windows.
+* Check for VMware VIX library version. Fixes #413.
+* Fixes VDE not working #345.
+* Do not list qemu binary with -spice in the name
+* Send command line used to start the VM to client
+* Fix crash if you have a { in your user name
+
+## 1.4.1 01/02/2016
+* VMware raise error if version is not found
+* For topologies before 1.4 manage qemu missing
+* Fixes issue with packet capture on VMware VMs. Fixes #396.
+* Fixes concurrency issue when closing multiple VMware linked clone VMs. Fixes #410.
+* Fixes "can only use tap interfaces that both already exist and are up". Fixes #399.
+* Send machine stats via the notification stream
+* Check for /dev/kvm instead of kvm-ok
+* Show a warning when starting ASA8
+* Fix error when setting Qemu VM boot to 'cd' (HDD or CD/DVD-ROM)
+* Fixed the VMware default VM location on Windows, so that it doesn't assume the "Documents" folder is within the %USERPROFILE% folder, and also support Windows Server's folder (which is "My Virtual Machines" instead of "Virtual Machines").
+* Improve dynamips startup_config dump
+* Dump environnement to server debug log
+* Fix usage of qemu 0.10 on Windows
+* Show hostname when the hostname is missing in the iourc.txt
+
+## 1.4.0 12/01/2016
+* Release 1.4.0
+
+## 1.4.0rc3 05/01/2016
+
+* API documentation update
+* Fix race condition when killing iouyap
+* Catch exception if we can't change process priority on Windows
+* Adds a handler for getting the Qemu related capabilities of the server. Currently includes just a check for KVM architectures.
+* Fixed showing of Qemu hdb_disk_interface - it showed hda_disk_interface instead, which resulted in an odd visual glitch in the GUI.
+* Made the gns3server.bat successfully start the server independent of the CWD at the time of running. It's now relative to the location of the .bat file itself.
+* Add more informations in the debug status page
+* Fix status link in GNS3 homepage
+* Fix tests on Windows
+* Fix missing boot priority order
+* A debug status page embed in the server
+* Fix test on Windows
+* Update links for new website.
+* Contributing instructions
+
+
+## 1.3.13 11/12/2015
+
+* Update links for new website.
+
+## 1.3.12 11/12/2015
+
+* Contributing instructions
+* Correctly display log messages.
+* Tentative fix for "WinError 64 The specified network name is no longer available" issues.
+* Fix minor errors reported by codacy.com
+* Add doc on how to got code coverage
+* Raise an error when you use a port outside the ranges
+* Fix asyncio error when closing the app
+* Release UDP ports when closing a Qemu VM. Fixes #323.
+
+## 1.4.0rc2 10/12/2015
+
+* Add log about wher iou capture packet
+* Replace by another TCP port if port is already used
+* Fix ProcessLookupError in Qemu
+* Increase vmrun timeout to 120 seconds. Ref #360.
+* Fixes termination notification to indicate the right process name (IOU vs iouyap). Ref #359.
+* Fixes error with non initialized uBridge. Fixes #367.
+* Remove debug that can crash qemu
+* Support VM usage for qemu
+* Raise an error if psutil version is invalid
+
+## 1.4.0rc1 12/11/2015
+
+* Raise error if server received windows path
+* Update sentry key
+* Remove NIO FIFO and Mcast (unused). Fixes #348.
+* Support VPCS 0.6.1
+* Fix duplicate of -no-kvm options
+* Raise an error if user send a non local path to remote server
+* Fix minor issues
+* Apply pep8 fix
+* Sets console end port to 7000. Fixes #343.
+* Drop netifaces (replaced by psutil). Fixes #344.
+* Correctly display log messages.
+* Tentative fix for "WinError 64 The specified network name is no longer available" issues.
+* Return relative path for dynamips images
+* Fix add existing IOS not working
+* Correctly enable faulthandler for dev version
+* Avoid test crash if GNS3 is running on the same computer
+* Allow to return an empty project name because it's allowed in creation
+* Test with python 3.5
+* Add doc on how to got code coverage
+
+## 1.4.0b5 02/11/2015
+
+* Freeze requirements for aiohttp because 0.18 doesn't support Python 3.4.
+* Fix crash in IOU config export.
+* Raise an error when you use a port outside the ranges. Fixes #739.
+* Fixes Windows named pipe issue. Fixes #340.
+
+## 1.4.0b4 19/10/2015
+
+* Support for modifications to a base Qemu VM (not a linked clone).
+* Force canceling all task when shutdown server
+* Update api documentation
+* Enforce console port for VNC
+* Fixes issue when loading a project using VMware vmnet interfaces. Fixes #319.
+* Support for NAT connection with cloud for VMware VMs. Fixes #322.
+* Change message when VMware is not installed on Linux. Ref #326.
+* Send a warning notification if there is not enough RAM left to start a VM. Implements #329.
+* Asyncio Qemu fix and raise error if coroutine not used
+* Fix asyncio error when closing the app
+* Removes VMware lock check. Fixes #328.
+* Wait for pipe file to be created before starting the remote console for VMware and VirtualBox VMs. Fixes #331.
+* Release UDP ports when closing a Qemu VM. Fixes #323.
+* Escape other usage of glob
+* Fix Dynamips identifier is already used by another router
+* Protect Dynamips against bad glob.
+* Fix issue with Qemu networking following merge.
+* OVA file support
+* Support listing images in subdirectories.
+* Catch ProcessLookupError in Qemu VM.
+* Fixes uncalled coroutine.
+* Use the correct UDP tunnel Qemu syntax for version > 1.1.0 when legacy networking is enabled.
+* VMware player linux support.
+* Prevent launching a packet capture with a non-ASCII path when using Dynamips.
+* Do not require a TAP interface to already exist. Fixes #321.
+* Do not automatically delete Dynamips bootflash file because they are necessary to restore VLANs on the c3600 platform.
+
+## 1.3.11 07/10/2015
+
+* Escape other usage of glob
+* Fix Dynamips identifier is already used by another router
+* Protect dynamips against bad glob
+* Catch ProcessLookupError in Qemu VM.
+* Use the correct UDP tunnel Qemu syntax for version > 1.1.0 when legacy networking is enabled.
+* Prevent launching a packet capture with a non-ASCII path when using Dynamips.
+* Do not automatically delete Dynamips bootflash file because they are necessary to restore VLANs on the c3600 platform.
+* Fix dynamips configuration lost when you delete a node
+* Clarify error message when we got UTF-8 chars in the iourc file
+* Check for valid FR or ATM switch mappings. Fixes #300.
+
+## 1.4.0b3 22/09/2015
+
+* Fix dynamips configuration lost when you delete a node
+* Clarify error message when we got UTF-8 chars in the iourc file
+* Use custom VMnet interfaces without host adapter when uBridge is not used. Fixes #673.
+* Automatically add the -no-kvm option if -icount is detected to help with the migration of ASA VMs created before version 1.4
+* Check for valid FR or ATM switch mappings. Fixes #300.
+* Catch exception when a process cannot be killed. Fixes #296.
+
+
+## 1.4.0beta2 17/09/2015
+
+* Fix a crash at vmware stop
+* Fix a crash when starting a VMware vm
+* Add how to add vmnet interfaces explantion in the error message
+* Fix path of VMinventory for fusion
+* Force close the keep alive when sending a 401
+* Do not automatically delete Dynamips bootflash file because they are necessary to restore VLANs on the c3600 platform.
+* Wait that an user press a key to stop gns3vmnet.exe on Windows.
+* Throw an error if ubridge as incorrect permissions. Fixes #312.
+* This may fix "The semaphore timeout period has expired" error on Windows. #311.
+* Fixes bug with VMware VM connections + moves some uBridge code to BaseVM.
+* Support for packet capture on VMware VM links.
+* Fix ProcessLookupError on _checkAlive Qemu
+* VMware Fusion support with uBridge.
+* Updates vmnet script to support Windows.
+* Do not block on .lock for VMware OSX
+* Require Dynamips version 0.2.16 to change the default QinQ Ethernet type.
+* Initial Docker support from Google Summer of Code (not enabled)
+* Check for valid FR or ATM switch mappings. Fixes #300.
+* VirtualBox VMs can only be started if powered off. Fixes #299.
+* Support of VPCS 0.8
+* Allows VMware VMs to use vmnet interfaces for connections without using uBridge. Fixes #295.
+* Fixes path to vmnet-cli on Mac OS X.
+* Updates vmnet script to support Mac OS X.
+* Fix closing project when multiple project is open
+* Fix project not closing
+* Qemu user options are at the end. It's allow user to add his own net interfaces
+* Change the way we look for Qemu path
+* Lock qemu vm during start / stop operations
+* In the error message explain how to turn off KVM support
+* Fix when you stop qemu on windows you have an error
+* Fix Qemu cannot be used on Windows
+* Allow to start server with python -m gns3server
+* Should solve the BufferError by avoiding using thread
+* Catch UnicodeEncodeError when passing unicode char as qemu options
+* EthernetSwitch: Allow to choose ethertype for QinQ outer tag.
+* Backport: fixes NAT NIO for Qemu VMs (do not launch any legacy scripts)
+* Fixes NAT NIO for Qemu VMs (do not launch any legacy scripts)
+* Lower VMware requirements to Workstation version 10 and Player version 6.
+* Fixes Unicode error. Fixes #290.
+* Don't delete Dynamips ROM files. They are used to restore the nvram.
+* Adds pywin32 dependency in setup.py for Windows.
+
+## 1.3.10 04/09/2015
+
+* Catch exception when a process cannot be killed. Fixes #296.
+* Backport: fixes NAT NIO for Qemu VMs (do not launch any legacy scripts)
+* Fixes Unicode error. Fixes #290.
+* Don't delete Dynamips ROM files. They are used to restore the nvram.
+
+## 1.4.0beta1 07/08/2015
+
+* Fix ram setting for Qemu
+* Explicit set qemu memory as MB
+* Turn off KVM for non x86 architectures
+* Send an error when vmware executable cannot be found on Linux. Fixes #288.
+* Support for CPUs setting for Qemu VMs.
+
+## 1.4.0alpha4 04/08/2015
+
+* Quote command in qemu debug logs so you can copy/paste them
+* Support for Qemu disk interfaces, cd/dvd-rom image and boot priority. Fixes #278.
+* Check for VMware Player version >= 7 and VMware Workstation >= 11. Fixes #286.
+* Catch GeneratorExit exception when trying to create a Ghost IOS image.
+* Backport: removes code that deletes IOS router instance files.
+
+## 1.3.9 03/08/2015
+
+* Backport: removes code that deletes IOS router instance files.
+
+## 1.4.0alpha3 28/07/2015
+
+* Raise error if qemu image already exist when creating disk
+* Prevent user to create a qemu to a different directory on non local server
+* VMnet manager on Linux: check that VMware has been installed.
+* Fixes UnicodeDecodeError when reading a VMware file.
+* Fixes KeyError: "ethernet0.connectiontype". Fixes #276.
+* Fixes replace errors. Fixes #284.
+* Catch ProcessLookupError when updating iouyap config. Fixes #255.
+* API for creating a qemu disk image
+* Prevent starting different hypervisors that leverage hardware virtualization (VT-x/AMD-V). Fixes #548.
+* Fixes IOS adapters and WICS cannot be removed. Fixes #282.
+* Makes sure the loop is running when closing the app.
+* Catch Permission denied when writing to VMX file while closing VMware VM. Fixes #277.
+* Catch GeneratorExit exception. Fixes #231.
+* Fixes missing chipset info for VirtualBox VM (maybe some older VirtualBox version don't have it). Fixes #254.
+* Changes how to look for the vmrun.exe location.
+* Update documentation
+* API for listing current projects
+
+## 1.3.8 27/07/2015
+
+* Catch ProcessLookupError when updating iouyap config. Fixes #255.
+* Fixes IOS adapters and WICS cannot be removed. Fixes #282.
+* Makes sure the loop is running when closing the app.
+* Catch GeneratorExit exception. Fixes #231.
+* Fixes missing chipset info for VirtualBox VM. Fixes #254.
+* Fixes IOURC upload.
+* Restore images & projects tarballs
+* Allow users to backup projects and images.
+* Update gns3.conf.upstart.
+* Fix incorrect vboxmanage sudo command.
+* Backport from 1.4: option to drop nvram & disk files for IOS routers in order to save disk space.
+* Backport from 1.4: Remove timeout to wait for connections to finish.
+* Backport from 1.4: Fixes RuntimeError: Event loop is closed.
+* Backport from 1.4: Bind host on 0.0.0.0 when checking for a free UDP port.
+
+## 1.4.0alpha2 22/07/2015
+
+* Deactivate uBridge process monitoring (process returns 1 on Windows when stopping).
+* Prevent using different hypervisors that leverage hardware virtualization. - Implemented for Qemu when a VMware or VirtualBox VM with hardware virtualization is already running. - Implemented for VirtualBox only when a Qemu VM with KVM is already running.
+* Check for uBridge version and catch uBridge errors.
+* Remove default FLASH when no hda disk for Qemu VMs. Fixes  #535.
+* Use the registry to find vmrun if the default VMware install path does not exist.
+* Bind host on 0.0.0.0 when checking for a free UDP port.
+* Fixes RuntimeError: Event loop is closed. Fixes #266.
+* Update gns3.conf.upstart
+* Implements uBridge hypervisor.
+* Take VMware file encoding into account. Fixes #261.
+
+## 1.4.0alpha1 09/07/2015
+
+* Update API documentation
+* Allow to send the iourc when starting the VM
+* Return stdout when a process crash for IOU, Dynamips, uBridge and VPCS.
+* Adds -no-kvm to the ASA template and ignore -no-kvm on platforms other than Linux. Should resolve #472.
+* Allow user to change the configuration file
+* Fix double loading of config from working directory
+* CORS support
+* Support server config in current working directory
+* List only valid existing IOS images (for IOS router wizard).
+* Checks if IOS image exist at startup and not during node creation. Fixes #240.
+* When a qemu VM crash send the log to the client.
+* Add a vm_directory field
+* Check for /dev/kvm. Fixes #245.
+* Moves KVM setting to Qemu server preferences. Fixes #244.
+* VNC console support for Qemu VMs.
+* Test all IOU requirements at VM startup
+* ACPI shutdown support for VMware VMs. Fixes #436.
+* Compute a md5sum of images for futur purpose
+* Adds gns3-netifaces to dependencies only if netifaces isn't already installed otherwise this requires a compilation and therefore the Python development files.
+* Adds an IP address for each interface returned by the interfaces API method.
+* Add log when we didn't close a project due to another client
+* Limit file size during upload
+* Convert old -enable-kvm to kvm settings for Qemu
+* Cleanup SSL certificate support
+* Improve memory consumption of file upload with the HTML form
+* systemd start script 
+* Enable KVM acceleration option.
+* Check interface is up before connecting a NIO (Linux only). Fixes #277.
+* IPv6 support.
+* Import/Export support for IOU nvrams.
+* Install qt5 for travis
+* Option to drop nvram & disk files for IOS routers in order to save disk space.
+* Drop python 3.3
+* Support for base MAC address for Qemu VMs.
+* ACPI shutdown support for Qemu VMs.
+* ACPI shutdown support for VirtualBox VMs.
+* Upload images API
+* A notification stream with process monitoring
+* VMware support 
+
+## 1.3.7 22/06/2015
+
+* Prevent install on Python 2
+
+## 1.3.6 16/06/2015
+
+* Fix an issue with 1.4dev compatibility
+
+## 1.3.5 16/06/15
+
+* Ignore invalid characters when reading the output of a process
+* Turn on / off authentication
+* Ensure no colored output on Windows
+* Do not stop saving IOS router configs when there is an exception while a project is committed.
+* Create a private config file if expected
+* Distribute our own version of netifaces working with python 3
+* Fix crash if a private config exist in IOS but no private config file
+* Basic Auth support
+* Fix crash when virtualbox list of VMS return an empty line
+
+## 1.3.4 02/06/15
+
+* Drop useless dependencie dateutil
+* Check if port or adapter is connected before starting/stopping a packet capture. Fixes #196.
+* Prevent users to add links to running Qemu VMs and start a capture on running VirtualBox VMs.
+* Fixes bug: couldn't set PCMCIA disk1 size for IOS routers.
+* Fix crash if you pass an invalid hostname
+* Catch VPCS kill errors
+* Raise a VirtualBox error if adapter doesn't exists
+* Ignore VirtualBox VM Name with a carriage return in name
+* Cleanup the temporary project after modules have been notified of the path change
+* Do not return error if we can't remove the old project directory
+* Catch encoding errors in windows logger
+* Use setter for the qemu_path (allow to pass only the binary name)
+* Fixes TAP connection when using VPCS.
+* Fix crash launching qemu on OSX from another location.
+* Adds NAT NIO in device schema validation so they can return an error that it is not supported.
+
+## 1.3.3 14/05/15
+
+* Check for empty iourc path.
+* Fixes bugs with IOS router configs. Fixes #354.
+* Use a temporary directory as egg cache
+* Catch crash error in IOU in case of permission denied
+
+## 1.3.3rc1 07/05/2015
+
+* Return an error if an adapter slot doesn't exist on an IOS router.
+* NIO NAT support for VirtualBox VMs.
+* NIO NAT support for QEMU VMs (user mode back-end is used).
+* Throw an error if user put an invalid port range in config file
+* Turn off configuration parser interpolation
+* Catch configuration file parsing errors
+* Force closing the event loop to avoid warning with Python 3.4.3
+* Catch error when you can't mark a project as no longer temporary
+* Catch BrokenPipeError for OSX frozen server
+* Match how IOU initial-config is set for VPCS VM.
+* Refactors how startup-config and private-config are handled for IOS routers.
+* Catch the "WinError 0 The operation completed successfully" exception at a higher level.
+* Fix temporary project not cleanup with save as
+* If image is not found in VM directory look in images folder
+* Ordered MAC addresses for QEMU based VMs.
+* Merge remote-tracking branch 'origin/master'
+* Force utf-8 configuraton files reading
+* Do not list file starting with a . in upload handler
+* Do not crash when closing a project if VirtualBox is not accessible
+* Catch connection reset errors
+
+
+## 1.3.2 28/04/2015
+
+* Cleanup the VirtualBox Media Manager after closing a project.
+* Avoid Cygwin warning with VPCS on Windows.
+* Close VirtualBox VM linked clone disks after the VM is unregistered.
+* TAP interface support for QEMU VMs.
+* Return an explicit error when a NIO type is not supported by a VM.
+* Do not erase the IOU config
+* Explicit utf-8 decoding.
+* Check NIO exists when stopping an IOU capture.
+* Fixes c7200 NPE setting.
+* Fixes VPCS process termination.
+* Catch FileNotFoundError exception in os.getcwd()
+* Explicit utf-8 encoding where necessary to avoid Unicode errors on Windows (we require/set an utf-8 locale on other systems).
+* Fixes #270. Relative paths management with empty ones.
+* New crash report key and doesn't send report for developers
+* Catch COM errors when connecting to WMI.
+* Don't assume the PATH environment variable exists.
+* Use UUIDs instead of the VM names for VirtualBox pipe paths.
+* Add --log options for daemon support
+* Basic upstart script
+* Add qemu-kvm to the list of binary
+* Fix IOU licence check flag
+* Config paths are not used when updating Dynamips or IOU VM settings.
+* Fixes initial-configs that were not restored when opening a project containing IOU VMs.
+* Prevent parallel execution of VBox commands
+* Fix a crash when in some cases you can't access to VBOX state
+* Fix crash if VirtualBox doesn't return API version
+* Fix a crash in VirtualBox vm creation
+* Allocate random names for Dynamips NIOs.
+* Explicitly delete Dynamips NIOs and unmap VCs for ATM and Frame-Relay switches.
+
+## 1.3.1 11/04/2015
+
+* Release
+
+## 1.3.1rc4 09/04/2015
+
+* Initial config file content can be empty (fix export issues)
+* Fix crash if IOU initial config is emtpy
+* Return more informations about bad requests for crash reports
+* Allow less strict dependencies for easier install
+* Missing project name in documentation
+* Some spring cleaning
+
+
+## 1.3.1rc3 07/04/2015
+
+* Fix missing IOU documentation
+* Add missing project name in curl documentation
+* Look in old IOU images location in order to smooth transition
+
+## 1.3.1rc2 06/04/2015
+
+* Do not overwrite initial-config IOU if client send an empty
+* Fix documentation about /ports/udp
+
+## 1.3.1rc1 05/04/2015
+
+* Fix issues with macos X dynamips not freeing UDP port
+* Fix encoding error when saving dynamips configuration
+* The upload web page return a 200 in case of error (IE compatibility)
+* Do not crash if dynamips config contain non ascii chars
+* Test path with chinese charcaters in Qemu
+* Do not crash if no console port is available for VBox
+* Raise a DynamipsError if we can't access to VM status
+* Check name of the VBoxManage executable
+* Exclude docs and tests package from distribution
+* Catch error when qemu additional options are invalid
+* Fix ClientDisconnectedError
+* Fix crash when NIO doesn't exist
+* Turn off crash report if raven not available
+* Fix crash when IOU script file is incorrect
+
+## 1.3.0 30/03/2015
+
+* Fix issue when asyncio read is cancelled and data is still sent by Dynamips hypervisor.
+* Fix unicode decode error when saving IOS router configs.
+* Fix error when missing adapter in Dynamips IOS router.
+* Fix crash if we call stop on dynamips on non started process.
+* Fix use_default_iou_values param was not set.
+* Fix issue when IOURC environment variable is set to None.
+* Fix issue when exporting IOS router configs.
+* Fix check if VPCS process is running.
+* Fix bug when remove_nio() is not a coroutine for ATM and FR switches.
+* Fix how to test if iou and iouyap are running.
+* Allocate a random port for Qemu monitor. Fixes issue with pre 1.3 projects.
+* Fix default chassis bug.
+
+## 1.3.0rc2 23/03/2015
+
+* Update sentry key
+* Prevent error when suspend/resume is not supported in QEMU VM.
+* Adds project id when requesting UDP port.
+* Make sure used ports in a project are cleaned up when closing it.
+* Save configs when project is committed.
+* Initialize chassis when creating an IOS router. Fixes  #107.
+* Lock the dynamips reader an writer
+
+## 1.3.0rc1 19/03/2015
+
+* Save IOS router config when saving the project
+* Look in legacy IOU images directory
+* Support IOURC upload
+* Configuration on UNIX
+* Support all QEMU status
+* Bind tunnel UDP to the correct source index
+
+## 1.3.0beta2 13/03/2015
+
+* Fixed issue when VBoxManage returns an error.
+* Server handler to shutdown a local server.
+* List the iourc file in upload handler.
+* Fixed hostid error.
+* Support RAM setting for VirtualBox VMs.
+* Alternative local server shutdown (intended for Windows).
+* Request user permission to kill the local server if it cannot be stopped.
+
+## 1.3.0beta1 11/03/2015
+
+* Optional IOU license key check.
+* Relative path support of IOU, IOS and Qemu images.
+* Do not give attachment warning for generic attachments in VirtualBox.
+* Support for HDC and HDD disk images in Qemu.
+* Fixed bug when starting a packet capture in VirtualBox with the project path containing spaces.
+* Renames server.conf and server.ini to gns3_server.conf and gns3_server.ini respectively.
+* Use TCP instead of Telnet to communicate with Qemu monitor.
+* Have the server look in the right place for relative image paths.
+* Fixed bugs when checking if this is a local project.
+* Concert old projects on remote servers.
+* Properly restore configs for Dynamips routers.
+* Fixed rename bug for linked clones in VirtualBox.
+* Makes absolute path checks work on Windows.
+* Upload IOURC file via the web interface
+* Upload interface allows users to choose an image type.
+* Fixed Qemu networking.
+* Fixed suspend and resume for Qemu VMs.
+* Fixed crash when you start capture on a non running IOU.
+* Fixed Telnet server initialization issue in VirtualBox.
+* Disconnect network cable if adapter is not attached in VirtualBox vNIC.
+
+## 1.3.0alpha1 03/03/2015
+
+* HTTP Rest API instead of WebSocket
+* API documentation
+* Create a dedicated configuration file for the server: server.conf
+* Temporary projects are real project
+* Use UUID instead of id
+
+## 1.2.3 2015/01/17
+
+* Fixed broken -netdev + legacy virtio in Qemu support.
+* Ping and traceroute added to the IOU VM.
+
+## 1.2.2 2015/01/16
+
+### Small improvements / new features
+
+* Auxiliary console support for IOS routers.
+* Suspend / resume support for Qemu.
+* Dynamically configure network connections of running Qemu VMs (only with recent Qemu versions).
+* VPCS multi-host support (useful for old .net labs).
+* Possibility to run VirtualBox as another user (Linux/OSX only).
+* Support for IOURC file on the server side.
+* Bumped the maximum network adapters to 32 for Qemu (depending on Qemu version you cannot go above 8 or even 28, Qemu will just not start).
+* Added snapshot named 'reset' to linked cloned VirtualBox VMs.
+* More network interface options to the Qemu VM configuration interface as well as descriptions for all NICs.
+* More checks on minimum RAM for IOS routers and updates default values to match the latest IOS image requirements.
+* Fixed bug when importing Host node with UDP NIOs.
+
+## 1.2.1 2014/12/04
+
+* Early support for IOSv and IOSv-L2 (with Qemu for now, which is slow on Windows/Mac OS X).
+* Support for CPU throttling and process priority for Qemu.
+* Fixed C7200 IO cards insert/remove issues and makes C7200-IO-FE the default.
+* Updated the IOU VM with iouyap version 0.95 (packet capture).
+
+
+## 1.2 2014/11/20
+
+* New VirtualBox support
+* New Telnet server for VirtualBox.
+* Add detection of qemu and qemu.exe binaries.
+* New host node (cloud with all available Ethernet & TAP interfaces added).
+* Option to allow console connections to any local IP address when using the local server.
+* VirtualBox linked clones support (experimental, still some problems with temporary projects).
+
+
+## 1.1 2014/10/23
+
+* Serial console for local VirtualBox.
+

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to GNS3
+
+We welcome contributions and bugs reports from everyone.
+We are friendly so don't be afraid to ask questions.
+
+## Bug reports
+
+Before reporting an issue:
+* check our website over at https://gns3.com
+* check if an issue already exists on https://github.com/GNS3/gns3-gui
+* check if an issue already exists on https://github.com/GNS3/gns3-server
+
+Please post on our community website if you are unsure you found a bug,
+you will get faster support and be able to exchange with more users.
+
+If you are unsure which project you should create an issue for, just do 
+it on https://github.com/GNS3/gns3-gui we will take care of the triage.
+
+For bugs specific to the GNS3 VM, please report on https://github.com/GNS3/gns3-vm
+
+## Asking for new features
+
+The best is to start a discussion on the community website in order to get feedback
+from the whole community.
+
+
+## Contributing code
+
+We welcome code contribution from everyone including beginners.
+Don't be afraid to submit a half finished or mediocre contribution and we will help you.
+
+Don't hesitate to share your plans before starting working on a contribution, we can help
+you to find the best approach.
+
+### Contributors License Agreements
+
+We at GNS3 are eager to work with you. For small changes — little bugfixes, correcting typos, and the like — please just submit pull requests to any of our projects. For larger changes, though, we have to ask you to jump through a little hoop.
+
+In particular, in order for us to accept any major patches from you, you will have to electronically sign a statement that indicates two things:
+
+- You are willingly licensing your contributions under the terms of the open source license of the project that you’re contributing to.
+- You are legally able to license your contributions as stated.
+
+The reason we do this is to ensure, to the extent possible, that we don’t “taint” the projects we manage with contributions that turn out to be improper. This protects everyone who wants to use the projects, including you!
+
+More information there: https://github.com/GNS3/cla
+
+### Pull requests
+
+Creating a pull request is the easiest way to contribute code. Do not hesitate to create one early when  contributing for new feature in order to get our feedback.

MANIFEST.in

@@ -4,8 +4,8 @@ include INSTALL
 include LICENSE
 include MANIFEST.in
 include tox.ini
-recursive-exclude tests *
-recursive-include docs *
+recursive-include tests *
+recursive-exclude docs *
 recursive-include gns3server *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

README.rst

@@ -1,13 +1,41 @@
 GNS3-server
 ===========
 
+.. image:: https://travis-ci.org/GNS3/gns3-server.svg?branch=master
+    :target: https://travis-ci.org/GNS3/gns3-server
+
+.. image:: https://img.shields.io/pypi/v/gns3-server.svg
+    :target: https://pypi.python.org/pypi/gns3-server
+
 This is the GNS3 server repository.
 
 The GNS3 server manages emulators such as Dynamips, VirtualBox or Qemu/KVM.
-Clients like the GNS3 GUI controls the server using a JSON-RPC API over Websockets.
+Clients like the GNS3 GUI controls the server using a HTTP REST API.
 
 You will need the GNS3 GUI (gns3-gui repository) to control the server.
 
+Branches
+--------
+
+master
+******
+master is the next stable release, you can test it in your day to day activities.
+Bug fixes or small improvements pull requests go here.
+
+1.x (1.4 for example)
+********
+Next major release
+
+*Never* use this branch for production. Pull requests for major new features go here.
+
+Linux
+-----
+
+GNS3 is perhaps packaged for your distribution:
+
+* Gentoo: https://packages.gentoo.org/package/net-misc/gns3-server
+
+
 Linux (Debian based)
 --------------------
 
@@ -16,20 +44,17 @@ You must be connected to the Internet in order to install the dependencies.
 
 Dependencies:
 
-- Python 3.3 or above
-- Setuptools
-- PyZMQ library
-- Netifaces library
-- Tornado
-- Jsonschema
+- Python 3.4 or above
+- aiohttp
+- setuptools
+- psutil
+- jsonschema
 
 The following commands will install some of these dependencies:
 
 .. code:: bash
 
    sudo apt-get install python3-setuptools
-   sudo apt-get install python3-zmq
-   sudo apt-get install python3-netifaces
 
 Finally these commands will install the server as well as the rest of the dependencies:
 
@@ -39,10 +64,89 @@ Finally these commands will install the server as well as the rest of the depend
    sudo python3 setup.py install
    gns3server
 
+To run tests use:
+
+.. code:: bash
+
+   py.test -v
+
+
+Run as daemon (Unix only)
+**************************
+
+You will found init sample script for various systems
+inside the init directory.
+
+Usefull options:
+
+* --daemon: start process as a daemon
+* --log logfile: store output in a logfile
+* --pid pidfile: store the pid of the running process in a file and prevent double execution
+
+All the init script require the creation of a GNS3 user. You can change it to another user.
+
+.. code:: bash
+
+    sudo adduser gns3
+
+upstart
+~~~~~~~
+
+For ubuntu < 15.04
+
+You need to copy init/gns3.conf.upstart to /etc/init/gns3.conf
+
+.. code:: bash
+
+    sudo chown root /etc/init/gns3.conf
+    sudo service gns3 start
+
+
+systemd
+~~~~~~~~
+You need to copy init/gns3.service.systemd to /lib/systemd/system/gns3.service
+
+.. code:: bash
+
+    sudo chown root /lib/systemd/system/gns3.service
+    sudo systemctl start gns3
+
 Windows
 -------
 
-Please use our all-in-one installer.
+
+Please use our `all-in-one installer <https://community.gns3.com/community/software/download>`_ to install the stable build.
+
+If you install via source you need to first install:
+
+- Python (3.3 or above) - https://www.python.org/downloads/windows/
+- Pywin32 - https://sourceforge.net/projects/pywin32/
+
+Then you can call
+
+.. code:: bash
+
+    python setup.py install
+
+to install the remaining dependencies.
+
+To run the tests, you also need to call
+
+.. code:: bash
+
+   pip install pytest pytest-capturelog
+
+before actually running the tests with
+
+.. code:: bash
+
+   python setup.py test
+
+or with
+
+.. code:: bash
+
+   py.test -v
 
 Mac OS X
 --------
@@ -61,4 +165,44 @@ and homebrew: http://brew.sh/.
    python3 setup.py install
    gns3server
 
+SSL
+---
 
+If you want enable SSL support on GNS3 you can generate a self signed certificate:
+
+.. code:: bash
+
+    bash gns3server/cert_utils/create_cert.sh
+
+This command will put the files in ~/.config/GNS3/ssl
+
+After you can start the server in SSL mode with:
+
+.. code:: bash
+
+    python gns3server/main.py --certfile ~/.config/GNS3/ssl/server.cert --certkey ~/.config/GNS3/ssl/server.key --ssl
+
+
+Or in your gns3_server.conf by adding in the Server section:
+
+.. code:: ini
+    
+    [Server]
+    certfile=/Users/noplay/.config/GNS3/ssl/server.cert
+    certkey=/Users/noplay/.config/GNS3/ssl/server.key
+    ssl=True
+
+Running tests
+*************
+
+Just run:
+
+.. code:: bash
+
+    py.test -vv
+
+If you want test coverage:
+
+.. code:: bash
+
+    py.test --cov=gns3server

cloud-image/.novarc

@@ -1,5 +0,0 @@
-export OS_USERNAME=username
-export OS_PASSWORD=""
-export OS_TENANT_NAME=000000
-export OS_AUTH_URL=https://identity.api.rackspacecloud.com/v2.0/
-export OS_REGION_NAME=ord

cloud-image/create_image.py

@@ -1,243 +0,0 @@
-""" Create a new GNS3 Server Rackspace image with the provided options. """
-
-import argparse
-import getpass
-import os
-import sys
-import uuid
-from fabric.api import env
-from fabric.contrib.files import exists
-from github import Github
-from novaclient.v1_1 import client
-from string import Template
-from time import sleep
-
-POLL_SEC = 20
-GNS3_REPO = 'gns3/gns3-server'
-PLANC_REPO = 'planctechnologies/gns3-server'
-OS_AUTH_URL = 'https://identity.api.rackspacecloud.com/v2.0/'
-UBUNTU_BASE_ID = '5cc098a5-7286-4b96-b3a2-49f4c4f82537'
-
-
-def main():
-    """
-    Get the user options and perform the image creation.
-
-    Creates a new instance, installs the required software, creates an image
-    from the instance, and then deletes the instance.
-    """
-
-    github = Github()
-
-    args = get_cli_args()
-    if args.username:
-        username = args.username
-    else:
-        if 'OS_USERNAME' in os.environ:
-            username = os.environ.get('OS_USERNAME')
-        else:
-            username = raw_input('Enter Rackspace username: ')
-
-    if args.password:
-        password = args.password
-    else:
-        if 'OS_PASSWORD' in os.environ:
-            password = os.environ.get('OS_PASSWORD')
-        else:
-            password = getpass.getpass('Enter Rackspace password: ')
-
-    if args.tenant:
-        tenant = args.tenant
-    else:
-        if 'OS_TENANT_NAME' in os.environ:
-            tenant = os.environ.get('OS_TENANT_NAME')
-        else:
-            tenant = raw_input('Enter Rackspace Tenant ID: ')
-
-    if args.region:
-        region = args.region
-    else:
-        if 'OS_REGION_NAME' in os.environ:
-            region = os.environ.get('OS_REGION_NAME')
-        else:
-            region = raw_input('Enter Rackspace Region Name: ')
-
-    if args.source == 'release':
-        # get the list of releases, present them to the user, save the url
-        repo = github.get_repo(GNS3_REPO)
-        keyword = "tag"
-        i = 1
-        branch_opts = {}
-        for tag in repo.get_tags():
-            branch_opts[i] = tag.name
-            i += 1
-    elif args.source == 'dev':
-        # get the list of dev branches, present them to the user, save the url
-        repo = github.get_repo(PLANC_REPO)
-        keyword = "branch"
-        i = 1
-        branch_opts = {}
-        for branch in repo.get_branches():
-            branch_opts[i] = branch.name
-            i += 1
-
-    prompt_text = "Select a %s" % keyword
-    selected_branch = prompt_user_select(branch_opts, prompt_text)
-
-    if args.image_name:
-        image_name = args.image_name
-    else:
-        image_name = "gns3-%s-%s-%s" % (args.source, selected_branch,
-                                        uuid.uuid4().hex[0:4])
-
-    if args.on_boot:
-        on_boot = True
-    else:
-        on_boot = False
-
-    startup_script = create_script(repo.svn_url, selected_branch, on_boot)
-    server_name = uuid.uuid4().hex
-    instance = create_instance(username, password, tenant, region, server_name,
-                               startup_script)
-    passwd = uuid.uuid4().hex
-    instance.change_password(passwd)
-    # wait for the password change to be processed.  Continuing while
-    # a password change is processing will cause image creation to fail.
-    sleep(POLL_SEC*6)
-
-    env.host_string = str(instance.accessIPv4)
-    env.user = "root"
-    env.password = passwd
-
-    sys.stdout.write("Installing software...")
-    sys.stdout.flush()
-
-    while True:
-        if exists('/tmp/gns-install-complete'):
-            break
-
-        sleep(POLL_SEC)
-        sys.stdout.write(".")
-        sys.stdout.flush()
-
-    print("Done.")
-
-    image_id = create_image(username, password, tenant, region, instance,
-                            image_name)
-    instance.delete()
-
-
-def prompt_user_select(opts, text="Please select"):
-    """ Ask the user to select an option from the provided list. """
-
-    print("%s" % text)
-    print("=" * len(text))
-    for o in opts:
-        print("(%s)\t%s" % (o, opts[o]))
-
-    while True:
-        selected = raw_input("Select: ")
-        try:
-            return opts[int(selected)]
-        except (KeyError, ValueError):
-            print("Invalid selection.  Try again")
-
-
-def create_instance(username, password, tenant, region, server_name, script,
-                    auth_url=OS_AUTH_URL):
-    """ Create a new instance. """
-
-    sys.stdout.write("Creating instance...")
-    sys.stdout.flush()
-
-    nc = client.Client(username, password, tenant, auth_url,
-                       region_name=region)
-    server = nc.servers.create(server_name, UBUNTU_BASE_ID, 2,
-                               config_drive=True, userdata=script)
-
-    while True:
-        server = nc.servers.get(server.id)
-        if server.status == 'ACTIVE':
-            break
-
-        sleep(POLL_SEC)
-        sys.stdout.write(".")
-        sys.stdout.flush()
-
-    print("Done.")
-
-    return server
-
-
-def create_script(git_url, git_branch, on_boot):
-    """ Create the start-up script. """
-
-    script_template = Template(open('script_template', 'r').read())
-
-    params = {'git_url': git_url, 'git_branch': git_branch, 'rc_local': ''}
-
-    if on_boot:
-        params['rc_local'] = "echo '/usr/local/bin/gns3-server' >> /etc/rc.local"
-
-    return script_template.substitute(params)
-
-
-def create_image(username, password, tenant, region, server,
-                 image_name, auth_url=OS_AUTH_URL):
-    """ Create a Rackspace image based on the server instance. """
-
-    nc = client.Client(username, password, tenant, auth_url,
-                       region_name=region)
-
-    sys.stdout.write("Creating image %s..." % image_name)
-    sys.stdout.flush()
-
-    image_id = server.create_image(image_name)
-
-    while True:
-        server = nc.servers.get(server.id)
-        if getattr(server, 'OS-EXT-STS:task_state') is None:
-            break
-
-        sleep(POLL_SEC)
-        sys.stdout.write(".")
-        sys.stdout.flush()
-
-    print("Done.")
-
-    return image_id
-
-
-def get_cli_args():
-    """ Parse the CLI input. """
-
-    parser = argparse.ArgumentParser(
-        description='Create a new GNS3 image',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-
-    parser.add_argument(
-        '--rackspace_username', dest='username', action='store')
-    parser.add_argument(
-        '--rackspace_password', dest='password', action='store')
-    parser.add_argument(
-        '--rackspace_tenant', dest='tenant', action='store')
-    parser.add_argument(
-        '--rackspace_region', dest='region', action='store')
-    parser.add_argument(
-        '--source', dest='source', action='store', choices=['release', 'dev'],
-        default='release', help='specify the gns3-server source location')
-    parser.add_argument(
-        '--branch', dest='branch', action='store',
-        help='specify the branch/tag')
-    parser.add_argument(
-        '--start-on-boot', dest='on_boot', action='store_true',
-        default=False, help='start the GNS3-server when the image boots')
-    parser.add_argument(
-        '--image-name', dest='image_name', action='store',
-        help='the name of the image to be created')
-
-    return parser.parse_args()
-
-
-if __name__ == "__main__":
-    main()

cloud-image/dependencies.txt

@@ -1,3 +0,0 @@
-fabric
-pygithub
-python-novaclient

cloud-image/readme.txt

@@ -1,10 +0,0 @@
-create_image.py:
-
-- uses fabric, which doesn't support Python 3
-
-- prompts for Rackspace credentials if environment variables not set
-  - see .novarc for example env variables
-    - note that the novaclient library uses the Rackspace password and -not-
-      the API key
-
-- use '--help' for help with arguments

cloud-image/script_template

@@ -1,19 +0,0 @@
-#!/bin/bash
-export DEBIAN_FRONTEND=noninteractive
-apt-get -y update
-apt-get -o Dpkg::Options::="--force-confnew" --force-yes -fuy dist-upgrade
-apt-get -y install git
-apt-get -y install python3-setuptools
-apt-get -y install python3-netifaces
-apt-get -y install python3-pip
-
-mkdir -p /opt/gns3
-pushd /opt/gns3
-git clone --branch ${git_branch} ${git_url}
-cd gns3-server
-pip3 install -r dev-requirements.txt
-python3 ./setup.py install
-
-${rc_local}
-
-touch /tmp/gns-install-complete

dev-requirements.txt

@@ -1,4 +1,8 @@
 -rrequirements.txt
 
-pytest
-ws4py
+sphinx==1.2.3
+pytest==2.8.2
+pep8==1.5.7
+pytest-capturelog==0.7
+pytest-cov==2.2.0
+pytest-timeout==0.5

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GNS3.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GNS3.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/GNS3"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GNS3"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/api/examples/delete_projectsprojectid.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80 HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}
+

docs/api/examples/delete_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0813062d-a796-44ef-a5ed-e690c633012e'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0813062d-a796-44ef-a5ed-e690c633012e HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/8759140f-eb6f-4f3b-9a7f-86c79ec747b9/adapters/1/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/8759140f-eb6f-4f3b-9a7f-86c79ec747b9/adapters/1/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/delete_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/1b1a72b7-97ea-4598-8c02-2edc285f7987'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/1b1a72b7-97ea-4598-8c02-2edc285f7987 HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b5c23125-ea22-4008-a89e-72565ae9f746/adapters/1/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b5c23125-ea22-4008-a89e-72565ae9f746/adapters/1/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/3f79083e-3da8-433e-9e9b-fe72a602ab4e/adapters/0/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/3f79083e-3da8-433e-9e9b-fe72a602ab4e/adapters/0/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/delete_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f9f4ab8-1b77-4eee-b0fb-e8d299b843a7'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6f9f4ab8-1b77-4eee-b0fb-e8d299b843a7 HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,14 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6666f3a7-d805-4572-a35c-bc15213f0b52/adapters/0/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6666f3a7-d805-4572-a35c-bc15213f0b52/adapters/0/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+

docs/api/examples/get_interfaces.txt

@@ -0,0 +1,72 @@
+curl -i -X GET 'http://localhost:8000/v1/interfaces'
+
+GET /v1/interfaces HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 1012
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/interfaces
+
+[
+    {
+        "id": "bridge0",
+        "ip_address": "",
+        "name": "bridge0"
+    },
+    {
+        "id": "en0",
+        "ip_address": "",
+        "name": "en0"
+    },
+    {
+        "id": "en1",
+        "ip_address": "192.168.84.114",
+        "name": "en1"
+    },
+    {
+        "id": "en2",
+        "ip_address": "",
+        "name": "en2"
+    },
+    {
+        "id": "fw0",
+        "ip_address": "",
+        "name": "fw0"
+    },
+    {
+        "id": "lo0",
+        "ip_address": "127.0.0.1",
+        "name": "lo0"
+    },
+    {
+        "id": "p2p0",
+        "ip_address": "",
+        "name": "p2p0"
+    },
+    {
+        "id": "vboxnet0",
+        "ip_address": "172.16.43.1",
+        "name": "vboxnet0"
+    },
+    {
+        "id": "vboxnet1",
+        "ip_address": "192.168.59.3",
+        "name": "vboxnet1"
+    },
+    {
+        "id": "vboxnet2",
+        "ip_address": "",
+        "name": "vboxnet2"
+    },
+    {
+        "id": "vboxnet3",
+        "ip_address": "192.168.99.1",
+        "name": "vboxnet3"
+    }
+]

docs/api/examples/get_iouvms.txt

@@ -0,0 +1,21 @@
+curl -i -X GET 'http://localhost:8000/v1/iou/vms'
+
+GET /v1/iou/vms HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 72
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/iou/vms
+
+[
+    {
+        "filename": "iou.bin",
+        "path": "iou.bin"
+    }
+]

docs/api/examples/get_projects.txt

@@ -0,0 +1,31 @@
+curl -i -X GET 'http://localhost:8000/v1/projects'
+
+GET /v1/projects HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 656
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects
+
+[
+    {
+        "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo",
+        "name": "test",
+        "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo/00010203-0405-0607-0809-0a0b0c0d0e0b",
+        "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0b",
+        "temporary": false
+    },
+    {
+        "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo",
+        "name": "test",
+        "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpmwnekqxo/00010203-0405-0607-0809-0a0b0c0d0e0f",
+        "project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f",
+        "temporary": false
+    }
+]

docs/api/examples/get_projectsprojectid.txt

@@ -0,0 +1,22 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/00010203-0405-0607-0809-0a0b0c0d0e02'
+
+GET /v1/projects/00010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 297
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}
+
+{
+    "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpchvw88rg",
+    "name": "test",
+    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpchvw88rg/00010203-0405-0607-0809-0a0b0c0d0e02",
+    "project_id": "00010203-0405-0607-0809-0a0b0c0d0e02",
+    "temporary": false
+}

docs/api/examples/get_projectsprojectidfiles.txt

@@ -0,0 +1,25 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/files'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/files HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 204
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/files
+
+[
+    {
+        "md5sum": "ad0234829205b9033196ba818f7a872b",
+        "path": "test.txt"
+    },
+    {
+        "md5sum": "098f6bcd4621d373cade4e832627b4f6",
+        "path": "vm-1/dynamips/test.bin"
+    }
+]

docs/api/examples/get_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,33 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/82f6e25c-6960-421d-9567-a7453642935b'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/82f6e25c-6960-421d-9567-a7453642935b HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 610
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+
+{
+    "console": 2001,
+    "ethernet_adapters": 2,
+    "iourc_path": null,
+    "l1_keepalives": false,
+    "md5sum": null,
+    "name": "PC TEST 1",
+    "nvram": 128,
+    "path": "iou.bin",
+    "private_config": null,
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 256,
+    "serial_adapters": 2,
+    "startup_config": null,
+    "use_default_iou_values": true,
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/82f6e25c-6960-421d-9567-a7453642935b",
+    "vm_id": "82f6e25c-6960-421d-9567-a7453642935b"
+}

docs/api/examples/get_projectsprojectidiouvmsvmidconfigs.txt

@@ -0,0 +1,18 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/9ff2d283-1365-4422-93e7-e14c56b809cb/configs'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/9ff2d283-1365-4422-93e7-e14c56b809cb/configs HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 40
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/configs
+
+{
+    "startup_config_content": "TEST"
+}

docs/api/examples/get_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,56 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/84777300-eef4-4a3a-9135-d7009bdb0722'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/84777300-eef4-4a3a-9135-d7009bdb0722 HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 1353
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+
+{
+    "acpi_shutdown": false,
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "boot_priority": "c",
+    "cdrom_image": "",
+    "cdrom_image_md5sum": null,
+    "console": 2001,
+    "console_type": "telnet",
+    "cpu_throttling": 0,
+    "cpus": 1,
+    "hda_disk_image": "",
+    "hda_disk_image_md5sum": null,
+    "hda_disk_interface": "ide",
+    "hdb_disk_image": "",
+    "hdb_disk_image_md5sum": null,
+    "hdb_disk_interface": "ide",
+    "hdc_disk_image": "",
+    "hdc_disk_image_md5sum": null,
+    "hdc_disk_interface": "ide",
+    "hdd_disk_image": "",
+    "hdd_disk_image_md5sum": null,
+    "hdd_disk_interface": "ide",
+    "initrd": "",
+    "initrd_md5sum": null,
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "kernel_image_md5sum": null,
+    "legacy_networking": false,
+    "mac_address": "00:00:ab:07:22:00",
+    "name": "PC TEST 1",
+    "options": "",
+    "platform": "x86_64",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64",
+    "ram": 256,
+    "usage": "",
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/84777300-eef4-4a3a-9135-d7009bdb0722",
+    "vm_id": "84777300-eef4-4a3a-9135-d7009bdb0722"
+}

docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt

@@ -0,0 +1,30 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/63b9b470-5a07-4cfe-b9d5-ae5d5518b988'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/63b9b470-5a07-4cfe-b9d5-ae5d5518b988 HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 415
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}
+
+{
+    "acpi_shutdown": false,
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2002,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "VMTEST",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 0,
+    "use_any_adapter": false,
+    "vm_directory": null,
+    "vm_id": "63b9b470-5a07-4cfe-b9d5-ae5d5518b988",
+    "vmname": "VMTEST"
+}

docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,25 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/7e24fcc2-e38c-43e8-a7bb-fc22d7b91547'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/7e24fcc2-e38c-43e8-a7bb-fc22d7b91547 HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 422
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+
+{
+    "console": 2010,
+    "name": "PC TEST 1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": null,
+    "startup_script_path": null,
+    "status": "stopped",
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/7e24fcc2-e38c-43e8-a7bb-fc22d7b91547",
+    "vm_id": "7e24fcc2-e38c-43e8-a7bb-fc22d7b91547"
+}

docs/api/examples/get_qemubinaries.txt

@@ -0,0 +1,33 @@
+curl -i -X GET 'http://localhost:8000/v1/qemu/binaries' -d '{"archs": ["i386"]}'
+
+GET /v1/qemu/binaries HTTP/1.1
+{
+    "archs": [
+        "i386"
+    ]
+}
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 212
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/qemu/binaries
+
+[
+    {
+        "path": "/tmp/x86_64",
+        "version": "2.2.0"
+    },
+    {
+        "path": "/tmp/alpha",
+        "version": "2.1.0"
+    },
+    {
+        "path": "/tmp/i386",
+        "version": "2.1.0"
+    }
+]

docs/api/examples/get_qemucapabilities.txt

@@ -0,0 +1,20 @@
+curl -i -X GET 'http://localhost:8000/v1/qemu/capabilities'
+
+GET /v1/qemu/capabilities HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 39
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/qemu/capabilities
+
+{
+    "kvm": [
+        "x86_64"
+    ]
+}

docs/api/examples/get_version.txt

@@ -0,0 +1,19 @@
+curl -i -X GET 'http://localhost:8000/v1/version'
+
+GET /v1/version HTTP/1.1
+
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 50
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/version
+
+{
+    "local": true,
+    "version": "1.4.0dev13"
+}

docs/api/examples/post_configreload.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/config/reload' -d '{}'
+
+POST /v1/config/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/config/reload
+

docs/api/examples/post_projects.txt

@@ -0,0 +1,24 @@
+curl -i -X POST 'http://localhost:8000/v1/projects' -d '{"name": "test"}'
+
+POST /v1/projects HTTP/1.1
+{
+    "name": "test"
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 297
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects
+
+{
+    "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpp319gdgn",
+    "name": "test",
+    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpp319gdgn/054e6ecb-1e9d-4c74-ad08-1209264bd96d",
+    "project_id": "054e6ecb-1e9d-4c74-ad08-1209264bd96d",
+    "temporary": false
+}

docs/api/examples/post_projectsprojectidclose.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/close HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/close
+

docs/api/examples/post_projectsprojectidcommit.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/commit HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/commit
+

docs/api/examples/post_projectsprojectidiouvms.txt

@@ -0,0 +1,38 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"name": "PC TEST 1", "path": "iou.bin", "startup_config_content": "hostname test", "vm_id": "afa904bc-8968-4e7c-87b6-11d92174f1e6"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1
+{
+    "name": "PC TEST 1",
+    "path": "iou.bin",
+    "startup_config_content": "hostname test",
+    "vm_id": "afa904bc-8968-4e7c-87b6-11d92174f1e6"
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 626
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms
+
+{
+    "console": 2001,
+    "ethernet_adapters": 2,
+    "iourc_path": null,
+    "l1_keepalives": false,
+    "md5sum": null,
+    "name": "PC TEST 1",
+    "nvram": 128,
+    "path": "iou.bin",
+    "private_config": null,
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 256,
+    "serial_adapters": 2,
+    "startup_config": "startup-config.cfg",
+    "use_default_iou_values": true,
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/afa904bc-8968-4e7c-87b6-11d92174f1e6",
+    "vm_id": "afa904bc-8968-4e7c-87b6-11d92174f1e6"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,22 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/eea449ce-e25b-4beb-b50f-fcd77241a97b/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_generic_ethernet"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/eea449ce-e25b-4beb-b50f-fcd77241a97b/adapters/1/ports/0/nio HTTP/1.1
+{
+    "ethernet_device": "bridge0",
+    "type": "nio_generic_ethernet"
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 72
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "ethernet_device": "bridge0",
+    "type": "nio_generic_ethernet"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt

@@ -0,0 +1,21 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/14a4f240-54e7-47f7-b9e7-3640528415fe/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/14a4f240-54e7-47f7-b9e7-3640528415fe/adapters/0/ports/0/start_capture HTTP/1.1
+{
+    "capture_file_name": "test.pcap",
+    "data_link_type": "DLT_EN10MB"
+}
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 158
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
+
+{
+    "pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/992e1579-2232-4aac-93ef-970c3bb67966/adapters/0/ports/0/stop_capture' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/992e1579-2232-4aac-93ef-970c3bb67966/adapters/0/ports/0/stop_capture HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
+

docs/api/examples/post_projectsprojectidiouvmsvmidreload.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7f23517b-b45e-4e7b-b908-c501c36abe16/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/7f23517b-b45e-4e7b-b908-c501c36abe16/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt

@@ -0,0 +1,16 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2923f599-894a-4b18-a9eb-17a389298f84/start' -d '{"iourc_content": "test"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2923f599-894a-4b18-a9eb-17a389298f84/start HTTP/1.1
+{
+    "iourc_content": "test"
+}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ff05b41f-cd2b-4b33-90be-9362430b68ae/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ff05b41f-cd2b-4b33-90be-9362430b68ae/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidportsudp.txt

@@ -0,0 +1,18 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/ports/udp' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/ports/udp HTTP/1.1
+{}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 25
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/ports/udp
+
+{
+    "udp_port": 10000
+}

docs/api/examples/post_projectsprojectidqemuvms.txt

@@ -0,0 +1,61 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "linux.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64", "ram": 1024}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1
+{
+    "hda_disk_image": "linux.img",
+    "name": "PC TEST 1",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64",
+    "ram": 1024
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 1363
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms
+
+{
+    "acpi_shutdown": false,
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "boot_priority": "c",
+    "cdrom_image": "",
+    "cdrom_image_md5sum": null,
+    "console": 2001,
+    "console_type": "telnet",
+    "cpu_throttling": 0,
+    "cpus": 1,
+    "hda_disk_image": "linux.img",
+    "hda_disk_image_md5sum": null,
+    "hda_disk_interface": "ide",
+    "hdb_disk_image": "",
+    "hdb_disk_image_md5sum": null,
+    "hdb_disk_interface": "ide",
+    "hdc_disk_image": "",
+    "hdc_disk_image_md5sum": null,
+    "hdc_disk_interface": "ide",
+    "hdd_disk_image": "",
+    "hdd_disk_image_md5sum": null,
+    "hdd_disk_interface": "ide",
+    "initrd": "",
+    "initrd_md5sum": null,
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "kernel_image_md5sum": null,
+    "legacy_networking": false,
+    "mac_address": "00:00:ab:50:58:00",
+    "name": "PC TEST 1",
+    "options": "",
+    "platform": "x86_64",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64",
+    "ram": 1024,
+    "usage": "",
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/b949f2e2-d338-4b51-aea9-270196ed5058",
+    "vm_id": "b949f2e2-d338-4b51-aea9-270196ed5058"
+}

docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,22 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/82435d91-3cb5-4a44-abff-34a4ae46b24f/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/82435d91-3cb5-4a44-abff-34a4ae46b24f/adapters/1/ports/0/nio HTTP/1.1
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}
+
+
+HTTP/1.1 409
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 89
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "message": "NIO of type nio_generic_ethernet is not supported",
+    "status": 409
+}

docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/3275bdce-9b75-445f-8168-0103cd524182/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/3275bdce-9b75-445f-8168-0103cd524182/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2d03502f-6b3f-4551-b924-b74fd5d6cdf5/resume' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2d03502f-6b3f-4551-b924-b74fd5d6cdf5/resume HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/resume
+

docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/04afa03a-3d9b-4aa7-945f-8f3077b6790e/start' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/04afa03a-3d9b-4aa7-945f-8f3077b6790e/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f5bfbadc-9a09-4090-a624-89be68858746/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f5bfbadc-9a09-4090-a624-89be68858746/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/bb00b1e0-f19d-4ce8-b99a-82c1518fa33e/suspend' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/bb00b1e0-f19d-4ce8-b99a-82c1518fa33e/suspend HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/suspend
+

docs/api/examples/post_projectsprojectidvirtualboxvms.txt

@@ -0,0 +1,34 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms' -d '{"linked_clone": false, "name": "VM1", "vmname": "VM1"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1
+{
+    "linked_clone": false,
+    "name": "VM1",
+    "vmname": "VM1"
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 409
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms
+
+{
+    "acpi_shutdown": false,
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2001,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "VM1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 0,
+    "use_any_adapter": false,
+    "vm_directory": null,
+    "vm_id": "39cc5964-d0be-487b-9f0c-8fbea600e452",
+    "vmname": "VM1"
+}

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,26 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/556aba72-c19a-4fc3-a350-9454791687f4/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/556aba72-c19a-4fc3-a350-9454791687f4/adapters/0/ports/0/nio HTTP/1.1
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 89
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidreload.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/1a517572-9b86-441a-8347-1d28b01d9a41/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/1a517572-9b86-441a-8347-1d28b01d9a41/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/7f5648e4-0ce8-49b3-b470-f2b821a5fe3e/resume' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/7f5648e4-0ce8-49b3-b470-f2b821a5fe3e/resume HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/resume
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ee1fef8f-cbe1-4590-8c47-fbd12f7f6beb/start' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/ee1fef8f-cbe1-4590-8c47-fbd12f7f6beb/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5e8543c3-45a7-4668-824f-01eaeb848898/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5e8543c3-45a7-4668-824f-01eaeb848898/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/95f620da-c0e5-4404-81fc-10f3e18786cb/suspend' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/95f620da-c0e5-4404-81fc-10f3e18786cb/suspend HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/suspend
+

docs/api/examples/post_projectsprojectidvpcsvms.txt

@@ -0,0 +1,27 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms' -d '{"name": "PC TEST 1"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1
+{
+    "name": "PC TEST 1"
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 422
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms
+
+{
+    "console": 2010,
+    "name": "PC TEST 1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": null,
+    "startup_script_path": null,
+    "status": "stopped",
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/d1808514-893b-4aa5-86c2-c4dea88ff895",
+    "vm_id": "d1808514-893b-4aa5-86c2-c4dea88ff895"
+}

docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,26 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/fbf2e4d7-d60e-4e03-95bc-1bd53b74689a/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/fbf2e4d7-d60e-4e03-95bc-1bd53b74689a/adapters/0/ports/0/nio HTTP/1.1
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 89
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}

docs/api/examples/post_projectsprojectidvpcsvmsvmidreload.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/1a1b95de-cc91-4a90-870b-5c7c8965eb5d/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/1a1b95de-cc91-4a90-870b-5c7c8965eb5d/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/184c6dcc-a8fd-4cc9-b333-86cc24f2e98e/start' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/184c6dcc-a8fd-4cc9-b333-86cc24f2e98e/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt

@@ -0,0 +1,14 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/bc34aac0-6c5e-4b91-b2ea-47b76d4b26f1/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/bc34aac0-6c5e-4b91-b2ea-47b76d4b26f1/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/stop
+

docs/api/examples/post_qemuimg.txt

@@ -0,0 +1,23 @@
+curl -i -X POST 'http://localhost:8000/v1/qemu/img' -d '{"cluster_size": 64, "format": "qcow2", "lazy_refcounts": "off", "path": "/tmp/hda.qcow2", "preallocation": "metadata", "qemu_img": "/tmp/qemu-img", "refcount_bits": 12, "size": 100}'
+
+POST /v1/qemu/img HTTP/1.1
+{
+    "cluster_size": 64,
+    "format": "qcow2",
+    "lazy_refcounts": "off",
+    "path": "/tmp/hda.qcow2",
+    "preallocation": "metadata",
+    "qemu_img": "/tmp/qemu-img",
+    "refcount_bits": 12,
+    "size": 100
+}
+
+
+HTTP/1.1 201
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/qemu/img
+

docs/api/examples/post_version.txt

@@ -0,0 +1,20 @@
+curl -i -X POST 'http://localhost:8000/v1/version' -d '{"version": "1.4.0dev13"}'
+
+POST /v1/version HTTP/1.1
+{
+    "version": "1.4.0dev13"
+}
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 31
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/version
+
+{
+    "version": "1.4.0dev13"
+}

docs/api/examples/put_projectsprojectid.txt

@@ -0,0 +1,22 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/9d7dccbb-0fc0-40d0-9420-912733dcbf74' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-110/test_update_path_project_non_l0"}'
+
+PUT /v1/projects/9d7dccbb-0fc0-40d0-9420-912733dcbf74 HTTP/1.1
+{
+    "name": "second_name",
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-110/test_update_path_project_non_l0"
+}
+
+
+HTTP/1.1 403
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 100
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}
+
+{
+    "message": "You are not allowed to modify the project directory location",
+    "status": 403
+}

docs/api/examples/put_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,44 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6438493a-152d-4cb0-b8d2-fcfe1f6bf540' -d '{"console": 2002, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6438493a-152d-4cb0-b8d2-fcfe1f6bf540 HTTP/1.1
+{
+    "console": 2002,
+    "ethernet_adapters": 4,
+    "iourc_content": "test",
+    "l1_keepalives": true,
+    "name": "test",
+    "nvram": 2048,
+    "ram": 512,
+    "serial_adapters": 0,
+    "startup_config_content": "hostname test",
+    "use_default_iou_values": true
+}
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 685
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+
+{
+    "console": 2002,
+    "ethernet_adapters": 4,
+    "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyrljan4a/iourc",
+    "l1_keepalives": true,
+    "md5sum": null,
+    "name": "test",
+    "nvram": 2048,
+    "path": "iou.bin",
+    "private_config": null,
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 512,
+    "serial_adapters": 0,
+    "startup_config": "startup-config.cfg",
+    "use_default_iou_values": true,
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/6438493a-152d-4cb0-b8d2-fcfe1f6bf540",
+    "vm_id": "6438493a-152d-4cb0-b8d2-fcfe1f6bf540"
+}

docs/api/examples/put_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,61 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/578b6391-e461-4f17-86f6-dd556d2f4dde' -d '{"console": 2002, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/578b6391-e461-4f17-86f6-dd556d2f4dde HTTP/1.1
+{
+    "console": 2002,
+    "hdb_disk_image": "linux.img",
+    "name": "test",
+    "ram": 1024
+}
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 1358
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+
+{
+    "acpi_shutdown": false,
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "boot_priority": "c",
+    "cdrom_image": "",
+    "cdrom_image_md5sum": null,
+    "console": 2002,
+    "console_type": "telnet",
+    "cpu_throttling": 0,
+    "cpus": 1,
+    "hda_disk_image": "",
+    "hda_disk_image_md5sum": null,
+    "hda_disk_interface": "ide",
+    "hdb_disk_image": "linux.img",
+    "hdb_disk_image_md5sum": null,
+    "hdb_disk_interface": "ide",
+    "hdc_disk_image": "",
+    "hdc_disk_image_md5sum": null,
+    "hdc_disk_interface": "ide",
+    "hdd_disk_image": "",
+    "hdd_disk_image_md5sum": null,
+    "hdd_disk_interface": "ide",
+    "initrd": "",
+    "initrd_md5sum": null,
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "kernel_image_md5sum": null,
+    "legacy_networking": false,
+    "mac_address": "00:00:ab:4d:de:00",
+    "name": "test",
+    "options": "",
+    "platform": "x86_64",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph3pfurip/qemu-system-x86_64",
+    "ram": 1024,
+    "usage": "",
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/578b6391-e461-4f17-86f6-dd556d2f4dde",
+    "vm_id": "578b6391-e461-4f17-86f6-dd556d2f4dde"
+}

docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt

@@ -0,0 +1,33 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/aa45d68c-c68e-4296-9550-641b522a73c2' -d '{"console": 2011, "name": "test"}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/aa45d68c-c68e-4296-9550-641b522a73c2 HTTP/1.1
+{
+    "console": 2011,
+    "name": "test"
+}
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 413
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}
+
+{
+    "acpi_shutdown": false,
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2011,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "test",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 0,
+    "use_any_adapter": false,
+    "vm_directory": null,
+    "vm_id": "aa45d68c-c68e-4296-9550-641b522a73c2",
+    "vmname": "VMTEST"
+}

docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,29 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/608a4cd0-476c-40ba-95db-0c81effc8e9c' -d '{"console": 2012, "name": "test", "startup_script": "ip 192.168.1.1"}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/608a4cd0-476c-40ba-95db-0c81effc8e9c HTTP/1.1
+{
+    "console": 2012,
+    "name": "test",
+    "startup_script": "ip 192.168.1.1"
+}
+
+
+HTTP/1.1 200
+ACCESS-CONTROL-ALLOW-ORIGIN: *
+CONNECTION: keep-alive
+CONTENT-LENGTH: 438
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.5 GNS3/1.4.0dev13
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+
+{
+    "console": 2012,
+    "name": "test",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": "ip 192.168.1.1",
+    "startup_script_path": "startup.vpc",
+    "status": "stopped",
+    "vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/608a4cd0-476c-40ba-95db-0c81effc8e9c",
+    "vm_id": "608a4cd0-476c-40ba-95db-0c81effc8e9c"
+}

docs/api/v1/config.rst

@@ -0,0 +1,8 @@
+Config
+---------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   config/*

docs/api/v1/config/configreload.rst

@@ -0,0 +1,20 @@
+/v1/config/reload
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/config/reload
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Check if version is the same as the server
+
+Response status codes
+**********************
+- **201**: Config reload
+- **403**: Config reload refused
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_configreload.txt
+

docs/api/v1/dynamips_device.rst

@@ -0,0 +1,8 @@
+Dynamips device
+---------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   dynamips_device/*

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst

@@ -0,0 +1,43 @@
+/v1/projects/{project_id}/dynamips/devices
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/devices
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create a new Dynamips device instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: Instance created
+- **409**: Conflict
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>device_id</td>                    <td> </td>                     <td></td>                     <td>Dynamips device instance identifier</td>                     </tr>
+    <tr><td>device_type</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips device type</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips device name</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>device_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips router instance UUID</td>                     </tr>
+    <tr><td>mappings</td>                    <td> </td>                     <td>object</td>                     <td></td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips device instance name</td>                     </tr>
+    <tr><td>ports</td>                    <td> </td>                     <td>array</td>                     <td></td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    </table>
+

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst

@@ -0,0 +1,107 @@
+/v1/projects/{project_id}/dynamips/devices/{device_id}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get a Dynamips device instance
+
+Parameters
+**********
+- **device_id**: UUID for the instance
+- **project_id**: UUID for the project
+
+Response status codes
+**********************
+- **200**: Success
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>device_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips router instance UUID</td>                     </tr>
+    <tr><td>mappings</td>                    <td> </td>                     <td>object</td>                     <td></td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips device instance name</td>                     </tr>
+    <tr><td>ports</td>                    <td> </td>                     <td>array</td>                     <td></td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    </table>
+
+
+PUT /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update a Dynamips device instance
+
+Parameters
+**********
+- **device_id**: UUID for the instance
+- **project_id**: UUID for the project
+
+Response status codes
+**********************
+- **200**: Instance updated
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **409**: Conflict
+
+Input
+*******
+Types
++++++++++
+EthernetSwitchPort
+^^^^^^^^^^^^^^^^^^^^^^
+Ethernet switch port
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>ethertype</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: , 0x8100, 0x88A8, 0x9100, 0x9200</td>                     </tr>
+    <tr><td>port</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Port number</td>                     </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: access, dot1q, qinq</td>                     </tr>
+    <tr><td>vlan</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>VLAN number</td>                     </tr>
+    </table>
+
+Body
++++++++++
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>name</td>                    <td> </td>                     <td>string</td>                     <td>Dynamips device instance name</td>                     </tr>
+    <tr><td>ports</td>                    <td> </td>                     <td>array</td>                     <td></td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>device_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips router instance UUID</td>                     </tr>
+    <tr><td>mappings</td>                    <td> </td>                     <td>object</td>                     <td></td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips device instance name</td>                     </tr>
+    <tr><td>ports</td>                    <td> </td>                     <td>array</td>                     <td></td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    </table>
+
+
+DELETE /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete a Dynamips device instance
+
+Parameters
+**********
+- **device_id**: UUID for the instance
+- **project_id**: UUID for the project
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance deleted
+

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst

@@ -0,0 +1,151 @@
+/v1/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/nio
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Add a NIO to a Dynamips device instance
+
+Parameters
+**********
+- **device_id**: UUID for the instance
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: NIO created
+- **404**: Instance doesn't exist
+
+Input
+*******
+Types
++++++++++
+Ethernet
+^^^^^^^^^^^^^^^^^^^^^^
+Generic Ethernet Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>ethernet_device</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Ethernet device name e.g. eth0</td>                     </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_generic_ethernet</td>                     </tr>
+    </table>
+
+LinuxEthernet
+^^^^^^^^^^^^^^^^^^^^^^
+Linux Ethernet Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>ethernet_device</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Ethernet device name e.g. eth0</td>                     </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_linux_ethernet</td>                     </tr>
+    </table>
+
+NAT
+^^^^^^^^^^^^^^^^^^^^^^
+NAT Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_nat</td>                     </tr>
+    </table>
+
+NULL
+^^^^^^^^^^^^^^^^^^^^^^
+NULL Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_null</td>                     </tr>
+    </table>
+
+TAP
+^^^^^^^^^^^^^^^^^^^^^^
+TAP Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>tap_device</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>TAP device name e.g. tap0</td>                     </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_tap</td>                     </tr>
+    </table>
+
+UDP
+^^^^^^^^^^^^^^^^^^^^^^
+UDP Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>lport</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Local port</td>                     </tr>
+    <tr><td>rhost</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Remote host</td>                     </tr>
+    <tr><td>rport</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Remote port</td>                     </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_udp</td>                     </tr>
+    </table>
+
+UNIX
+^^^^^^^^^^^^^^^^^^^^^^
+UNIX Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>local_file</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>path to the UNIX socket file (local)</td>                     </tr>
+    <tr><td>remote_file</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>path to the UNIX socket file (remote)</td>                     </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_unix</td>                     </tr>
+    </table>
+
+VDE
+^^^^^^^^^^^^^^^^^^^^^^
+VDE Network Input/Output
+
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>control_file</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>path to the VDE control file</td>                     </tr>
+    <tr><td>local_file</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>path to the VDE control file</td>                     </tr>
+    <tr><td>type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: nio_vde</td>                     </tr>
+    </table>
+
+Body
++++++++++
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>mappings</td>                    <td> </td>                     <td>object</td>                     <td></td>                     </tr>
+    <tr><td>nio</td>                    <td>&#10004;</td>                     <td>UDP, Ethernet, LinuxEthernet, NAT, TAP, UNIX, VDE, NULL</td>                     <td></td>                     </tr>
+    <tr><td>port_settings</td>                    <td> </td>                     <td>object</td>                     <td>Ethernet switch</td>                     </tr>
+    </table>
+
+
+DELETE /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Remove a NIO from a Dynamips device instance
+
+Parameters
+**********
+- **device_id**: UUID for the instance
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: NIO deleted
+

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst

@@ -0,0 +1,31 @@
+/v1/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/start_capture
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/start_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a packet capture on a Dynamips device instance
+
+Parameters
+**********
+- **device_id**: UUID for the instance
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+
+Response status codes
+**********************
+- **200**: Capture started
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>capture_file_name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Capture file name</td>                     </tr>
+    <tr><td>data_link_type</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>PCAP data link type</td>                     </tr>
+    </table>
+

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst

@@ -0,0 +1,21 @@
+/v1/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/stop_capture
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**/ports/**{port_number:\d+}**/stop_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Stop a packet capture on a Dynamips device instance
+
+Parameters
+**********
+- **device_id**: UUID for the instance
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Capture stopped
+

docs/api/v1/dynamips_vm.rst

@@ -0,0 +1,8 @@
+Dynamips vm
+---------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   dynamips_vm/*

docs/api/v1/dynamips_vm/dynamipsvms.rst

@@ -0,0 +1,13 @@
+/v1/dynamips/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/dynamips/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the list of Dynamips VMS
+
+Response status codes
+**********************
+- **200**: List of Dynamips VM retrieved
+

docs/api/v1/dynamips_vm/dynamipsvmspath.rst

@@ -0,0 +1,13 @@
+/v1/dynamips/vms/{path}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/dynamips/vms/**{path}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Upload Dynamips image.
+
+Response status codes
+**********************
+- **204**: Image uploaded
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst

@@ -0,0 +1,123 @@
+/v1/projects/{project_id}/dynamips/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create a new Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: Instance created
+- **409**: Conflict
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>auto_delete_disks</td>                    <td> </td>                     <td>boolean</td>                     <td>automatically delete nvram and disk files</td>                     </tr>
+    <tr><td>aux</td>                    <td> </td>                     <td>integer</td>                     <td>auxiliary console TCP port</td>                     </tr>
+    <tr><td>chassis</td>                    <td> </td>                     <td>string</td>                     <td>router chassis model</td>                     </tr>
+    <tr><td>clock_divisor</td>                    <td> </td>                     <td>integer</td>                     <td>clock divisor</td>                     </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>disk0</td>                    <td> </td>                     <td>integer</td>                     <td>disk0 size in MB</td>                     </tr>
+    <tr><td>disk1</td>                    <td> </td>                     <td>integer</td>                     <td>disk1 size in MB</td>                     </tr>
+    <tr><td>dynamips_id</td>                    <td> </td>                     <td>integer</td>                     <td>ID to use with Dynamips</td>                     </tr>
+    <tr><td>exec_area</td>                    <td> </td>                     <td>integer</td>                     <td>exec area value</td>                     </tr>
+    <tr><td>idlemax</td>                    <td> </td>                     <td>integer</td>                     <td>idlemax value</td>                     </tr>
+    <tr><td>idlepc</td>                    <td> </td>                     <td>string</td>                     <td>Idle-PC value</td>                     </tr>
+    <tr><td>idlesleep</td>                    <td> </td>                     <td>integer</td>                     <td>idlesleep value</td>                     </tr>
+    <tr><td>image</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>path to the IOS image</td>                     </tr>
+    <tr><td>image_md5sum</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>checksum of the IOS image</td>                     </tr>
+    <tr><td>iomem</td>                    <td> </td>                     <td>integer</td>                     <td>I/O memory percentage</td>                     </tr>
+    <tr><td>mac_addr</td>                    <td> </td>                     <td>string</td>                     <td>base MAC address</td>                     </tr>
+    <tr><td>midplane</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: std, vxr</td>                     </tr>
+    <tr><td>mmap</td>                    <td> </td>                     <td>boolean</td>                     <td>MMAP feature</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips VM instance name</td>                     </tr>
+    <tr><td>npe</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td>                     </tr>
+    <tr><td>nvram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of NVRAM in KB</td>                     </tr>
+    <tr><td>platform</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>platform</td>                     </tr>
+    <tr><td>power_supplies</td>                    <td> </td>                     <td>array</td>                     <td>Power supplies status</td>                     </tr>
+    <tr><td>private_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS private configuration file</td>                     </tr>
+    <tr><td>private_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>private configuration base64 encoded</td>                     </tr>
+    <tr><td>private_config_content</td>                    <td> </td>                     <td>string</td>                     <td>Content of IOS private configuration file</td>                     </tr>
+    <tr><td>ram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>amount of RAM in MB</td>                     </tr>
+    <tr><td>sensors</td>                    <td> </td>                     <td>array</td>                     <td>Temperature sensors</td>                     </tr>
+    <tr><td>slot0</td>                    <td> </td>                     <td></td>                     <td>Network module slot 0</td>                     </tr>
+    <tr><td>slot1</td>                    <td> </td>                     <td></td>                     <td>Network module slot 1</td>                     </tr>
+    <tr><td>slot2</td>                    <td> </td>                     <td></td>                     <td>Network module slot 2</td>                     </tr>
+    <tr><td>slot3</td>                    <td> </td>                     <td></td>                     <td>Network module slot 3</td>                     </tr>
+    <tr><td>slot4</td>                    <td> </td>                     <td></td>                     <td>Network module slot 4</td>                     </tr>
+    <tr><td>slot5</td>                    <td> </td>                     <td></td>                     <td>Network module slot 5</td>                     </tr>
+    <tr><td>slot6</td>                    <td> </td>                     <td></td>                     <td>Network module slot 6</td>                     </tr>
+    <tr><td>sparsemem</td>                    <td> </td>                     <td>boolean</td>                     <td>sparse memory feature</td>                     </tr>
+    <tr><td>startup_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS startup configuration file</td>                     </tr>
+    <tr><td>startup_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>startup configuration base64 encoded</td>                     </tr>
+    <tr><td>startup_config_content</td>                    <td> </td>                     <td>string</td>                     <td>Content of IOS startup configuration file</td>                     </tr>
+    <tr><td>system_id</td>                    <td> </td>                     <td>string</td>                     <td>system ID</td>                     </tr>
+    <tr><td>vm_id</td>                    <td> </td>                     <td></td>                     <td>Dynamips VM instance identifier</td>                     </tr>
+    <tr><td>wic0</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic1</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic2</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>auto_delete_disks</td>                    <td> </td>                     <td>boolean</td>                     <td>automatically delete nvram and disk files</td>                     </tr>
+    <tr><td>aux</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>auxiliary console TCP port</td>                     </tr>
+    <tr><td>chassis</td>                    <td> </td>                     <td>string</td>                     <td>router chassis model</td>                     </tr>
+    <tr><td>clock_divisor</td>                    <td> </td>                     <td>integer</td>                     <td>clock divisor</td>                     </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>disk0</td>                    <td> </td>                     <td>integer</td>                     <td>disk0 size in MB</td>                     </tr>
+    <tr><td>disk1</td>                    <td> </td>                     <td>integer</td>                     <td>disk1 size in MB</td>                     </tr>
+    <tr><td>dynamips_id</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>ID to use with Dynamips</td>                     </tr>
+    <tr><td>exec_area</td>                    <td> </td>                     <td>integer</td>                     <td>exec area value</td>                     </tr>
+    <tr><td>idlemax</td>                    <td> </td>                     <td>integer</td>                     <td>idlemax value</td>                     </tr>
+    <tr><td>idlepc</td>                    <td> </td>                     <td>string</td>                     <td>Idle-PC value</td>                     </tr>
+    <tr><td>idlesleep</td>                    <td> </td>                     <td>integer</td>                     <td>idlesleep value</td>                     </tr>
+    <tr><td>image</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS image</td>                     </tr>
+    <tr><td>image_md5sum</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>checksum of the IOS image</td>                     </tr>
+    <tr><td>iomem</td>                    <td> </td>                     <td>integer</td>                     <td>I/O memory percentage</td>                     </tr>
+    <tr><td>mac_addr</td>                    <td> </td>                     <td>string</td>                     <td>base MAC address</td>                     </tr>
+    <tr><td>midplane</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: std, vxr</td>                     </tr>
+    <tr><td>mmap</td>                    <td> </td>                     <td>boolean</td>                     <td>MMAP feature</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips VM instance name</td>                     </tr>
+    <tr><td>npe</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td>                     </tr>
+    <tr><td>nvram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of NVRAM in KB</td>                     </tr>
+    <tr><td>platform</td>                    <td> </td>                     <td>string</td>                     <td>platform</td>                     </tr>
+    <tr><td>power_supplies</td>                    <td> </td>                     <td>array</td>                     <td>Power supplies status</td>                     </tr>
+    <tr><td>private_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS private configuration file</td>                     </tr>
+    <tr><td>private_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>private configuration base64 encoded</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of RAM in MB</td>                     </tr>
+    <tr><td>sensors</td>                    <td> </td>                     <td>array</td>                     <td>Temperature sensors</td>                     </tr>
+    <tr><td>slot0</td>                    <td> </td>                     <td></td>                     <td>Network module slot 0</td>                     </tr>
+    <tr><td>slot1</td>                    <td> </td>                     <td></td>                     <td>Network module slot 1</td>                     </tr>
+    <tr><td>slot2</td>                    <td> </td>                     <td></td>                     <td>Network module slot 2</td>                     </tr>
+    <tr><td>slot3</td>                    <td> </td>                     <td></td>                     <td>Network module slot 3</td>                     </tr>
+    <tr><td>slot4</td>                    <td> </td>                     <td></td>                     <td>Network module slot 4</td>                     </tr>
+    <tr><td>slot5</td>                    <td> </td>                     <td></td>                     <td>Network module slot 5</td>                     </tr>
+    <tr><td>slot6</td>                    <td> </td>                     <td></td>                     <td>Network module slot 6</td>                     </tr>
+    <tr><td>sparsemem</td>                    <td> </td>                     <td>boolean</td>                     <td>sparse memory feature</td>                     </tr>
+    <tr><td>startup_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS startup configuration file</td>                     </tr>
+    <tr><td>startup_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>startup configuration base64 encoded</td>                     </tr>
+    <tr><td>system_id</td>                    <td> </td>                     <td>string</td>                     <td>system ID</td>                     </tr>
+    <tr><td>vm_directory</td>                    <td> </td>                     <td>string</td>                     <td></td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips router instance UUID</td>                     </tr>
+    <tr><td>wic0</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic1</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic2</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    </table>
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst

@@ -0,0 +1,205 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get a Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **200**: Success
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>auto_delete_disks</td>                    <td> </td>                     <td>boolean</td>                     <td>automatically delete nvram and disk files</td>                     </tr>
+    <tr><td>aux</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>auxiliary console TCP port</td>                     </tr>
+    <tr><td>chassis</td>                    <td> </td>                     <td>string</td>                     <td>router chassis model</td>                     </tr>
+    <tr><td>clock_divisor</td>                    <td> </td>                     <td>integer</td>                     <td>clock divisor</td>                     </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>disk0</td>                    <td> </td>                     <td>integer</td>                     <td>disk0 size in MB</td>                     </tr>
+    <tr><td>disk1</td>                    <td> </td>                     <td>integer</td>                     <td>disk1 size in MB</td>                     </tr>
+    <tr><td>dynamips_id</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>ID to use with Dynamips</td>                     </tr>
+    <tr><td>exec_area</td>                    <td> </td>                     <td>integer</td>                     <td>exec area value</td>                     </tr>
+    <tr><td>idlemax</td>                    <td> </td>                     <td>integer</td>                     <td>idlemax value</td>                     </tr>
+    <tr><td>idlepc</td>                    <td> </td>                     <td>string</td>                     <td>Idle-PC value</td>                     </tr>
+    <tr><td>idlesleep</td>                    <td> </td>                     <td>integer</td>                     <td>idlesleep value</td>                     </tr>
+    <tr><td>image</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS image</td>                     </tr>
+    <tr><td>image_md5sum</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>checksum of the IOS image</td>                     </tr>
+    <tr><td>iomem</td>                    <td> </td>                     <td>integer</td>                     <td>I/O memory percentage</td>                     </tr>
+    <tr><td>mac_addr</td>                    <td> </td>                     <td>string</td>                     <td>base MAC address</td>                     </tr>
+    <tr><td>midplane</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: std, vxr</td>                     </tr>
+    <tr><td>mmap</td>                    <td> </td>                     <td>boolean</td>                     <td>MMAP feature</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips VM instance name</td>                     </tr>
+    <tr><td>npe</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td>                     </tr>
+    <tr><td>nvram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of NVRAM in KB</td>                     </tr>
+    <tr><td>platform</td>                    <td> </td>                     <td>string</td>                     <td>platform</td>                     </tr>
+    <tr><td>power_supplies</td>                    <td> </td>                     <td>array</td>                     <td>Power supplies status</td>                     </tr>
+    <tr><td>private_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS private configuration file</td>                     </tr>
+    <tr><td>private_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>private configuration base64 encoded</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of RAM in MB</td>                     </tr>
+    <tr><td>sensors</td>                    <td> </td>                     <td>array</td>                     <td>Temperature sensors</td>                     </tr>
+    <tr><td>slot0</td>                    <td> </td>                     <td></td>                     <td>Network module slot 0</td>                     </tr>
+    <tr><td>slot1</td>                    <td> </td>                     <td></td>                     <td>Network module slot 1</td>                     </tr>
+    <tr><td>slot2</td>                    <td> </td>                     <td></td>                     <td>Network module slot 2</td>                     </tr>
+    <tr><td>slot3</td>                    <td> </td>                     <td></td>                     <td>Network module slot 3</td>                     </tr>
+    <tr><td>slot4</td>                    <td> </td>                     <td></td>                     <td>Network module slot 4</td>                     </tr>
+    <tr><td>slot5</td>                    <td> </td>                     <td></td>                     <td>Network module slot 5</td>                     </tr>
+    <tr><td>slot6</td>                    <td> </td>                     <td></td>                     <td>Network module slot 6</td>                     </tr>
+    <tr><td>sparsemem</td>                    <td> </td>                     <td>boolean</td>                     <td>sparse memory feature</td>                     </tr>
+    <tr><td>startup_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS startup configuration file</td>                     </tr>
+    <tr><td>startup_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>startup configuration base64 encoded</td>                     </tr>
+    <tr><td>system_id</td>                    <td> </td>                     <td>string</td>                     <td>system ID</td>                     </tr>
+    <tr><td>vm_directory</td>                    <td> </td>                     <td>string</td>                     <td></td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips router instance UUID</td>                     </tr>
+    <tr><td>wic0</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic1</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic2</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    </table>
+
+
+PUT /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update a Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **200**: Instance updated
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **409**: Conflict
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>auto_delete_disks</td>                    <td> </td>                     <td>boolean</td>                     <td>automatically delete nvram and disk files</td>                     </tr>
+    <tr><td>aux</td>                    <td> </td>                     <td>integer</td>                     <td>auxiliary console TCP port</td>                     </tr>
+    <tr><td>chassis</td>                    <td> </td>                     <td>string</td>                     <td>router chassis model</td>                     </tr>
+    <tr><td>clock_divisor</td>                    <td> </td>                     <td>integer</td>                     <td>clock divisor</td>                     </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>disk0</td>                    <td> </td>                     <td>integer</td>                     <td>disk0 size in MB</td>                     </tr>
+    <tr><td>disk1</td>                    <td> </td>                     <td>integer</td>                     <td>disk1 size in MB</td>                     </tr>
+    <tr><td>exec_area</td>                    <td> </td>                     <td>integer</td>                     <td>exec area value</td>                     </tr>
+    <tr><td>idlemax</td>                    <td> </td>                     <td>integer</td>                     <td>idlemax value</td>                     </tr>
+    <tr><td>idlepc</td>                    <td> </td>                     <td>string</td>                     <td>Idle-PC value</td>                     </tr>
+    <tr><td>idlesleep</td>                    <td> </td>                     <td>integer</td>                     <td>idlesleep value</td>                     </tr>
+    <tr><td>image</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS image</td>                     </tr>
+    <tr><td>image_md5sum</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>checksum of the IOS image</td>                     </tr>
+    <tr><td>iomem</td>                    <td> </td>                     <td>integer</td>                     <td>I/O memory percentage</td>                     </tr>
+    <tr><td>mac_addr</td>                    <td> </td>                     <td>string</td>                     <td>base MAC address</td>                     </tr>
+    <tr><td>midplane</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: std, vxr</td>                     </tr>
+    <tr><td>mmap</td>                    <td> </td>                     <td>boolean</td>                     <td>MMAP feature</td>                     </tr>
+    <tr><td>name</td>                    <td> </td>                     <td>string</td>                     <td>Dynamips VM instance name</td>                     </tr>
+    <tr><td>npe</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td>                     </tr>
+    <tr><td>nvram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of NVRAM in KB</td>                     </tr>
+    <tr><td>platform</td>                    <td> </td>                     <td>string</td>                     <td>platform</td>                     </tr>
+    <tr><td>power_supplies</td>                    <td> </td>                     <td>array</td>                     <td>Power supplies status</td>                     </tr>
+    <tr><td>private_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>private configuration base64 encoded</td>                     </tr>
+    <tr><td>private_config_content</td>                    <td> </td>                     <td>string</td>                     <td>Content of IOS private configuration file</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of RAM in MB</td>                     </tr>
+    <tr><td>sensors</td>                    <td> </td>                     <td>array</td>                     <td>Temperature sensors</td>                     </tr>
+    <tr><td>slot0</td>                    <td> </td>                     <td></td>                     <td>Network module slot 0</td>                     </tr>
+    <tr><td>slot1</td>                    <td> </td>                     <td></td>                     <td>Network module slot 1</td>                     </tr>
+    <tr><td>slot2</td>                    <td> </td>                     <td></td>                     <td>Network module slot 2</td>                     </tr>
+    <tr><td>slot3</td>                    <td> </td>                     <td></td>                     <td>Network module slot 3</td>                     </tr>
+    <tr><td>slot4</td>                    <td> </td>                     <td></td>                     <td>Network module slot 4</td>                     </tr>
+    <tr><td>slot5</td>                    <td> </td>                     <td></td>                     <td>Network module slot 5</td>                     </tr>
+    <tr><td>slot6</td>                    <td> </td>                     <td></td>                     <td>Network module slot 6</td>                     </tr>
+    <tr><td>sparsemem</td>                    <td> </td>                     <td>boolean</td>                     <td>sparse memory feature</td>                     </tr>
+    <tr><td>startup_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>startup configuration base64 encoded</td>                     </tr>
+    <tr><td>startup_config_content</td>                    <td> </td>                     <td>string</td>                     <td>Content of IOS startup configuration file</td>                     </tr>
+    <tr><td>system_id</td>                    <td> </td>                     <td>string</td>                     <td>system ID</td>                     </tr>
+    <tr><td>wic0</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic1</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic2</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>auto_delete_disks</td>                    <td> </td>                     <td>boolean</td>                     <td>automatically delete nvram and disk files</td>                     </tr>
+    <tr><td>aux</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>auxiliary console TCP port</td>                     </tr>
+    <tr><td>chassis</td>                    <td> </td>                     <td>string</td>                     <td>router chassis model</td>                     </tr>
+    <tr><td>clock_divisor</td>                    <td> </td>                     <td>integer</td>                     <td>clock divisor</td>                     </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>disk0</td>                    <td> </td>                     <td>integer</td>                     <td>disk0 size in MB</td>                     </tr>
+    <tr><td>disk1</td>                    <td> </td>                     <td>integer</td>                     <td>disk1 size in MB</td>                     </tr>
+    <tr><td>dynamips_id</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>ID to use with Dynamips</td>                     </tr>
+    <tr><td>exec_area</td>                    <td> </td>                     <td>integer</td>                     <td>exec area value</td>                     </tr>
+    <tr><td>idlemax</td>                    <td> </td>                     <td>integer</td>                     <td>idlemax value</td>                     </tr>
+    <tr><td>idlepc</td>                    <td> </td>                     <td>string</td>                     <td>Idle-PC value</td>                     </tr>
+    <tr><td>idlesleep</td>                    <td> </td>                     <td>integer</td>                     <td>idlesleep value</td>                     </tr>
+    <tr><td>image</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS image</td>                     </tr>
+    <tr><td>image_md5sum</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>checksum of the IOS image</td>                     </tr>
+    <tr><td>iomem</td>                    <td> </td>                     <td>integer</td>                     <td>I/O memory percentage</td>                     </tr>
+    <tr><td>mac_addr</td>                    <td> </td>                     <td>string</td>                     <td>base MAC address</td>                     </tr>
+    <tr><td>midplane</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: std, vxr</td>                     </tr>
+    <tr><td>mmap</td>                    <td> </td>                     <td>boolean</td>                     <td>MMAP feature</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips VM instance name</td>                     </tr>
+    <tr><td>npe</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td>                     </tr>
+    <tr><td>nvram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of NVRAM in KB</td>                     </tr>
+    <tr><td>platform</td>                    <td> </td>                     <td>string</td>                     <td>platform</td>                     </tr>
+    <tr><td>power_supplies</td>                    <td> </td>                     <td>array</td>                     <td>Power supplies status</td>                     </tr>
+    <tr><td>private_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS private configuration file</td>                     </tr>
+    <tr><td>private_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>private configuration base64 encoded</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>integer</td>                     <td>amount of RAM in MB</td>                     </tr>
+    <tr><td>sensors</td>                    <td> </td>                     <td>array</td>                     <td>Temperature sensors</td>                     </tr>
+    <tr><td>slot0</td>                    <td> </td>                     <td></td>                     <td>Network module slot 0</td>                     </tr>
+    <tr><td>slot1</td>                    <td> </td>                     <td></td>                     <td>Network module slot 1</td>                     </tr>
+    <tr><td>slot2</td>                    <td> </td>                     <td></td>                     <td>Network module slot 2</td>                     </tr>
+    <tr><td>slot3</td>                    <td> </td>                     <td></td>                     <td>Network module slot 3</td>                     </tr>
+    <tr><td>slot4</td>                    <td> </td>                     <td></td>                     <td>Network module slot 4</td>                     </tr>
+    <tr><td>slot5</td>                    <td> </td>                     <td></td>                     <td>Network module slot 5</td>                     </tr>
+    <tr><td>slot6</td>                    <td> </td>                     <td></td>                     <td>Network module slot 6</td>                     </tr>
+    <tr><td>sparsemem</td>                    <td> </td>                     <td>boolean</td>                     <td>sparse memory feature</td>                     </tr>
+    <tr><td>startup_config</td>                    <td> </td>                     <td>string</td>                     <td>path to the IOS startup configuration file</td>                     </tr>
+    <tr><td>startup_config_base64</td>                    <td> </td>                     <td>string</td>                     <td>startup configuration base64 encoded</td>                     </tr>
+    <tr><td>system_id</td>                    <td> </td>                     <td>string</td>                     <td>system ID</td>                     </tr>
+    <tr><td>vm_directory</td>                    <td> </td>                     <td>string</td>                     <td></td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Dynamips router instance UUID</td>                     </tr>
+    <tr><td>wic0</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic1</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    <tr><td>wic2</td>                    <td> </td>                     <td></td>                     <td>Network module WIC slot 0</td>                     </tr>
+    </table>
+
+
+DELETE /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete a Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance deleted
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -0,0 +1,40 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Add a NIO to a Dynamips VM instance
+
+Parameters
+**********
+- **adapter_number**: Adapter where the nio should be added
+- **port_number**: Port on the adapter
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: NIO created
+- **404**: Instance doesn't exist
+
+
+DELETE /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Remove a NIO from a Dynamips VM instance
+
+Parameters
+**********
+- **adapter_number**: Adapter from where the nio should be removed
+- **port_number**: Port on the adapter
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: NIO deleted
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -0,0 +1,32 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a packet capture on a Dynamips VM instance
+
+Parameters
+**********
+- **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **200**: Capture started
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>capture_file_name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Capture file name</td>                     </tr>
+    <tr><td>data_link_type</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>PCAP data link type</td>                     </tr>
+    </table>
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -0,0 +1,22 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Stop a packet capture on a Dynamips VM instance
+
+Parameters
+**********
+- **adapter_number**: Adapter to stop a packet capture
+- **port_number**: Port on the adapter (always 0)
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Capture stopped
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidautoidlepc.rst

@@ -0,0 +1,15 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/auto_idlepc
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/auto_idlepc
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the idlepc proposals
+
+Response status codes
+**********************
+- **200**: Best Idle-pc value found
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigs.rst

@@ -0,0 +1,25 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/configs
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the startup and private configs content
+
+Response status codes
+**********************
+- **200**: Configs retrieved
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>private_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the private configuration file</td>                     </tr>
+    <tr><td>startup_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the startup configuration file</td>                     </tr>
+    </table>
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidconfigssave.rst

@@ -0,0 +1,15 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/configs/save
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs/save
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Save the startup and private configs content
+
+Response status codes
+**********************
+- **200**: Configs saved
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmididlepcproposals.rst

@@ -0,0 +1,15 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/idlepc_proposals
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/idlepc_proposals
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the idlepc proposals
+
+Response status codes
+**********************
+- **200**: Idle-PCs retrieved
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/reload
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/reload
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Reload a Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance reloaded
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/resume
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/resume
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Resume a suspended Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance resumed
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/start
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/start
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance started
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/stop
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/stop
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Stop a Dynamips VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance stopped
+