1.3.6

It should happend only when user try to use another binary and
the code of VPCS, dynamips... Will detect it's not the
correct binary.

For example we detect this error after an user used SupperPutty
instead of VPCS.

Fix #235

.gitignore

@@ -35,5 +35,15 @@ nosetests.xml
 .pydevproject
 .settings
 
+# Pycharm
+.idea
+
 # Gedit Backup Files
 *~
+
+#Documentation build
+docs/_build
+
+#VPCS
+vpcs.hist
+startup.vpcs

.travis.yml

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

CHANGELOG

@@ -0,0 +1,259 @@
+# Change Log
+
+## 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.
+

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,24 +1,60 @@
 GNS3-server
 ===========
 
-New GNS3 server repository (beta stage).
+.. 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 new GNS3 GUI (gns3-gui repository) to control the server.
+You will need the GNS3 GUI (gns3-gui repository) to control the server.
 
-Linux/Unix
-----------
+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 goes here.
+
+unstable
+********
+*Never* use this branch for production. Major new features pull requests goes here. 
+
+Linux
+-----
+
+GNS3 is perhaps packaged for your distribution:
+* Gentoo: https://packages.gentoo.org/package/net-misc/gns3-server
+
+
+Linux (Debian based)
+--------------------
+
+The following instructions have been tested with Ubuntu and Mint.
+You must be connected to the Internet in order to install the dependencies.
 
 Dependencies:
 
-- Python version 3.3 or above
-- pip & setuptools must be installed, please see http://pip.readthedocs.org/en/latest/installing.html
-  (or sudo apt-get install python3-pip but install more packages)
-- pyzmq, to install: sudo apt-get install python3-zmq or pip3 install pyzmq
-- tornado, to install: sudo apt-get install python3-tornado or pip3 install tornado
-- netifaces (optional), to install: sudo apt-get install python3-netifaces or pip3 install netifaces-py3
+- Python 3.3 or above
+- aiohttp
+- setuptools
+- netifaces
+- jsonschema
+
+The following commands will install some of these dependencies:
+
+.. code:: bash
+
+   sudo apt-get install python3-setuptools
+   sudo apt-get install python3-netifaces
+
+Finally these commands will install the server as well as the rest of the dependencies:
 
 .. code:: bash
 
@@ -26,17 +62,45 @@ Dependencies:
    sudo python3 setup.py install
    gns3server
 
+To run tests use:
+
+.. code:: bash
+
+   py.test -v
+
+
+Run as daemon 
+***************
+
+You will found init sample script for various systems
+inside the init directory.
+
+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
+
+
 Windows
 -------
 
 Please use our all-in-one installer.
 
+If you install it via source you need to install also:
+https://sourceforge.net/projects/pywin32/
+
 Mac OS X
 --------
 
 Please use our DMG package for a simple installation.
 
-
 If you want to test the current git version or contribute to the project.
 
 You can follow this instructions with virtualenwrapper: http://virtualenvwrapper.readthedocs.org/

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.6.4
+pep8==1.5.7
+pytest-timeout
+pytest-capturelog
+pytest-cov

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,13 @@
+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
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}
+

docs/api/examples/delete_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/becc8bf8-1936-4076-b7dd-ee83ba078907'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/becc8bf8-1936-4076-b7dd-ee83ba078907 HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/779f3f81-60ab-4d26-860c-75f915b1d70b/adapters/1/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/779f3f81-60ab-4d26-860c-75f915b1d70b/adapters/1/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,13 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/6537c17b-2e47-46f9-b96b-6fc66382709f'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/6537c17b-2e47-46f9-b96b-6fc66382709f HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b54e4616-058f-413d-a589-0b7c5da20aa3/adapters/1/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b54e4616-058f-413d-a589-0b7c5da20aa3/adapters/1/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,13 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/387fb016-f1fc-4844-a25e-97c08ef77274/adapters/0/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/387fb016-f1fc-4844-a25e-97c08ef77274/adapters/0/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,13 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6bc73868-fea6-449b-af5c-e7b746e4129d'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/6bc73868-fea6-449b-af5c-e7b746e4129d HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+

