1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-23 23:38:21 +00:00

Update the doc for GNS3 2.0

Fix #495
This commit is contained in:
Julien Duponchelle 2016-06-08 18:12:22 +02:00
parent 70345abc2a
commit 3deb555981
No known key found for this signature in database
GPG Key ID: CE8B29639E07F5E8
92 changed files with 273 additions and 208 deletions

View File

@ -9,10 +9,10 @@ Stop a packet capture on an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -38,8 +38,8 @@ Update an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -81,8 +81,8 @@ Delete an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start an ATM switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop an ATM switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend an ATM Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -39,8 +39,8 @@ Update a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -144,8 +144,8 @@ Delete a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a cloud
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a cloud
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a cloud
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -79,8 +79,8 @@ Update a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -202,8 +202,8 @@ Delete a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **adapter_number**: Adapter from where the nio should be removed
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Retrieve the startup and private configs content
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Save the startup and private configs content
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -38,8 +38,8 @@ Update an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -97,8 +97,8 @@ Delete an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start an Ethernet hub
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop an Ethernet hub
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend an Ethernet hub
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -38,8 +38,8 @@ Update an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -100,8 +100,8 @@ Delete an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -38,8 +38,8 @@ Update a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -81,8 +81,8 @@ Delete a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a Frame Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a Frame Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a Frame Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -80,8 +80,8 @@ Update a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -196,8 +196,8 @@ Delete a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
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
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Resume a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -53,8 +53,8 @@ Update a VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -116,8 +116,8 @@ Delete a VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
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
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter from where the nio should be removed
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Resume a suspended VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a VirtualBox VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -46,8 +46,8 @@ Update a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -101,8 +101,8 @@ Delete a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
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
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter from where the nio should be removed
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Allocate a VMware VMnet interface on the server
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Resume a suspended VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a VPCS instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -49,8 +49,8 @@ Update a VPCS instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -103,8 +103,8 @@ Delete a VPCS instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port where the nio should be added
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
Response status codes
**********************
@ -33,10 +33,10 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port from where the nio should be removed
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a VPCS instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a VPCS instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a VPCS instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -1,9 +1,23 @@
/v2/computes/{compute_id}/{emulator}/{action}
/v2/computes/{compute_id}/{emulator}/{action:.+}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/computes/**{compute_id}**/**{emulator}**/**{action}**
GET /v2/computes/**{compute_id}**/**{emulator}**/**{action:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Forward call specific to compute node. Read the full compute API for available actions
Parameters
**********
- **compute_id**: Compute UUID
Response status codes
**********************
- **200**: OK
- **404**: Instance doesn't exist
POST /v2/computes/**{compute_id}**/**{emulator}**/**{action:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Forward call specific to compute node. Read the full compute API for available actions

View File

@ -9,8 +9,8 @@ Delete a link instance
Parameters
**********
- **link_id**: Link UUID
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************

View File

@ -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
**********************

View File

@ -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
**********************

View File

@ -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
**********************

View File

@ -66,8 +66,8 @@ Delete a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Compute the IDLE PC for a Dynamips node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Compute a list of potential idle PC for a node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************

View File

@ -16,9 +16,15 @@ JSON like that
"message": "Conflict"
}
409 error could be display to the user. They are normal behavior
they are used to warn user about something he should change and
they are not an internal software error.
Sample session using curl
=========================
You need to read the :doc:`glossary` before.
.. warning::
Beware the output of this sample is truncated in order
@ -29,93 +35,120 @@ You can check the server version with a simple curl command:
.. code-block:: shell-session
# curl "http://localhost:3080/v1/version"
# curl "http://localhost:3080/v2/version"
{
"version": "2.0.0dev1"
}
We will list the computes node where we can run our nodes:
.. code-block:: shell-session
# curl "http://localhost:3080/v2/computes"
[
{
"compute_id": "local",
"connected": true,
"host": "127.0.0.1",
"name": "Local",
"port": 3080,
"protocol": "http",
"user": "admin"
}
]
In this sample we have only one compute where we can run our nodes. This compute as a special id: local. This
mean it's the local server embed in the GNS3 controller.
The next step is to create a project.
.. code-block:: shell-session
# curl -X POST "http://localhost:3080/v1/projects" -d '{"name": "test"}'
# curl -X POST "http://localhost:3080/v2/projects" -d '{"name": "test"}'
{
"name": "test",
"path": null,
"project_id": "994d95b6-7dd4-467b-898c-14cf34900b7b",
"temporary": false
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f",
}
With this project id we can now create two VPCS Node.
.. code-block:: shell-session
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/vpcs/vms" -d '{"name": "VPCS 1"}'
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes" -d '{"name": "VPCS 1", "node_type": "vpcs", "compute_id": "local"}'
{
"console": 2000,
"compute_id": "local",
"console": 5000,
"console_host": "127.0.0.1",
"console_type": "telnet",
"name": "VPCS 1",
"project_id": "42f9feee-3217-4104-981e-85d5f0a806ec",
"vm_id": "24d2e16b-fbef-4259-ae34-7bc21a41ee28"
}%
"node_id": "f124dec0-830a-451e-a314-be50bbd58a00",
"node_type": "vpcs",
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f",
"properties": {
"startup_script": null,
"startup_script_path": null
},
"status": "stopped"
}
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/vpcs/vms" -d '{"name": "VPCS 2"}'
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes" -d '{"name": "VPCS 2", "node_type": "vpcs", "compute_id": "local"}'
{
"console": 2001,
"compute_id": "local",
"console": 5001,
"console_host": "127.0.0.1",
"console_type": "telnet",
"name": "VPCS 2",
"vm_id": "daefc24a-103c-4717-8e01-6517d931c1ae"
"node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74",
"node_type": "vpcs",
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f",
"properties": {
"startup_script": null,
"startup_script_path": null
},
"status": "stopped"
}
Now we need to link the two VPCS. The first step is to allocate on the remote servers
two UDP ports.
The properties dictionnary contains all setting specific to a node type (dynamips, docker, vpcs...)
Now we need to link the two VPCS by connecting their port 0 together.
.. code-block:: shell-session
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/ports/udp" -d '{}'
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/links" -d '{"nodes": [{"adapter_number": 0, "node_id": "f124dec0-830a-451e-a314-be50bbd58a00", "port_number": 0}, {"adapter_number": 0, "node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74", "port_number": 0}]}'
{
"udp_port": 10000
}
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/ports/udp" -d '{}'
{
"udp_port": 10001
"capture_file_name": null,
"capture_file_path": null,
"capturing": false,
"link_id": "007f2177-6790-4e1b-ac28-41fa226b2a06",
"nodes": [
{
"adapter_number": 0,
"node_id": "f124dec0-830a-451e-a314-be50bbd58a00",
"port_number": 0
},
{
"adapter_number": 0,
"node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74",
"port_number": 0
}
],
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f"
}
We can create the bidirectionnal communication between the two VPCS. The
communication is made by creating two UDP tunnels.
Now we can start the two nodes.
.. code-block:: shell-session
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/vpcs/vms/24d2e16b-fbef-4259-ae34-7bc21a41ee28/adapters/0/ports/0/nio" -d '{"lport": 10000, "rhost": "127.0.0.1", "rport": 10001, "type": "nio_udp"}'
{
"lport": 10000,
"rhost": "127.0.0.1",
"rport": 10001,
"type": "nio_udp"
}
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/vpcs/vms/daefc24a-103c-4717-8e01-6517d931c1ae/adapters/0/ports/0/nio" -d '{"lport": 10001, "rhost": "127.0.0.1", "rport": 10000, "type": "nio_udp"}'
{
"lport": 10001,
"rhost": "127.0.0.1",
"rport": 10000,
"type": "nio_udp"
}
Now we can start the two Node
.. code-block:: shell-session
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/vpcs/vms/24d2e16b-fbef-4259-ae34-7bc21a41ee28/start" -d "{}"
# curl -X POST "http://localhost:3080/v1/projects/42f9feee-3217-4104-981e-85d5f0a806ec/vpcs/vms/daefc24a-103c-4717-8e01-6517d931c1ae/start" -d '{}'
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/f124dec0-830a-451e-a314-be50bbd58a00/start" -d "{}"
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/83892a4d-aea0-4350-8b3e-d0af3713da74/start" -d "{}"
Everything should be started now. You can connect via telnet to the different Node.
The port is the field console in the create Node request.
.. code-block:: shell-session
# telnet 127.0.0.1 2000
# telnet 127.0.0.1 5000
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
@ -141,8 +174,7 @@ The port is the field console in the create Node request.
Good-bye
Connection closed by foreign host.
# telnet 127.0.0.1 2001
telnet 127.0.0.1 2001
# telnet 127.0.0.1 5001
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
@ -174,6 +206,25 @@ The port is the field console in the create Node request.
Good-bye
Connection closed by foreign host.
And we stop the two nodes.
.. code-block:: shell-session
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/f124dec0-830a-451e-a314-be50bbd58a00/stop" -d "{}"
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/83892a4d-aea0-4350-8b3e-d0af3713da74/stop" -d "{}"
You can see notification about the changes via the notification feed:
.. code-block:: shell-session
# curl "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/notifications"
{"action": "ping", "event": {"compute_id": "local", "cpu_usage_percent": 35.7, "memory_usage_percent": 80.7}}
{"action": "node.updated", "event": {"command_line": "/usr/local/bin/vpcs -p 5001 -m 1 -i 1 -F -R -s 10001 -c 10000 -t 127.0.0.1", "compute_id": "local", "console": 5001, "console_host": "127.0.0.1", "console_type": "telnet", "name": "VPCS 2", "node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74", "node_type": "vpcs", "project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f", "properties": {"startup_script": null, "startup_script_path": null}, "status": "started"}}
A websocket version is also available on http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/notifications/ws
If you start the server with **--debug** you can see all the requests made by the client and by the controller to the computes nodes.
Limitations
============