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

Documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-03-11 15:21:21 +01:00
1 parent be4aa41dda
commit 7d0b780dcc
135 files changed
+623 -295
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvms.rst
+2
View File
@@ -24,6 +24,7 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</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>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM name</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
<tr><td>vm_id</td> <td> </td> <td></td> <td>VPCS VM identifier</td> </tr>
@@ -37,6 +38,7 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmid.rst
+6 -3
View File
@@ -9,8 +9,8 @@ Get a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@@ -26,6 +26,7 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
@@ -48,8 +49,8 @@ Update a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@@ -65,6 +66,7 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</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>name</td> <td> </td> <td>['string', 'null']</td> <td>VPCS VM name</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
</table>
@@ -77,6 +79,7 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
@@ -99,8 +102,8 @@ Delete a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port where the nio should be added
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **project_id**: UUID for the project
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port from where the nio should be removed
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst
+2 -1
View File
@@ -9,8 +9,8 @@ Start a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@@ -26,6 +26,7 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************