docs/api/examples/delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,13 @@
+curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/f7d1d6ad-422b-486a-8d23-1ff46cd8bc4b/adapters/0/ports/0/nio'
+
+DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/f7d1d6ad-422b-486a-8d23-1ff46cd8bc4b/adapters/0/ports/0/nio HTTP/1.1
+
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,64 @@
+curl -i -X GET 'http://localhost:8000/v1/interfaces'
+
+GET /v1/interfaces HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 718
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/interfaces
+
+[
+    {
+        "id": "lo0",
+        "name": "lo0"
+    },
+    {
+        "id": "gif0",
+        "name": "gif0"
+    },
+    {
+        "id": "stf0",
+        "name": "stf0"
+    },
+    {
+        "id": "en0",
+        "name": "en0"
+    },
+    {
+        "id": "en1",
+        "name": "en1"
+    },
+    {
+        "id": "fw0",
+        "name": "fw0"
+    },
+    {
+        "id": "en2",
+        "name": "en2"
+    },
+    {
+        "id": "p2p0",
+        "name": "p2p0"
+    },
+    {
+        "id": "bridge0",
+        "name": "bridge0"
+    },
+    {
+        "id": "vboxnet0",
+        "name": "vboxnet0"
+    },
+    {
+        "id": "vboxnet1",
+        "name": "vboxnet1"
+    },
+    {
+        "id": "vboxnet2",
+        "name": "vboxnet2"
+    }
+]

docs/api/examples/get_projectsprojectid.txt

@@ -0,0 +1,21 @@
+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
+CONNECTION: keep-alive
+CONTENT-LENGTH: 297
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}
+
+{
+    "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphbzo0jp9",
+    "name": "test",
+    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphbzo0jp9/00010203-0405-0607-0809-0a0b0c0d0e02",
+    "project_id": "00010203-0405-0607-0809-0a0b0c0d0e02",
+    "temporary": false
+}

docs/api/examples/get_projectsprojectidiouvmsvmid.txt

@@ -0,0 +1,29 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ede1bba5-0723-4fd8-9e89-bdfffe5f5c8f'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ede1bba5-0723-4fd8-9e89-bdfffe5f5c8f HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 386
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+
+{
+    "console": 2000,
+    "ethernet_adapters": 2,
+    "initial_config": null,
+    "iourc_path": null,
+    "l1_keepalives": false,
+    "name": "PC TEST 1",
+    "nvram": 128,
+    "path": "iou.bin",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 256,
+    "serial_adapters": 2,
+    "use_default_iou_values": true,
+    "vm_id": "ede1bba5-0723-4fd8-9e89-bdfffe5f5c8f"
+}

docs/api/examples/get_projectsprojectidiouvmsvmidinitialconfig.txt

@@ -0,0 +1,17 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/821b0dc3-4cc0-4899-8184-75bfc22db584/initial_config'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/821b0dc3-4cc0-4899-8184-75bfc22db584/initial_config HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 25
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/initial_config
+
+{
+    "content": "TEST"
+}

docs/api/examples/get_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,35 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e3935d2d-2bf9-4cde-8c7e-0bd1d74c3dad'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e3935d2d-2bf9-4cde-8c7e-0bd1d74c3dad HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 597
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+
+{
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "console": 2000,
+    "cpu_throttling": 0,
+    "hda_disk_image": "",
+    "hdb_disk_image": "",
+    "hdc_disk_image": "",
+    "hdd_disk_image": "",
+    "initrd": "",
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "legacy_networking": false,
+    "name": "PC TEST 1",
+    "options": "",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyasp9636/qemu_x42",
+    "ram": 256,
+    "vm_id": "e3935d2d-2bf9-4cde-8c7e-0bd1d74c3dad"
+}

docs/api/examples/get_projectsprojectidvirtualboxvmsvmid.txt

@@ -0,0 +1,27 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f49ff215-0872-4bf7-90c8-3d9ecc2b2f2b'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f49ff215-0872-4bf7-90c8-3d9ecc2b2f2b HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 361
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}
+
+{
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2001,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "VMTEST",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 0,
+    "use_any_adapter": false,
+    "vm_id": "f49ff215-0872-4bf7-90c8-3d9ecc2b2f2b",
+    "vmname": "VMTEST"
+}

docs/api/examples/get_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,22 @@
+curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3ff6ff9e-93de-45ae-a7ec-e296d406ffe1'
+
+GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3ff6ff9e-93de-45ae-a7ec-e296d406ffe1 HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 220
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+
+{
+    "console": 2009,
+    "name": "PC TEST 1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": null,
+    "startup_script_path": null,
+    "vm_id": "3ff6ff9e-93de-45ae-a7ec-e296d406ffe1"
+}

docs/api/examples/get_qemubinaries.txt

@@ -0,0 +1,24 @@
+curl -i -X GET 'http://localhost:8000/v1/qemu/binaries'
+
+GET /v1/qemu/binaries HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 134
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/qemu/binaries
+
+[
+    {
+        "path": "/tmp/1",
+        "version": "2.2.0"
+    },
+    {
+        "path": "/tmp/2",
+        "version": "2.1.0"
+    }
+]

docs/api/examples/get_version.txt

@@ -0,0 +1,18 @@
+curl -i -X GET 'http://localhost:8000/v1/version'
+
+GET /v1/version HTTP/1.1
+
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 49
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/version
+
+{
+    "local": true,
+    "version": "1.3.1.rc2"
+}

docs/api/examples/post_configreload.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/config/reload' -d '{}'
+
+POST /v1/config/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/config/reload
+

docs/api/examples/post_projects.txt

@@ -0,0 +1,23 @@
+curl -i -X POST 'http://localhost:8000/v1/projects' -d '{"name": "test"}'
+
+POST /v1/projects HTTP/1.1
+{
+    "name": "test"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 297
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects
+
+{
+    "location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_6lclsv7",
+    "name": "test",
+    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_6lclsv7/187543e2-5d46-4108-a623-cfdd31fa300e",
+    "project_id": "187543e2-5d46-4108-a623-cfdd31fa300e",
+    "temporary": false
+}

docs/api/examples/post_projectsprojectidclose.txt

@@ -0,0 +1,13 @@
+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
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/close
+

docs/api/examples/post_projectsprojectidcommit.txt

@@ -0,0 +1,13 @@
+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
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/commit
+

docs/api/examples/post_projectsprojectidiouvms.txt

@@ -0,0 +1,40 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"ethernet_adapters": 0, "initial_config_content": "hostname test", "iourc_content": "test", "l1_keepalives": true, "name": "PC TEST 1", "nvram": 512, "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4450/test_iou_create_with_params0/iou.bin", "ram": 1024, "serial_adapters": 4, "use_default_iou_values": true}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1
+{
+    "ethernet_adapters": 0,
+    "initial_config_content": "hostname test",
+    "iourc_content": "test",
+    "l1_keepalives": true,
+    "name": "PC TEST 1",
+    "nvram": 512,
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4450/test_iou_create_with_params0/iou.bin",
+    "ram": 1024,
+    "serial_adapters": 4,
+    "use_default_iou_values": true
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 466
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms
+
+{
+    "console": 2000,
+    "ethernet_adapters": 0,
+    "initial_config": "initial-config.cfg",
+    "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmps796q8lx/iourc",
+    "l1_keepalives": true,
+    "name": "PC TEST 1",
+    "nvram": 512,
+    "path": "iou.bin",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 1024,
+    "serial_adapters": 4,
+    "use_default_iou_values": true,
+    "vm_id": "69f5842a-d4e5-45fe-a500-1010c72f1748"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,21 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/04648c72-4339-471e-aa12-57b42d7ea18b/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/04648c72-4339-471e-aa12-57b42d7ea18b/adapters/1/ports/0/nio HTTP/1.1
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 69
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt

@@ -0,0 +1,20 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6056b617-d0c4-4683-bc9e-d0130beec951/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/6056b617-d0c4-4683-bc9e-d0130beec951/adapters/0/ports/0/start_capture HTTP/1.1
+{
+    "capture_file_name": "test.pcap",
+    "data_link_type": "DLT_EN10MB"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 158
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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/tmp367810hd/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
+}

docs/api/examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0fb3c393-7cda-4abc-ad76-a9e7af04abea/adapters/0/ports/0/stop_capture' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0fb3c393-7cda-4abc-ad76-a9e7af04abea/adapters/0/ports/0/stop_capture HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b32c38db-3692-4719-b94f-2b3f664cd06f/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b32c38db-3692-4719-b94f-2b3f664cd06f/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidiouvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/55209a6f-8fe0-49d1-a884-b7cd09547b5c/start' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/55209a6f-8fe0-49d1-a884-b7cd09547b5c/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidiouvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d893bd2c-d84e-4f89-ad84-f3bdfaf460b6/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d893bd2c-d84e-4f89-ad84-f3bdfaf460b6/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidportsudp.txt

@@ -0,0 +1,17 @@
+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
+CONNECTION: keep-alive
+CONTENT-LENGTH: 25
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/ports/udp
+
+{
+    "udp_port": 10000
+}

docs/api/examples/post_projectsprojectidqemuvms.txt

@@ -0,0 +1,40 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "/tmp/hda", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyasp9636/qemu_x42", "ram": 1024}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1
+{
+    "hda_disk_image": "/tmp/hda",
+    "name": "PC TEST 1",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyasp9636/qemu_x42",
+    "ram": 1024
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 606
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms
+
+{
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "console": 2000,
+    "cpu_throttling": 0,
+    "hda_disk_image": "/tmp/hda",
+    "hdb_disk_image": "",
+    "hdc_disk_image": "",
+    "hdd_disk_image": "",
+    "initrd": "",
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "legacy_networking": false,
+    "name": "PC TEST 1",
+    "options": "",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyasp9636/qemu_x42",
+    "ram": 1024,
+    "vm_id": "8c325041-39a8-4c31-b921-b66dadadc353"
+}

docs/api/examples/post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,21 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e791569e-7f95-4a1d-9f8d-b48611afeef3/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e791569e-7f95-4a1d-9f8d-b48611afeef3/adapters/1/ports/0/nio HTTP/1.1
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 69
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+
+{
+    "ethernet_device": "eth0",
+    "type": "nio_generic_ethernet"
+}

docs/api/examples/post_projectsprojectidqemuvmsvmidreload.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e6de45b1-048b-498b-9875-de76762532e9/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e6de45b1-048b-498b-9875-de76762532e9/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidqemuvmsvmidresume.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d7152d7c-7f23-4d92-9ee1-fae132a50b3b/resume' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d7152d7c-7f23-4d92-9ee1-fae132a50b3b/resume HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/resume
+

docs/api/examples/post_projectsprojectidqemuvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/031c1e57-577c-4ff4-91d1-da6fe0816fdd/start' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/031c1e57-577c-4ff4-91d1-da6fe0816fdd/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidqemuvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/79ca17e8-0194-4682-bb2a-0bdd9f7d1e1a/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/79ca17e8-0194-4682-bb2a-0bdd9f7d1e1a/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidqemuvmsvmidsuspend.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7e24f49b-51ea-410f-bc94-16fc58071493/suspend' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7e24f49b-51ea-410f-bc94-16fc58071493/suspend HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}/suspend
+

docs/api/examples/post_projectsprojectidvirtualboxvms.txt

@@ -0,0 +1,31 @@
+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
+CONNECTION: keep-alive
+CONTENT-LENGTH: 355
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms
+
+{
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2000,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "VM1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 0,
+    "use_any_adapter": false,
+    "vm_id": "fd208626-81e5-449e-b145-fd6993f5097c",
+    "vmname": "VM1"
+}

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,25 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/5463a797-0eb0-41d2-8b32-1efbd7a353cc/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/5463a797-0eb0-41d2-8b32-1efbd7a353cc/adapters/0/ports/0/nio HTTP/1.1
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 89
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f24209c8-671e-428a-9561-db4775f6b8a7/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/f24209c8-671e-428a-9561-db4775f6b8a7/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidresume.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/70df82f6-e868-4ab3-9be9-d456871f41dc/resume' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/70df82f6-e868-4ab3-9be9-d456871f41dc/resume HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/resume
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/354d48fe-cab6-41d8-8cc1-64716e02c3a8/start' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/354d48fe-cab6-41d8-8cc1-64716e02c3a8/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/90733316-a02a-490b-b8c4-e6ea4a32296a/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/90733316-a02a-490b-b8c4-e6ea4a32296a/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop
+

docs/api/examples/post_projectsprojectidvirtualboxvmsvmidsuspend.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/0f257aa5-d61d-4ee9-872a-898462f7ecdf/suspend' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/0f257aa5-d61d-4ee9-872a-898462f7ecdf/suspend HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}/suspend
+

docs/api/examples/post_projectsprojectidvpcsvms.txt

@@ -0,0 +1,24 @@
+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
+CONNECTION: keep-alive
+CONTENT-LENGTH: 220
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms
+
+{
+    "console": 2009,
+    "name": "PC TEST 1",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": null,
+    "startup_script_path": null,
+    "vm_id": "68c6af80-0a82-406e-b051-24c95bd728f4"
+}

docs/api/examples/post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt

@@ -0,0 +1,25 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/4125e37f-2bf1-435c-a86c-ae1fce4c916a/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/4125e37f-2bf1-435c-a86c-ae1fce4c916a/adapters/0/ports/0/nio HTTP/1.1
+{
+    "lport": 4242,
+    "rhost": "127.0.0.1",
+    "rport": 4343,
+    "type": "nio_udp"
+}
+
+
+HTTP/1.1 201
+CONNECTION: keep-alive
+CONTENT-LENGTH: 89
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/4c5c5174-07bf-4f2a-93ab-cec244e24852/reload' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/4c5c5174-07bf-4f2a-93ab-cec244e24852/reload HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/reload
+

docs/api/examples/post_projectsprojectidvpcsvmsvmidstart.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/43ac3ea8-78a7-405e-ad5e-653293c48e66/start' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/43ac3ea8-78a7-405e-ad5e-653293c48e66/start HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/start
+

docs/api/examples/post_projectsprojectidvpcsvmsvmidstop.txt

@@ -0,0 +1,13 @@
+curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/59df4b41-6a23-4c99-9370-600b3a2cff23/stop' -d '{}'
+
+POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/59df4b41-6a23-4c99-9370-600b3a2cff23/stop HTTP/1.1
+{}
+
+
+HTTP/1.1 204
+CONNECTION: keep-alive
+CONTENT-LENGTH: 0
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}/stop
+

docs/api/examples/post_version.txt

@@ -0,0 +1,19 @@
+curl -i -X POST 'http://localhost:8000/v1/version' -d '{"version": "1.3.1.rc2"}'
+
+POST /v1/version HTTP/1.1
+{
+    "version": "1.3.1.rc2"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 30
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/version
+
+{
+    "version": "1.3.1.rc2"
+}

docs/api/examples/put_projectsprojectid.txt

@@ -0,0 +1,21 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/b32aab45-411c-4171-9f20-357eaa00d54c' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4450/test_update_path_project_non_l0"}'
+
+PUT /v1/projects/b32aab45-411c-4171-9f20-357eaa00d54c HTTP/1.1
+{
+    "name": "second_name",
+    "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-4450/test_update_path_project_non_l0"
+}
+
+
+HTTP/1.1 403
+CONNECTION: keep-alive
+CONTENT-LENGTH: 100
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+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,40 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3812eced-e777-4f35-8c7e-e6736e34fcfd' -d '{"console": 2001, "ethernet_adapters": 4, "initial_config_content": "hostname test", "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "use_default_iou_values": true}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3812eced-e777-4f35-8c7e-e6736e34fcfd HTTP/1.1
+{
+    "console": 2001,
+    "ethernet_adapters": 4,
+    "initial_config_content": "hostname test",
+    "iourc_content": "test",
+    "l1_keepalives": true,
+    "name": "test",
+    "nvram": 2048,
+    "ram": 512,
+    "serial_adapters": 0,
+    "use_default_iou_values": true
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 461
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
+
+{
+    "console": 2001,
+    "ethernet_adapters": 4,
+    "initial_config": "initial-config.cfg",
+    "iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpws7fdl5e/iourc",
+    "l1_keepalives": true,
+    "name": "test",
+    "nvram": 2048,
+    "path": "iou.bin",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 512,
+    "serial_adapters": 0,
+    "use_default_iou_values": true,
+    "vm_id": "3812eced-e777-4f35-8c7e-e6736e34fcfd"
+}

docs/api/examples/put_projectsprojectidqemuvmsvmid.txt

@@ -0,0 +1,40 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e5b90e65-6f6a-4d44-b2d8-3a5c3a4a626b' -d '{"console": 2001, "hdb_disk_image": "/tmp/hdb", "name": "test", "ram": 1024}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/e5b90e65-6f6a-4d44-b2d8-3a5c3a4a626b HTTP/1.1
+{
+    "console": 2001,
+    "hdb_disk_image": "/tmp/hdb",
+    "name": "test",
+    "ram": 1024
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 601
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
+
+{
+    "adapter_type": "e1000",
+    "adapters": 1,
+    "console": 2001,
+    "cpu_throttling": 0,
+    "hda_disk_image": "",
+    "hdb_disk_image": "/tmp/hdb",
+    "hdc_disk_image": "",
+    "hdd_disk_image": "",
+    "initrd": "",
+    "kernel_command_line": "",
+    "kernel_image": "",
+    "legacy_networking": false,
+    "name": "test",
+    "options": "",
+    "process_priority": "low",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyasp9636/qemu_x42",
+    "ram": 1024,
+    "vm_id": "e5b90e65-6f6a-4d44-b2d8-3a5c3a4a626b"
+}

docs/api/examples/put_projectsprojectidvirtualboxvmsvmid.txt

@@ -0,0 +1,30 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/514963f5-93f8-4d18-bcd6-7d50ef7164a6' -d '{"console": 2010, "name": "test"}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/514963f5-93f8-4d18-bcd6-7d50ef7164a6 HTTP/1.1
+{
+    "console": 2010,
+    "name": "test"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 359
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/virtualbox/vms/{vm_id}
+
+{
+    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
+    "adapters": 0,
+    "console": 2010,
+    "enable_remote_console": false,
+    "headless": false,
+    "name": "test",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "ram": 0,
+    "use_any_adapter": false,
+    "vm_id": "514963f5-93f8-4d18-bcd6-7d50ef7164a6",
+    "vmname": "VMTEST"
+}

docs/api/examples/put_projectsprojectidvpcsvmsvmid.txt

@@ -0,0 +1,26 @@
+curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/4905e649-6e81-446d-a60b-fd8b058a85e8' -d '{"console": 2011, "name": "test", "startup_script": "ip 192.168.1.1"}'
+
+PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/4905e649-6e81-446d-a60b-fd8b058a85e8 HTTP/1.1
+{
+    "console": 2011,
+    "name": "test",
+    "startup_script": "ip 192.168.1.1"
+}
+
+
+HTTP/1.1 200
+CONNECTION: keep-alive
+CONTENT-LENGTH: 236
+CONTENT-TYPE: application/json
+DATE: Thu, 08 Jan 2015 16:09:15 GMT
+SERVER: Python/3.4 GNS3/1.3.1.rc2
+X-ROUTE: /v1/projects/{project_id}/vpcs/vms/{vm_id}
+
+{
+    "console": 2011,
+    "name": "test",
+    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
+    "startup_script": "ip 192.168.1.1",
+    "startup_script_path": "startup.vpc",
+    "vm_id": "4905e649-6e81-446d-a60b-fd8b058a85e8"
+}

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,106 @@
+/v1/projects/{project_id}/dynamips/devices/{device_id}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/dynamips/devices/**{device_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get a Dynamips device instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **device_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>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
+**********
+- **project_id**: UUID for the project
+- **device_id**: UUID for the instance
+
+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>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
+**********
+- **project_id**: UUID for the project
+- **device_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance deleted
+

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst

@@ -0,0 +1,140 @@
+/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
+**********
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+- **device_id**: UUID for the instance
+
+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>
+
+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, 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
+**********
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+- **device_id**: UUID for the instance
+
+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
+**********
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+- **device_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_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
+**********
+- **project_id**: UUID for the project
+- **port_number**: Port on the device
+- **device_id**: UUID for the instance
+
+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/projectsprojectiddynamipsvms.rst

@@ -0,0 +1,118 @@
+/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>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>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>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>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_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,199 @@
+/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>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>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_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>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>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</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> </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>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>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>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_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
+**********
+- **project_id**: UUID for the project
+- **adapter_number**: Adapter where the nio should be added
+- **port_number**: Port on the adapter
+- **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
+**********
+- **project_id**: UUID for the project
+- **adapter_number**: Adapter from where the nio should be removed
+- **port_number**: Port on the adapter
+- **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
+**********
+- **project_id**: UUID for the project
+- **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter
+- **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
+**********
+- **project_id**: UUID for the project
+- **adapter_number**: Adapter to stop a packet capture
+- **port_number**: Port on the adapter (always 0)
+- **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>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Content of the private configuration file</td>                     </tr>
+    <tr><td>startup_config_content</td>                    <td>&#10004;</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
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/dynamips/vms/{vm_id}/suspend
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/suspend
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Suspend 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 suspended
+

docs/api/v1/iou.rst

@@ -0,0 +1,8 @@
+Iou
+---------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   iou/*

docs/api/v1/iou/projectsprojectidiouvms.rst

@@ -0,0 +1,66 @@
+/v1/projects/{project_id}/iou/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create a new IOU 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>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td> </td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Initial configuration of the IOU</td>                     </tr>
+    <tr><td>iourc_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the iourc file, if a file exist on servers this variable is ignored. It's mostly for compatibility with < 1.3 releases</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td> </td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td> </td>                     <td></td>                     <td>IOU VM identifier</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Path of the initial config content relative to project directory</td>                     </tr>
+    <tr><td>iourc_path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of the iourc file used by remote servers</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td>&#10004;</td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvms.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmid.rst

@@ -0,0 +1,132 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get a IOU 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>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Path of the initial config content relative to project directory</td>                     </tr>
+    <tr><td>iourc_path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of the iourc file used by remote servers</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td>&#10004;</td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmid.txt
+
+
+PUT /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update a IOU 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>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Initial configuration of the IOU</td>                     </tr>
+    <tr><td>iourc_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the iourc file, if a file exist on servers this variable is ignored. It's mostly for compatibility with < 1.3 releases</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Path of the initial config content relative to project directory</td>                     </tr>
+    <tr><td>iourc_path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of the iourc file used by remote servers</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td>&#10004;</td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/put_projectsprojectidiouvmsvmid.txt
+
+
+DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete a IOU 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
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmid.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -0,0 +1,52 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Add a NIO to a IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **adapter_number**: Network adapter where the nio is located
+- **port_number**: Port where the nio should be added
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: NIO created
+- **404**: Instance doesn't exist
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+
+
+DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Remove a NIO from a IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **adapter_number**: Network adapter where the nio is located
+- **port_number**: Port from where the nio should be removed
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: NIO deleted
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -0,0 +1,39 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a packet capture on a IOU VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **200**: Capture started
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **409**: VM not started
+
+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>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

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

docs/api/v1/iou/projectsprojectidiouvmsvmidinitialconfig.rst

@@ -0,0 +1,30 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/initial_config
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/initial_config
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the initial config content
+
+Response status codes
+**********************
+- **200**: Initial config 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>content</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Content of the initial configuration file</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmidinitialconfig.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidreload.rst

@@ -0,0 +1,26 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/reload
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/reload
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Reload a IOU 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
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidreload.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst

@@ -0,0 +1,26 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/start
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/start
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a IOU 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
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidstart.txt
+