NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 14:01:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update API documentation. Fixes #1253.

Browse Source
This commit is contained in:
grossmj committed 2018-01-08 11:57:07 +07:00
1 parent e8353e68bb
commit ffe21f6b73
324 files changed
+1168 -14199
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/dynamips_vm/dynamipsimagesfilename.rst
+13
View File
@@ -15,3 +15,16 @@ Response status codes
**********************
- **204**: Upload a Dynamips IOS image
GET /v2/compute/dynamips/images/**{filename:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download a Dynamips IOS image
Parameters
**********
- **filename**: Image filename
Response status codes
**********************
- **200**: Image returned
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **201**: Instance created
- **400**: Invalid request
- **201**: Instance created
- **409**: Conflict
Input
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst
+4 -4
View File
@@ -9,8 +9,8 @@ Get a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -75,8 +75,8 @@ Update a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -188,12 +188,12 @@ Delete a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+24 -6
View File
@@ -9,15 +9,33 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
Response status codes
**********************
- **201**: NIO created
- **400**: Invalid request
- **201**: NIO created
- **404**: Instance doesn't exist
PUT /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a Dynamips instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be updated
- **adapter_number**: Network adapter where the nio is located
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **404**: Instance doesn't exist
@@ -27,14 +45,14 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **adapter_number**: Adapter from where the nio should be removed
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+3 -3
View File
@@ -9,14 +9,14 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidautoidlepc.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeididlepcproposals.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Reload a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Resume a suspended Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance resumed
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance resumed
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Start a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Stop a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Suspend a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended