ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2025-06-21 00:22:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentations

Browse Source
This commit is contained in:
Julien Duponchelle
2016-11-03 18:20:51 +01:00
parent 4e15f89604
commit 6f43f988c3
261 changed files with 1289 additions and 1330 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodes.rst
View File

@ -27,9 +27,8 @@ Input
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox 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>enable_remote_console</td> <td> </td> <td>boolean</td> <td>Enable the remote console</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>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>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
@ -47,7 +46,6 @@ Output
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox 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>enable_remote_console</td> <td> </td> <td>boolean</td> <td>Enable the remote console</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>VirtualBox VM instance name</td> </tr>

9
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeid.rst
View File

@ -9,8 +9,8 @@ Get a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@ -28,7 +28,6 @@ Output
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox 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>enable_remote_console</td> <td> </td> <td>boolean</td> <td>Enable the remote console</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>VirtualBox VM instance name</td> </tr>
@ -54,8 +53,8 @@ Update a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@ -74,7 +73,6 @@ Input
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox 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>enable_remote_console</td> <td> </td> <td>boolean</td> <td>Enable the remote console</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>VirtualBox VM instance name</td> </tr>
@ -97,7 +95,6 @@ Output
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox 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>enable_remote_console</td> <td> </td> <td>boolean</td> <td>Enable the remote console</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>VirtualBox VM instance name</td> </tr>
@ -123,8 +120,8 @@ Delete a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************

8
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
View File

@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **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
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@ -33,10 +33,10 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
- **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
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************

4
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
View File

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

4
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
View File

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

2
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidreload.rst
View File

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

2
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidresume.rst
View File

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

2
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstart.rst
View File

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

2
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst
View File

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

2
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidsuspend.rst
View File

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