| Name | Mandatory | Type | Description |
| auto_delete_disks | | boolean | Automatically delete nvram and disk files |
- | aux | | integer | Auxiliary console TCP port |
+ | aux | | ['null', 'integer'] | Auxiliary console TCP port |
| chassis | | string | Cisco router chassis model |
| clock_divisor | | integer | Clock divisor |
| console | | integer | Console TCP port |
diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index e184e6af..72fafc5a 100644
--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
+- **adapter_number**: Adapter where the nio should be added
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -27,9 +27,9 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
+- **adapter_number**: Adapter from where the nio should be removed
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index bc488f1e..0a133f6c 100644
--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 30a88d5d..efe3932c 100644
--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 5bfada08..ad983168 100644
--- a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
+- **adapter_number**: Adapter on the hub (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -27,9 +27,9 @@ Remove a NIO from an Ethernet hub instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
+- **adapter_number**: Adapter on the hub (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index e60ea8f7..3c5d2719 100644
--- a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
+- **adapter_number**: Adapter on the hub (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 66024308..ab8ebf39 100644
--- a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
+- **adapter_number**: Adapter on the hub (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 53ae531e..943652cf 100644
--- a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -27,9 +27,9 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index 74e00e52..4c6be111 100644
--- a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index d8cd38c4..f86434d1 100644
--- a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 5bbaafb6..fd380d47 100644
--- a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -27,9 +27,9 @@ Remove a NIO from a Frame Relay switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index adee0094..68402f85 100644
--- a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 4e41e959..e23c3ff8 100644
--- a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
+- **adapter_number**: Adapter on the switch (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 2db1c0b3..7b327183 100644
--- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a IOU instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -33,9 +33,9 @@ Remove a NIO from a IOU instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index 237d27da..63e76740 100644
--- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on an IOU VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index e846741f..f55aa254 100644
--- a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on an IOU VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 0849e982..d40ed78f 100644
--- a/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a nat instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
+- **adapter_number**: Adapter on the nat (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -33,9 +33,9 @@ Remove a NIO from a nat instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
+- **adapter_number**: Adapter on the nat (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index f623a930..32e14858 100644
--- a/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on a nat instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
+- **adapter_number**: Adapter on the nat (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 598f7d18..736ca1f3 100644
--- a/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on a nat instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
+- **adapter_number**: Adapter on the nat (always 0)
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 33788090..67a81f72 100644
--- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a Qemu VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -33,9 +33,9 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index ff1844f4..9da8374a 100644
--- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index e3a27472..8c2fa998 100644
--- a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index ef8d9279..8bbbfea8 100644
--- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter where the nio should be added
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -33,9 +33,9 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter from where the nio should be removed
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index 408fbb00..3d62c787 100644
--- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index 7d5716e7..94f70431 100644
--- a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 4d117f5a..317cef9d 100644
--- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a VMware VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter where the nio should be added
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -27,9 +27,9 @@ Remove a NIO from a VMware VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter from where the nio should be removed
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index 1dfa0bee..c662e206 100644
--- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on a VMware VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index e7004621..f64b108c 100644
--- a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
index 0bac9b07..d4c6c174 100644
--- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@@ -9,9 +9,9 @@ Add a NIO to a VPCS instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
@@ -33,9 +33,9 @@ Remove a NIO from a VPCS instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
index f7633e0a..bf07aeba 100644
--- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@@ -9,9 +9,9 @@ Start a packet capture on a VPCS instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
index d755e954..f43562c8 100644
--- a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@@ -9,9 +9,9 @@ Stop a packet capture on a VPCS instance
Parameters
**********
-- **project_id**: Project UUID
-- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
diff --git a/docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst b/docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst
index 749b099f..956f0a76 100644
--- a/docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst
+++ b/docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst
@@ -9,8 +9,8 @@ Create a new drawing instance
Parameters
**********
-- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
+- **project_id**: Project UUID
Response status codes
**********************
@@ -60,8 +60,8 @@ Delete a drawing instance
Parameters
**********
-- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
+- **project_id**: Project UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
index defb182f..5acf4a66 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
**********
-- **project_id**: Project UUID
- **link_id**: Link UUID
+- **project_id**: Project UUID
Response status codes
**********************
@@ -54,8 +54,8 @@ Delete a link instance
Parameters
**********
-- **project_id**: Project UUID
- **link_id**: Link UUID
+- **project_id**: Project UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
index 48426bdd..99a050aa 100644
--- a/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
+++ b/docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
@@ -9,8 +9,8 @@ Stream the pcap capture file
Parameters
**********
-- **project_id**: Project UUID
- **link_id**: Link UUID
+- **project_id**: Project UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst
index 0cb8c1e7..4ba786c0 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
**********
-- **project_id**: Project UUID
- **link_id**: Link UUID
+- **project_id**: Project UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst b/docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst
index da2bcb29..53c97524 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
**********
-- **project_id**: Project UUID
- **link_id**: Link UUID
+- **project_id**: Project UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/node/projectsprojectidnodes.rst b/docs/api/v2/controller/node/projectsprojectidnodes.rst
index 52c78cd6..ff7534a6 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodes.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodes.rst
@@ -25,8 +25,8 @@ Input
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -40,7 +40,7 @@ Input
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
@@ -56,8 +56,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -71,7 +71,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
index ce72ee19..a8b9cbdf 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
@@ -22,8 +22,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -37,7 +37,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
@@ -70,8 +70,8 @@ Input
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -85,7 +85,7 @@ Input
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
@@ -101,8 +101,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -116,7 +116,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
index 60f6d56f..8a21f3eb 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
@@ -27,8 +27,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -42,7 +42,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
index df0b0a49..95c34f2a 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
@@ -27,8 +27,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -42,7 +42,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
index e28389c5..5b9d1c0d 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
@@ -27,8 +27,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -42,7 +42,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst b/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
index 2440d4ad..4f1912bc 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
@@ -27,8 +27,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -42,7 +42,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesreload.rst b/docs/api/v2/controller/node/projectsprojectidnodesreload.rst
index cc766c54..1db8b683 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesreload.rst
@@ -26,8 +26,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -41,7 +41,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesstart.rst b/docs/api/v2/controller/node/projectsprojectidnodesstart.rst
index 05a6d684..763c484e 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesstart.rst
@@ -26,8 +26,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -41,7 +41,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodesstop.rst b/docs/api/v2/controller/node/projectsprojectidnodesstop.rst
index 52a283b2..fbd92aed 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodesstop.rst
@@ -26,8 +26,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -41,7 +41,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst b/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
index 486b2a29..12fd9f2a 100644
--- a/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+++ b/docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
@@ -26,8 +26,8 @@ Output
| command_line | | ['null', 'string'] | Command line use to start the node |
| compute_id | | string | Compute identifier |
| console | | ['integer', 'null'] | Console TCP port |
- | console_host | | string | Console host |
- | console_type | | enum | Possible values: serial, vnc, telnet, null |
+ | console_host | | string | Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller. |
+ | console_type | | enum | Possible values: serial, vnc, telnet, http, null |
| first_port_name | | ['string', 'null'] | Name of the first port |
| height | | integer | Height of the node (Read only) |
| label | | object | |
@@ -41,7 +41,7 @@ Output
| 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 |
+ | symbol | | ['string', 'null'] | Symbol 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 |
diff --git a/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotid.rst b/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotid.rst
index f949f4a8..2d5319da 100644
--- a/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotid.rst
+++ b/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotid.rst
@@ -9,8 +9,8 @@ Delete a snapshot from disk
Parameters
**********
-- **project_id**: Project UUID
- **snapshot_id**: Snasphot UUID
+- **project_id**: Project UUID
Response status codes
**********************
diff --git a/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst b/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
index 7c55a564..78d996b5 100644
--- a/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
+++ b/docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
@@ -9,8 +9,8 @@ Restore a snapshot from disk
Parameters
**********
-- **project_id**: Project UUID
- **snapshot_id**: Snasphot UUID
+- **project_id**: Project UUID
Response status codes
**********************
diff --git a/docs/gns3_file.json b/docs/gns3_file.json
index b9c88280..c6c04374 100644
--- a/docs/gns3_file.json
+++ b/docs/gns3_file.json
@@ -1,234 +1,127 @@
{
+ "additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "The topology",
+ "type": "object",
"properties": {
- "project_id": {
- "minLength": 36,
- "type": "string",
- "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,
- "description": "Project UUID"
- },
- "revision": {
- "type": "integer",
- "description": "Version of the .gns3 specification."
- },
"auto_close": {
- "type": "boolean",
- "description": "Close the topology when no client is connected"
- },
- "version": {
- "type": "string",
- "description": "Version of the GNS3 software which have update the file for the last time"
+ "description": "Close the topology when no client is connected",
+ "type": "boolean"
},
"scene_width": {
- "type": "integer",
- "description": "Width of the drawing area"
+ "description": "Width of the drawing area",
+ "type": "integer"
},
- "name": {
- "type": "string",
- "description": "Name of the project"
+ "revision": {
+ "description": "Version of the .gns3 specification.",
+ "type": "integer"
+ },
+ "version": {
+ "description": "Version of the GNS3 software which have update the file for the last time",
+ "type": "string"
},
"scene_height": {
- "type": "integer",
- "description": "Height of the drawing area"
+ "description": "Height of the drawing area",
+ "type": "integer"
},
"auto_open": {
- "type": "boolean",
- "description": "Open the topology with GNS3"
+ "description": "Open the topology with GNS3",
+ "type": "boolean"
},
"type": {
+ "description": "Type of file. It's always topology",
"enum": [
"topology"
- ],
- "description": "Type of file. It's always topology"
+ ]
},
"topology": {
- "required": [
- "nodes",
- "links",
- "drawings",
- "computes"
- ],
- "additionalProperties": false,
+ "description": "The topology content",
"type": "object",
+ "additionalProperties": false,
"properties": {
- "drawings": {
- "items": {
- "additionalProperties": false,
- "$schema": "http://json-schema.org/draft-04/schema#",
- "type": "object",
- "properties": {
- "project_id": {
- "minLength": 36,
- "type": "string",
- "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,
- "description": "Project UUID"
- },
- "rotation": {
- "minimum": -359,
- "type": "integer",
- "maximum": 360,
- "description": "Rotation of the element"
- },
- "svg": {
- "type": "string",
- "description": "SVG content of the drawing"
- },
- "x": {
- "type": "integer",
- "description": "X property"
- },
- "z": {
- "type": "integer",
- "description": "Z property"
- },
- "y": {
- "type": "integer",
- "description": "Y property"
- },
- "drawing_id": {
- "minLength": 36,
- "type": "string",
- "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,
- "description": "Drawing UUID"
- }
- },
- "description": "An drawing object"
- },
- "type": "array",
- "description": "Drawings elements"
- },
- "links": {
- "items": {
- "$schema": "http://json-schema.org/draft-04/schema#",
- "properties": {
- "project_id": {
- "minLength": 36,
- "type": "string",
- "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,
- "description": "Project UUID"
- },
- "capture_file_name": {
- "type": [
- "string",
- "null"
- ],
- "description": "Read only property. The name of the capture file if capture is running"
- },
- "capture_file_path": {
- "type": [
- "string",
- "null"
- ],
- "description": "Read only property. The full path of the capture file if capture is running"
- },
- "nodes": {
- "items": {
- "required": [
- "node_id",
- "adapter_number",
- "port_number"
- ],
- "additionalProperties": false,
- "type": "object",
- "properties": {
- "adapter_number": {
- "type": "integer",
- "description": "Adapter number"
- },
- "label": {
- "required": [
- "text",
- "x",
- "y"
- ],
- "additionalProperties": false,
- "type": "object",
- "properties": {
- "y": {
- "type": "integer",
- "description": "Relative Y position of the label"
- },
- "x": {
- "type": [
- "integer",
- "null"
- ],
- "description": "Relative X position of the label. If null center it"
- },
- "text": {
- "type": "string"
- },
- "rotation": {
- "minimum": -359,
- "type": "integer",
- "maximum": 360,
- "description": "Rotation of the label"
- },
- "style": {
- "type": "string",
- "description": "SVG style attribute"
- }
- }
- },
- "port_number": {
- "type": "integer",
- "description": "Port number"
- },
- "node_id": {
- "minLength": 36,
- "type": "string",
- "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,
- "description": "Node UUID"
- }
- }
- },
- "type": "array",
- "description": "List of the VMS"
- },
- "capturing": {
- "type": "boolean",
- "description": "Read only property. True if a capture running on the link"
- },
- "link_id": {
- "minLength": 36,
- "type": "string",
- "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,
- "description": "Link UUID"
- },
- "link_type": {
- "enum": [
- "ethernet",
- "serial"
- ],
- "description": "Type of link"
- }
- },
- "required": [
- "nodes"
- ],
- "additionalProperties": false,
- "type": "object",
- "description": "A link object"
- },
- "type": "array",
- "description": "Link elements"
- },
"computes": {
+ "description": "Computes servers",
+ "type": "array",
"items": {
+ "additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "Request validation to a GNS3 compute object instance",
+ "type": "object",
"properties": {
+ "memory_usage_percent": {
+ "description": "RAM usage of the compute. Read only",
+ "type": [
+ "number",
+ "null"
+ ],
+ "maximum": 100,
+ "minimum": 0
+ },
+ "user": {
+ "description": "User for authentication",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "port": {
+ "description": "Server port",
+ "type": "integer"
+ },
+ "protocol": {
+ "description": "Server protocol",
+ "enum": [
+ "http",
+ "https"
+ ]
+ },
+ "cpu_usage_percent": {
+ "description": "CPU usage of the compute. Read only",
+ "type": [
+ "number",
+ "null"
+ ],
+ "maximum": 100,
+ "minimum": 0
+ },
+ "connected": {
+ "description": "Whether the controller is connected to the compute server or not",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Server host",
+ "type": "string"
+ },
+ "name": {
+ "description": "Server name",
+ "type": "string"
+ },
+ "compute_id": {
+ "description": "Server identifier",
+ "type": "string"
+ },
"capabilities": {
+ "additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "Get what a server support",
+ "type": "object",
"properties": {
+ "platform": {
+ "description": "Platform where the compute is running",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version number",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
"node_types": {
+ "description": "Node type supported by the compute",
"type": "array",
"items": {
+ "description": "Type of node",
"enum": [
"cloud",
"nat",
@@ -243,77 +136,14 @@
"vmware",
"iou",
"qemu"
- ],
- "description": "Type of node"
+ ]
}
- },
- "version": {
- "type": [
- "string",
- "null"
- ],
- "description": "Version number"
}
},
"required": [
"version",
"node_types"
- ],
- "additionalProperties": false,
- "type": "object",
- "description": "Get what a server support"
- },
- "cpu_usage_percent": {
- "maximum": 100,
- "type": [
- "number",
- "null"
- ],
- "minimum": 0,
- "description": "CPU usage of the compute. Read only"
- },
- "host": {
- "type": "string",
- "description": "Server host"
- },
- "port": {
- "type": "integer",
- "description": "Server port"
- },
- "protocol": {
- "enum": [
- "http",
- "https"
- ],
- "description": "Server protocol"
- },
- "name": {
- "type": "string",
- "description": "Server name"
- },
- "user": {
- "type": [
- "string",
- "null"
- ],
- "description": "User for authentication"
- },
- "memory_usage_percent": {
- "maximum": 100,
- "type": [
- "number",
- "null"
- ],
- "minimum": 0,
- "description": "RAM usage of the compute. Read only"
- },
- "compute_id": {
- "type": "string",
- "description": "Server identifier"
- },
- "connected": {
- "type": "boolean",
- "description": "Whether the controller is connected to the compute server or not"
+ ]
}
},
"required": [
@@ -322,85 +152,286 @@
"host",
"port",
"name"
- ],
- "additionalProperties": false,
- "type": "object",
- "description": "Request validation to a GNS3 compute object instance"
- },
- "type": "array",
- "description": "Computes servers"
+ ]
+ }
},
- "nodes": {
+ "drawings": {
+ "description": "Drawings elements",
+ "type": "array",
"items": {
+ "description": "An drawing object",
+ "type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
+ "additionalProperties": false,
"properties": {
- "ports": {
- "items": {
- "additionalProperties": false,
- "type": "object",
- "properties": {
- "adapter_number": {
- "type": "integer",
- "description": "Adapter slot"
- },
- "port_number": {
- "type": "integer",
- "description": "Port slot"
- },
- "short_name": {
- "type": "string",
- "description": "Short version of port name"
- },
- "data_link_types": {
- "type": "object",
- "properties": {},
- "description": "Available PCAP type for capture"
- },
- "link_type": {
- "enum": [
- "ethernet",
- "serial"
- ],
- "description": "Type of link"
- },
- "name": {
- "type": "string",
- "description": "Port name"
- }
- },
- "description": "A node port"
- },
- "type": "array",
- "description": "List of node ports READ only"
+ "y": {
+ "description": "Y property",
+ "type": "integer"
},
- "console": {
- "minimum": 1,
- "maximum": 65535,
- "type": [
- "integer",
- "null"
- ],
- "description": "Console TCP port"
+ "rotation": {
+ "description": "Rotation of the element",
+ "type": "integer",
+ "maximum": 360,
+ "minimum": -359
},
- "node_id": {
+ "drawing_id": {
"minLength": 36,
+ "description": "Drawing UUID",
"type": "string",
"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,
- "description": "Node UUID"
+ "maxLength": 36
},
- "first_port_name": {
+ "z": {
+ "description": "Z property",
+ "type": "integer"
+ },
+ "x": {
+ "description": "X property",
+ "type": "integer"
+ },
+ "project_id": {
+ "minLength": 36,
+ "description": "Project UUID",
+ "type": "string",
+ "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
+ },
+ "svg": {
+ "description": "SVG content of the drawing",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "links": {
+ "description": "Link elements",
+ "type": "array",
+ "items": {
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "A link object",
+ "type": "object",
+ "properties": {
+ "project_id": {
+ "minLength": 36,
+ "description": "Project UUID",
+ "type": "string",
+ "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
+ },
+ "nodes": {
+ "description": "List of the VMS",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "port_number": {
+ "description": "Port number",
+ "type": "integer"
+ },
+ "adapter_number": {
+ "description": "Adapter number",
+ "type": "integer"
+ },
+ "label": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "y": {
+ "description": "Relative Y position of the label",
+ "type": "integer"
+ },
+ "style": {
+ "description": "SVG style attribute",
+ "type": "string"
+ },
+ "x": {
+ "description": "Relative X position of the label. If null center it",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "rotation": {
+ "description": "Rotation of the label",
+ "type": "integer",
+ "maximum": 360,
+ "minimum": -359
+ }
+ },
+ "required": [
+ "text",
+ "x",
+ "y"
+ ]
+ },
+ "node_id": {
+ "minLength": 36,
+ "description": "Node UUID",
+ "type": "string",
+ "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
+ }
+ },
+ "required": [
+ "node_id",
+ "adapter_number",
+ "port_number"
+ ]
+ }
+ },
+ "capture_file_path": {
+ "description": "Read only property. The full path of the capture file if capture is running",
"type": [
"string",
"null"
- ],
- "description": "Name of the first port"
+ ]
},
- "compute_id": {
+ "link_id": {
+ "minLength": 36,
+ "description": "Link UUID",
"type": "string",
- "description": "Compute identifier"
+ "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
+ },
+ "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"
+ },
+ "link_type": {
+ "description": "Type of link",
+ "enum": [
+ "ethernet",
+ "serial"
+ ]
+ }
+ },
+ "required": [
+ "nodes"
+ ]
+ }
+ },
+ "nodes": {
+ "description": "Nodes elements",
+ "type": "array",
+ "items": {
+ "additionalProperties": false,
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "A node object",
+ "type": "object",
+ "properties": {
+ "node_directory": {
+ "description": "Working directory of the node. Read only",
+ "type": [
+ "null",
+ "string"
+ ]
+ },
+ "label": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "y": {
+ "description": "Relative Y position of the label",
+ "type": "integer"
+ },
+ "style": {
+ "description": "SVG style attribute",
+ "type": "string"
+ },
+ "x": {
+ "description": "Relative X position of the label. If null center it",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "rotation": {
+ "description": "Rotation of the label",
+ "type": "integer",
+ "maximum": 360,
+ "minimum": -359
+ }
+ },
+ "required": [
+ "text",
+ "x",
+ "y"
+ ]
+ },
+ "width": {
+ "description": "Width of the node (Read only)",
+ "type": "integer"
+ },
+ "project_id": {
+ "minLength": 36,
+ "description": "Project UUID",
+ "type": "string",
+ "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
+ },
+ "first_port_name": {
+ "description": "Name of the first port",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "ports": {
+ "description": "List of node ports READ only",
+ "type": "array",
+ "items": {
+ "description": "A node port",
+ "type": "object",
+ "properties": {
+ "port_number": {
+ "description": "Port slot",
+ "type": "integer"
+ },
+ "short_name": {
+ "description": "Short version of port name",
+ "type": "string"
+ },
+ "adapter_number": {
+ "description": "Adapter slot",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Port name",
+ "type": "string"
+ },
+ "link_type": {
+ "description": "Type of link",
+ "enum": [
+ "ethernet",
+ "serial"
+ ]
+ },
+ "data_link_types": {
+ "description": "Available PCAP type for capture",
+ "type": "object",
+ "properties": {}
+ }
+ },
+ "additionalProperties": false
+ }
},
"node_type": {
+ "description": "Type of node",
"enum": [
"cloud",
"nat",
@@ -415,144 +446,125 @@
"vmware",
"iou",
"qemu"
- ],
- "description": "Type of node"
- },
- "status": {
- "enum": [
- "stopped",
- "started",
- "suspended"
- ],
- "description": "Status of the node"
+ ]
},
"port_segment_size": {
- "minimum": 0,
+ "description": "Size of the port segment",
"type": "integer",
- "description": "Size of the port segment"
+ "minimum": 0
+ },
+ "z": {
+ "description": "Z position of the node",
+ "type": "integer"
+ },
+ "x": {
+ "description": "X position of the node",
+ "type": "integer"
},
"console_type": {
+ "description": "Console type",
"enum": [
"serial",
"vnc",
"telnet",
+ "http",
null
- ],
- "description": "Console type"
- },
- "symbol": {
- "minLength": 1,
- "type": "string",
- "description": "Symbol of the node"
- },
- "project_id": {
- "minLength": 36,
- "type": "string",
- "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,
- "description": "Project UUID"
- },
- "label": {
- "required": [
- "text",
- "x",
- "y"
- ],
- "additionalProperties": false,
- "type": "object",
- "properties": {
- "y": {
- "type": "integer",
- "description": "Relative Y position of the label"
- },
- "x": {
- "type": [
- "integer",
- "null"
- ],
- "description": "Relative X position of the label. If null center it"
- },
- "text": {
- "type": "string"
- },
- "rotation": {
- "minimum": -359,
- "type": "integer",
- "maximum": 360,
- "description": "Rotation of the label"
- },
- "style": {
- "type": "string",
- "description": "SVG style attribute"
- }
- }
- },
- "node_directory": {
- "type": [
- "null",
- "string"
- ],
- "description": "Working directory of the node. Read only"
- },
- "x": {
- "type": "integer",
- "description": "X position of the node"
- },
- "console_host": {
- "minLength": 1,
- "type": "string",
- "description": "Console host"
- },
- "y": {
- "type": "integer",
- "description": "Y position of the node"
- },
- "width": {
- "type": "integer",
- "description": "Width of the node (Read only)"
- },
- "port_name_format": {
- "type": "string",
- "description": "Formating for port name {0} will be replace by port number"
- },
- "command_line": {
- "type": [
- "null",
- "string"
- ],
- "description": "Command line use to start the node"
- },
- "properties": {
- "type": "object",
- "description": "Properties specific to an emulator"
- },
- "z": {
- "type": "integer",
- "description": "Z position of the node"
+ ]
},
"name": {
"minLength": 1,
+ "description": "Node name",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the node",
+ "enum": [
+ "stopped",
+ "started",
+ "suspended"
+ ]
+ },
+ "command_line": {
+ "description": "Command line use to start the node",
+ "type": [
+ "null",
+ "string"
+ ]
+ },
+ "compute_id": {
+ "description": "Compute identifier",
+ "type": "string"
+ },
+ "node_id": {
+ "minLength": 36,
+ "description": "Node UUID",
"type": "string",
- "description": "Node name"
+ "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
},
"height": {
- "type": "integer",
- "description": "Height of the node (Read only)"
+ "description": "Height of the node (Read only)",
+ "type": "integer"
+ },
+ "port_name_format": {
+ "description": "Formating for port name {0} will be replace by port number",
+ "type": "string"
+ },
+ "y": {
+ "description": "Y position of the node",
+ "type": "integer"
+ },
+ "console_host": {
+ "minLength": 1,
+ "description": "Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.",
+ "type": "string"
+ },
+ "symbol": {
+ "minLength": 1,
+ "description": "Symbol of the node",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "console": {
+ "description": "Console TCP port",
+ "type": [
+ "integer",
+ "null"
+ ],
+ "maximum": 65535,
+ "minimum": 1
+ },
+ "properties": {
+ "description": "Properties specific to an emulator",
+ "type": "object"
}
- },
- "additionalProperties": false,
- "type": "object",
- "description": "A node object"
- },
- "type": "array",
- "description": "Nodes elements"
+ }
+ }
}
},
- "description": "The topology content"
+ "required": [
+ "nodes",
+ "links",
+ "drawings",
+ "computes"
+ ]
+ },
+ "name": {
+ "description": "Name of the project",
+ "type": "string"
+ },
+ "project_id": {
+ "minLength": 36,
+ "description": "Project UUID",
+ "type": "string",
+ "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
},
"auto_start": {
- "type": "boolean",
- "description": "Start the topology when opened"
+ "description": "Start the topology when opened",
+ "type": "boolean"
}
},
"required": [
@@ -562,8 +574,5 @@
"version",
"name",
"topology"
- ],
- "additionalProperties": false,
- "type": "object",
- "description": "The topology"
+ ]
}
\ No newline at end of file
diff --git a/tests/handlers/api/controller/test_compute.py b/tests/handlers/api/controller/test_compute.py
index 029a4dbb..8e735687 100644
--- a/tests/handlers/api/controller/test_compute.py
+++ b/tests/handlers/api/controller/test_compute.py
@@ -154,7 +154,7 @@ def test_compute_delete(http_controller, controller):
response = http_controller.get("/computes")
assert len(response.json) == 1
- response = http_controller.delete("/computes/my_compute_id")
+ response = http_controller.delete("/computes/my_compute_id", example=True)
assert response.status == 204
response = http_controller.get("/computes")
@@ -194,7 +194,7 @@ def test_compute_list_vms(http_controller, controller):
assert response.status == 201
with asyncio_patch("gns3server.controller.compute.Compute.forward", return_value=[]) as mock:
- response = http_controller.get("/computes/my_compute/virtualbox/vms")
+ response = http_controller.get("/computes/my_compute/virtualbox/vms", example=True)
assert response.json == []
mock.assert_called_with("GET", "virtualbox", "vms")
@@ -214,5 +214,5 @@ def test_compute_create_img(http_controller, controller):
params = {"path": "/test"}
with asyncio_patch("gns3server.controller.compute.Compute.forward", return_value=[]) as mock:
- response = http_controller.post("/computes/my_compute/qemu/img", params)
+ response = http_controller.post("/computes/my_compute/qemu/img", params, example=True)
mock.assert_called_with("POST", "qemu", "img", data=unittest.mock.ANY)