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

Update the documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2017-03-06 14:35:39 +01:00
1 parent 8b7035b185
commit 54131bc9bb
319 files changed
+921 -5755
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/vmware/projectsprojectidvmwarenodes.rst
+4 -2
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -27,6 +27,7 @@ Input
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>Headless mode</td> </tr>
<tr><td>linked_clone</td> <td>&#10004;</td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VMware VM instance name</td> </tr>
@@ -45,10 +46,11 @@ Output
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>Headless mode</td> </tr>
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>VMware VM instance name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td>Path to the node working directory</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeid.rst
+10 -7
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
**********************
@@ -28,10 +28,11 @@ Output
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>Headless mode</td> </tr>
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>VMware VM instance name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td>Path to the node working directory</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
@@ -46,8 +47,8 @@ Update a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -66,10 +67,11 @@ Input
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>Headless mode</td> </tr>
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>VMware VM instance name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td>Path to the node working directory</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
@@ -87,10 +89,11 @@ Output
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>Headless mode</td> </tr>
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>VMware VM instance name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td>Path to the node working directory</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
@@ -105,12 +108,12 @@ Delete a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+6 -6
View File
@@ -9,15 +9,15 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
@@ -27,14 +27,14 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+3 -3
View File
@@ -9,9 +9,9 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
@@ -27,6 +27,6 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td>&#10004;</td> <td>string</td> <td>Capture file name</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+3 -3
View File
@@ -9,14 +9,14 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidinterfacesvmnet.rst
+1 -1
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
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidreload.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Reload a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidresume.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Resume a suspended VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance resumed
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance resumed
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstart.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Start a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstop.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Stop a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidsuspend.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Suspend a VMware VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended