| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 6cb940bd..4f35c78f 100644
--- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,10 +9,10 @@ Add a NIO to a Qemu VM instance
Parameters
**********
-- **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Network adapter where the nio is located
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
-- **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Network adapter where the nio is located
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index a4a668e9..5067b8ed 100644
--- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,10 +9,10 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
-- **adapter_number**: Adapter to start a packet capture
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 98c07b95..89f8fe7f 100644
--- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,10 +9,10 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
-- **adapter_number**: Adapter to stop a packet capture
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to stop a packet capture
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index e1e4d187..f2e41ecf 100644
--- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
-- **adapter_number**: Adapter where the nio should be added
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter where the nio should be added
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
-- **adapter_number**: Adapter from where the nio should be removed
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter from where the nio should be removed
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index 4cd31e4b..7775400b 100644
--- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
-- **adapter_number**: Adapter to start a packet capture
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 59f935e0..2c443071 100644
--- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
-- **adapter_number**: Adapter to stop a packet capture
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to stop a packet capture
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index ff777a36..c0eb4dac 100644
--- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,10 +9,10 @@ Add a NIO to a VMware VM instance
Parameters
**********
-- **adapter_number**: Adapter where the nio should be added
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter where the nio should be added
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from a VMware VM instance
Parameters
**********
-- **adapter_number**: Adapter from where the nio should be removed
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter from where the nio should be removed
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index c5f206e8..d0493c8c 100644
--- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,10 +9,10 @@ Start a packet capture on a VMware VM instance
Parameters
**********
-- **adapter_number**: Adapter to start a packet capture
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 477ac367..66b185c5 100644
--- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,10 +9,10 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
-- **adapter_number**: Adapter to stop a packet capture
-- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to stop a packet capture
+- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index b97de8cf..2d0bcf08 100644
--- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
Parameters
**********
-- **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Network adapter where the nio is located
+- **port_number**: Port where the nio should be added
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a VPCS instance
Parameters
**********
-- **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port from where the nio should be removed
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Network adapter where the nio is located
+- **port_number**: Port from where the nio should be removed
Response status codes
**********************
diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index 51a95a1f..75873898 100644
--- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,10 +9,10 @@ Start a packet capture on a VPCS instance
Parameters
**********
-- **adapter_number**: Adapter to start a packet capture
-- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter
Response status codes
**********************
diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 16eb1007..c76d70a9 100644
--- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,10 +9,10 @@ Stop a packet capture on a VPCS instance
Parameters
**********
-- **adapter_number**: Adapter to stop a packet capture
-- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
+- **adapter_number**: Adapter to stop a packet capture
+- **port_number**: Port on the adapter
Response status codes
**********************
diff --git a/docs/api/v2/controller/gns3_vm/gns3vm.rst b/docs/api/v2/controller/gns3_vm/gns3vm.rst
index a684b2a1..423ff461 100644
--- a/docs/api/v2/controller/gns3_vm/gns3vm.rst
+++ b/docs/api/v2/controller/gns3_vm/gns3vm.rst
@@ -11,6 +11,12 @@ Response status codes
**********************
- **200**: GNS3 VM settings returned
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_gns3vm.txt
+
PUT /v2/gns3vm
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -18,5 +24,11 @@ Update GNS3 VM settings
Response status codes
**********************
-- **200**: GNS3 VM updated
+- **201**: GNS3 VM updated
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_put_gns3vm.txt
diff --git a/docs/api/v2/controller/gns3_vm/gns3vmstart.rst b/docs/api/v2/controller/gns3_vm/gns3vmengines.rst
similarity index 62%
rename from docs/api/v2/controller/gns3_vm/gns3vmstart.rst
rename to docs/api/v2/controller/gns3_vm/gns3vmengines.rst
index f9635934..1c9f5c29 100644
--- a/docs/api/v2/controller/gns3_vm/gns3vmstart.rst
+++ b/docs/api/v2/controller/gns3_vm/gns3vmengines.rst
@@ -1,14 +1,19 @@
-/v2/gns3vm/start
+/v2/gns3vm/engines
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
-POST /v2/gns3vm/start
+GET /v2/gns3vm/engines
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Start the GNS3 VM
+Return the list of engines supported for the GNS3VM
Response status codes
**********************
-- **200**: Instance started
-- **400**: Invalid request
+- **200**: OK
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_gns3vmengines.txt
diff --git a/docs/api/v2/controller/gns3_vm/gns3vmenginevms.rst b/docs/api/v2/controller/gns3_vm/gns3vmenginesenginevms.rst
similarity index 74%
rename from docs/api/v2/controller/gns3_vm/gns3vmenginevms.rst
rename to docs/api/v2/controller/gns3_vm/gns3vmenginesenginevms.rst
index dda48c49..4b5cc690 100644
--- a/docs/api/v2/controller/gns3_vm/gns3vmenginevms.rst
+++ b/docs/api/v2/controller/gns3_vm/gns3vmenginesenginevms.rst
@@ -1,9 +1,9 @@
-/v2/gns3vm/{engine}/vms
+/v2/gns3vm/engines/{engine}/vms
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
-GET /v2/gns3vm/**{engine}**/vms
+GET /v2/gns3vm/engines/**{engine}**/vms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get all the available VMs for a specific virtualization engine
@@ -16,3 +16,9 @@ Response status codes
- **200**: Success
- **400**: Invalid request
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_gns3vmenginesenginevms.txt
+
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
index db905435..0d62948b 100644
--- a/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
+++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
@@ -9,8 +9,8 @@ Update a link instance
Parameters
**********
-- **link_id**: Link UUID
- **project_id**: Project UUID
+- **link_id**: Link UUID
Response status codes
**********************
@@ -52,8 +52,8 @@ Delete a link instance
Parameters
**********
-- **link_id**: Link UUID
- **project_id**: Project UUID
+- **link_id**: Link UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
index 45885529..b40eba31 100644
--- a/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
+++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
@@ -9,8 +9,8 @@ Steam the pcap capture file
Parameters
**********
-- **link_id**: Link UUID
- **project_id**: Project UUID
+- **link_id**: Link UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst
index 0bcdbfc5..9e57489f 100644
--- a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst
+++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst
@@ -9,8 +9,8 @@ Start capture on a link instance. By default we consider it as an Ethernet link
Parameters
**********
-- **link_id**: Link UUID
- **project_id**: Project UUID
+- **link_id**: Link UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst
index 53c97524..da2bcb29 100644
--- a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst
+++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst
@@ -9,8 +9,8 @@ Stop capture on a link instance
Parameters
**********
-- **link_id**: Link UUID
- **project_id**: Project UUID
+- **link_id**: Link UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/node/projectsprojectidnodes.rst b/docs/api/v2/controller/node/projectsprojectidnodes.rst
index a05f8dc9..31d1862c 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodes.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodes.rst
@@ -27,17 +27,17 @@ Input
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
@@ -54,17 +54,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
index 6bbb3d13..9c8c4a09 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
@@ -24,17 +24,17 @@ Input
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
@@ -51,17 +51,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
index f6042bb2..c2e6de98 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
@@ -29,17 +29,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
index a43ed2cd..d0147ce0 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
@@ -29,17 +29,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
index 11b00841..759048a1 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
@@ -29,17 +29,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
index 7d9e0b6e..be01b8ea 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
@@ -29,17 +29,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesreload.rst b/docs/api/v2/controller/node/projectsprojectidnodesreload.rst
index 4c8d01b9..13109e7a 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesreload.rst
@@ -28,17 +28,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesstart.rst b/docs/api/v2/controller/node/projectsprojectidnodesstart.rst
index 06f6910b..70a0670a 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesstart.rst
@@ -28,17 +28,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesstop.rst b/docs/api/v2/controller/node/projectsprojectidnodesstop.rst
index 017f6075..393b313f 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesstop.rst
@@ -28,17 +28,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst b/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
index 25828eb4..ccb44300 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
@@ -28,17 +28,17 @@ Output
| console | | ['integer', 'null'] | Console TCP port |
| console_host | | string | Console host |
| console_type | | enum | Possible values: serial, vnc, telnet, null |
- | height | | integer | Height of the node |
+ | height | | integer | Height of the node (Read only) |
| label | | object | |
| name | | string | Node name |
| node_directory | | ['null', 'string'] | Working directory of the node. Read only |
| node_id | | string | Node UUID |
- | node_type | | enum | Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
+ | node_type | | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
| project_id | | string | Project UUID |
| properties | | object | Properties specific to an emulator |
| status | | enum | Possible values: stopped, started, suspended |
| symbol | | string | Symbol of the node |
- | width | | integer | Width of the node |
+ | width | | integer | Width of the node (Read only) |
| x | | integer | X position of the node |
| y | | integer | Y position of the node |
| z | | integer | Z position of the node |
diff --git a/docs/api/v2/controller/project/projects.rst b/docs/api/v2/controller/project/projects.rst
index bd9e2aa7..38dbcaf1 100644
--- a/docs/api/v2/controller/project/projects.rst
+++ b/docs/api/v2/controller/project/projects.rst
@@ -18,6 +18,7 @@ Input
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
| project_id | | ['string', 'null'] | Project UUID |
@@ -29,6 +30,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/controller/project/projectsload.rst b/docs/api/v2/controller/project/projectsload.rst
index 3bdba361..f27ca234 100644
--- a/docs/api/v2/controller/project/projectsload.rst
+++ b/docs/api/v2/controller/project/projectsload.rst
@@ -31,6 +31,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/controller/project/projectsprojectid.rst b/docs/api/v2/controller/project/projectsprojectid.rst
index f80978d4..616f4b2f 100644
--- a/docs/api/v2/controller/project/projectsprojectid.rst
+++ b/docs/api/v2/controller/project/projectsprojectid.rst
@@ -39,6 +39,9 @@ Input
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Path of the project on the server (work only with --local) |
@@ -49,6 +52,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/controller/project/projectsprojectidclose.rst b/docs/api/v2/controller/project/projectsprojectidclose.rst
index 917b628e..27fe562b 100644
--- a/docs/api/v2/controller/project/projectsprojectidclose.rst
+++ b/docs/api/v2/controller/project/projectsprojectidclose.rst
@@ -22,6 +22,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/controller/project/projectsprojectidduplicate.rst b/docs/api/v2/controller/project/projectsprojectidduplicate.rst
index 9834924d..a4e67f89 100644
--- a/docs/api/v2/controller/project/projectsprojectidduplicate.rst
+++ b/docs/api/v2/controller/project/projectsprojectidduplicate.rst
@@ -23,6 +23,7 @@ Input
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
| project_id | | ['string', 'null'] | Project UUID |
@@ -34,6 +35,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/controller/project/projectsprojectidimport.rst b/docs/api/v2/controller/project/projectsprojectidimport.rst
index edc55af0..8e5d1713 100644
--- a/docs/api/v2/controller/project/projectsprojectidimport.rst
+++ b/docs/api/v2/controller/project/projectsprojectidimport.rst
@@ -22,6 +22,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/controller/project/projectsprojectidopen.rst b/docs/api/v2/controller/project/projectsprojectidopen.rst
index 17704157..718f24a1 100644
--- a/docs/api/v2/controller/project/projectsprojectidopen.rst
+++ b/docs/api/v2/controller/project/projectsprojectidopen.rst
@@ -22,6 +22,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst b/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
index de14bcc1..45c08227 100644
--- a/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
+++ b/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
@@ -23,6 +23,9 @@ Output
| Name | Mandatory | Type | Description |
+ | auto_close | | boolean | Project auto close when client cut off the notifications feed |
+ | auto_open | | boolean | Project open when GNS3 start |
+ | auto_start | | boolean | Project start when opened |
| filename | | ['string', 'null'] | Project filename |
| name | | ['string', 'null'] | Project name |
| path | | ['string', 'null'] | Project directory |
diff --git a/docs/gns3_file.json b/docs/gns3_file.json
index e3e511ae..a2336945 100644
--- a/docs/gns3_file.json
+++ b/docs/gns3_file.json
@@ -1,7 +1,8 @@
{
+ "description": "The topology",
+ "type": "object",
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
- "type": "object",
"required": [
"project_id",
"type",
@@ -11,7 +12,24 @@
"topology"
],
"properties": {
+ "revision": {
+ "description": "Version of the .gns3 specification.",
+ "type": "integer"
+ },
+ "project_id": {
+ "description": "Project UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "auto_close": {
+ "description": "Close the topology when no client is connected",
+ "type": "boolean"
+ },
"topology": {
+ "description": "The topology content",
+ "type": "object",
"required": [
"nodes",
"links",
@@ -20,10 +38,13 @@
],
"properties": {
"computes": {
+ "description": "Computes servers",
+ "type": "array",
"items": {
+ "description": "Request validation to a GNS3 compute object instance",
"additionalProperties": false,
- "$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
+ "$schema": "http://json-schema.org/draft-04/schema#",
"required": [
"compute_id",
"protocol",
@@ -32,37 +53,18 @@
"name"
],
"properties": {
- "protocol": {
- "enum": [
- "http",
- "https"
- ],
- "description": "Server protocol"
- },
- "port": {
- "description": "Server port",
- "type": "integer"
- },
- "compute_id": {
- "description": "Server identifier",
+ "host": {
+ "description": "Server host",
"type": "string"
},
"memory_usage_percent": {
- "minimum": 0,
- "maximum": 100,
"description": "RAM usage of the compute. Read only",
"type": [
"number",
"null"
- ]
- },
- "connected": {
- "description": "Whether the controller is connected to the compute server or not",
- "type": "boolean"
- },
- "name": {
- "description": "Server name",
- "type": "string"
+ ],
+ "minimum": 0,
+ "maximum": 100
},
"version": {
"description": "Version of the GNS3 remote compute server",
@@ -71,6 +73,14 @@
"null"
]
},
+ "name": {
+ "description": "Server name",
+ "type": "string"
+ },
+ "port": {
+ "description": "Server port",
+ "type": "integer"
+ },
"user": {
"description": "User for authentication",
"type": [
@@ -78,189 +88,143 @@
"null"
]
},
+ "compute_id": {
+ "description": "Server identifier",
+ "type": "string"
+ },
+ "connected": {
+ "description": "Whether the controller is connected to the compute server or not",
+ "type": "boolean"
+ },
"cpu_usage_percent": {
- "minimum": 0,
- "maximum": 100,
"description": "CPU usage of the compute. Read only",
"type": [
"number",
"null"
- ]
- },
- "host": {
- "description": "Server host",
- "type": "string"
- }
- },
- "description": "Request validation to a GNS3 compute object instance"
- },
- "description": "Computes servers",
- "type": "array"
- },
- "links": {
- "items": {
- "additionalProperties": false,
- "$schema": "http://json-schema.org/draft-04/schema#",
- "type": "object",
- "required": [
- "nodes"
- ],
- "properties": {
- "capture_file_name": {
- "description": "Read only property. The name of the capture file if capture is running",
- "type": [
- "string",
- "null"
- ]
- },
- "capturing": {
- "description": "Read only property. True if a capture running on the link",
- "type": "boolean"
- },
- "nodes": {
- "items": {
- "required": [
- "node_id",
- "adapter_number",
- "port_number"
- ],
- "properties": {
- "adapter_number": {
- "description": "Adapter number",
- "type": "integer"
- },
- "node_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Node UUID",
- "type": "string"
- },
- "label": {
- "required": [
- "text",
- "x",
- "y"
- ],
- "properties": {
- "text": {
- "type": "string"
- },
- "x": {
- "description": "Relative X position of the label",
- "type": "integer"
- },
- "y": {
- "description": "Relative Y position of the label",
- "type": "integer"
- },
- "rotation": {
- "description": "Rotation of the label",
- "type": "integer"
- },
- "style": {
- "description": "SVG style attribute",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "type": "object"
- },
- "port_number": {
- "description": "Port number",
- "type": "integer"
- }
- },
- "additionalProperties": false,
- "type": "object"
- },
- "description": "List of the VMS",
- "type": "array"
- },
- "capture_file_path": {
- "description": "Read only property. The full path of the capture file if capture is running",
- "type": [
- "string",
- "null"
- ]
- },
- "link_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Link UUID",
- "type": "string"
- },
- "project_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Project UUID",
- "type": "string"
- }
- },
- "description": "A link object"
- },
- "description": "Link elements",
- "type": "array"
- },
- "drawings": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "svg": {
- "description": "SVG content of the drawing",
- "type": "string"
- },
- "project_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Project UUID",
- "type": "string"
- },
- "rotation": {
+ ],
"minimum": 0,
- "maximum": 360,
- "description": "Rotation of the element",
+ "maximum": 100
+ },
+ "protocol": {
+ "description": "Server protocol",
+ "enum": [
+ "http",
+ "https"
+ ]
+ }
+ }
+ }
+ },
+ "nodes": {
+ "description": "Nodes elements",
+ "type": "array",
+ "items": {
+ "description": "A node object",
+ "additionalProperties": false,
+ "type": "object",
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "properties": {
+ "project_id": {
+ "description": "Project UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "node_id": {
+ "description": "Node UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "node_directory": {
+ "description": "Working directory of the node. Read only",
+ "type": [
+ "null",
+ "string"
+ ]
+ },
+ "name": {
+ "description": "Node name",
+ "type": "string",
+ "minLength": 1
+ },
+ "console": {
+ "description": "Console TCP port",
+ "minimum": 1,
+ "type": [
+ "integer",
+ "null"
+ ],
+ "maximum": 65535
+ },
+ "status": {
+ "description": "Status of the node",
+ "enum": [
+ "stopped",
+ "started",
+ "suspended"
+ ]
+ },
+ "y": {
+ "description": "Y position of the node",
+ "type": "integer"
+ },
+ "compute_id": {
+ "description": "Compute identifier",
+ "type": "string"
+ },
+ "label": {
+ "type": "object",
+ "required": [
+ "text",
+ "x",
+ "y"
+ ],
+ "properties": {
+ "x": {
+ "description": "Relative X position of the label. If null center it",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "y": {
+ "description": "Relative Y position of the label",
+ "type": "integer"
+ },
+ "style": {
+ "description": "SVG style attribute",
+ "type": "string"
+ },
+ "text": {
+ "type": "string"
+ },
+ "rotation": {
+ "description": "Rotation of the label",
+ "type": "integer"
+ }
+ },
+ "additionalProperties": false
+ },
+ "height": {
+ "description": "Height of the node (Read only)",
+ "type": "integer"
+ },
+ "width": {
+ "description": "Width of the node (Read only)",
"type": "integer"
},
"x": {
- "description": "X property",
+ "description": "X position of the node",
"type": "integer"
},
- "y": {
- "description": "Y property",
- "type": "integer"
- },
- "z": {
- "description": "Z property",
- "type": "integer"
- },
- "drawing_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Drawing UUID",
- "type": "string"
- }
- },
- "description": "An drawing object",
- "$schema": "http://json-schema.org/draft-04/schema#",
- "type": "object"
- },
- "description": "Drawings elements",
- "type": "array"
- },
- "nodes": {
- "items": {
- "additionalProperties": false,
- "$schema": "http://json-schema.org/draft-04/schema#",
- "type": "object",
- "properties": {
"node_type": {
+ "description": "Type of node",
"enum": [
"cloud",
+ "nat",
"ethernet_hub",
"ethernet_switch",
"frame_relay_switch",
@@ -272,95 +236,8 @@
"vmware",
"iou",
"qemu"
- ],
- "description": "Type of node"
- },
- "symbol": {
- "minLength": 1,
- "description": "Symbol of the node",
- "type": "string"
- },
- "x": {
- "description": "X position of the node",
- "type": "integer"
- },
- "console": {
- "minimum": 1,
- "maximum": 65535,
- "description": "Console TCP port",
- "type": [
- "integer",
- "null"
]
},
- "console_type": {
- "enum": [
- "serial",
- "vnc",
- "telnet",
- null
- ],
- "description": "Console type"
- },
- "name": {
- "minLength": 1,
- "description": "Node name",
- "type": "string"
- },
- "status": {
- "enum": [
- "stopped",
- "started",
- "suspended"
- ],
- "description": "Status of the node"
- },
- "project_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Project UUID",
- "type": "string"
- },
- "node_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Node UUID",
- "type": "string"
- },
- "console_host": {
- "minLength": 1,
- "description": "Console host",
- "type": "string"
- },
- "height": {
- "description": "Height of the node",
- "type": "integer"
- },
- "compute_id": {
- "description": "Compute identifier",
- "type": "string"
- },
- "width": {
- "description": "Width of the node",
- "type": "integer"
- },
- "node_directory": {
- "description": "Working directory of the node. Read only",
- "type": [
- "null",
- "string"
- ]
- },
- "z": {
- "description": "Z position of the node",
- "type": "integer"
- },
- "y": {
- "description": "Y position of the node",
- "type": "integer"
- },
"command_line": {
"description": "Command line use to start the node",
"type": [
@@ -368,80 +245,218 @@
"string"
]
},
+ "console_type": {
+ "description": "Console type",
+ "enum": [
+ "serial",
+ "vnc",
+ "telnet",
+ null
+ ]
+ },
+ "symbol": {
+ "description": "Symbol of the node",
+ "type": "string",
+ "minLength": 1
+ },
"properties": {
"description": "Properties specific to an emulator",
"type": "object"
},
- "label": {
- "required": [
- "text",
- "x",
- "y"
- ],
- "properties": {
- "text": {
- "type": "string"
- },
- "x": {
- "description": "Relative X position of the label",
- "type": "integer"
- },
- "y": {
- "description": "Relative Y position of the label",
- "type": "integer"
- },
- "rotation": {
- "description": "Rotation of the label",
- "type": "integer"
- },
- "style": {
- "description": "SVG style attribute",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "type": "object"
+ "z": {
+ "description": "Z position of the node",
+ "type": "integer"
+ },
+ "console_host": {
+ "description": "Console host",
+ "type": "string",
+ "minLength": 1
+ }
+ }
+ }
+ },
+ "drawings": {
+ "description": "Drawings elements",
+ "type": "array",
+ "items": {
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "An drawing object",
+ "additionalProperties": false,
+ "properties": {
+ "project_id": {
+ "description": "Project UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "x": {
+ "description": "X property",
+ "type": "integer"
+ },
+ "rotation": {
+ "description": "Rotation of the element",
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 360
+ },
+ "drawing_id": {
+ "description": "Drawing UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "y": {
+ "description": "Y property",
+ "type": "integer"
+ },
+ "svg": {
+ "description": "SVG content of the drawing",
+ "type": "string"
+ },
+ "z": {
+ "description": "Z property",
+ "type": "integer"
}
},
- "description": "A node object"
- },
- "description": "Nodes elements",
- "type": "array"
+ "type": "object"
+ }
+ },
+ "links": {
+ "description": "Link elements",
+ "type": "array",
+ "items": {
+ "description": "A link object",
+ "type": "object",
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "required": [
+ "nodes"
+ ],
+ "properties": {
+ "project_id": {
+ "description": "Project UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "link_id": {
+ "description": "Link UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "capture_file_path": {
+ "description": "Read only property. The full path of the capture file if capture is running",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "capturing": {
+ "description": "Read only property. True if a capture running on the link",
+ "type": "boolean"
+ },
+ "capture_file_name": {
+ "description": "Read only property. The name of the capture file if capture is running",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "nodes": {
+ "description": "List of the VMS",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "node_id",
+ "adapter_number",
+ "port_number"
+ ],
+ "properties": {
+ "node_id": {
+ "description": "Node UUID",
+ "type": "string",
+ "maxLength": 36,
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "minLength": 36
+ },
+ "label": {
+ "type": "object",
+ "required": [
+ "text",
+ "x",
+ "y"
+ ],
+ "properties": {
+ "x": {
+ "description": "Relative X position of the label. If null center it",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "y": {
+ "description": "Relative Y position of the label",
+ "type": "integer"
+ },
+ "style": {
+ "description": "SVG style attribute",
+ "type": "string"
+ },
+ "text": {
+ "type": "string"
+ },
+ "rotation": {
+ "description": "Rotation of the label",
+ "type": "integer"
+ }
+ },
+ "additionalProperties": false
+ },
+ "adapter_number": {
+ "description": "Adapter number",
+ "type": "integer"
+ },
+ "port_number": {
+ "description": "Port number",
+ "type": "integer"
+ }
+ },
+ "additionalProperties": false
+ }
+ }
+ }
+ }
}
},
- "additionalProperties": false,
- "description": "The topology content",
- "type": "object"
- },
- "version": {
- "description": "Version of the GNS3 software which have update the file for the last time",
- "type": "string"
+ "additionalProperties": false
},
"auto_start": {
"description": "Start the topology when opened",
"type": "boolean"
},
- "type": {
- "enum": [
- "topology"
- ],
- "description": "Type of file. It's always topology"
- },
- "revision": {
- "description": "Version of the .gns3 specification.",
- "type": "integer"
- },
"name": {
"description": "Name of the project",
"type": "string"
},
- "project_id": {
- "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
- "maxLength": 36,
- "minLength": 36,
- "description": "Project UUID",
+ "auto_open": {
+ "description": "Open the topology with GNS3",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Type of file. It's always topology",
+ "enum": [
+ "topology"
+ ]
+ },
+ "version": {
+ "description": "Version of the GNS3 software which have update the file for the last time",
"type": "string"
}
- },
- "description": "The topology"
+ }
}
\ No newline at end of file