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

Rebuild documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-08-25 14:43:19 +02:00
1 parent 9255dc07b7
commit 9511c34b4f
189 files changed
+4541 -897
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/cloud/projectsprojectidcloudnodes.rst
+7 -45
View File
@@ -21,20 +21,6 @@ Input
*******
Types
+++++++++
EthernetInterfacePort
^^^^^^^^^^^^^^^^^^^^^^
Ethernet interface port
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>interface</td> <td>&#10004;</td> <td>string</td> <td>Ethernet interface name e.g. eth0</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Port name</td> </tr>
<tr><td>port_number</td> <td>&#10004;</td> <td>integer</td> <td>Port number</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: ethernet</td> </tr>
</table>
HostInterfaces
^^^^^^^^^^^^^^^^^^^^^^
Interfaces on this host
@@ -44,37 +30,7 @@ Interfaces on this host
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Interface name</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: Ethernet, TAP</td> </tr>
</table>
TAPInterfacePort
^^^^^^^^^^^^^^^^^^^^^^
TAP interface port
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>interface</td> <td>&#10004;</td> <td>string</td> <td>TAP interface name e.g. tap0</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Port name</td> </tr>
<tr><td>port_number</td> <td>&#10004;</td> <td>integer</td> <td>Port number</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: tap</td> </tr>
</table>
UDPTunnelPort
^^^^^^^^^^^^^^^^^^^^^^
UDP tunnel port
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>lport</td> <td>&#10004;</td> <td>integer</td> <td>Local UDP tunnel port</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Port name</td> </tr>
<tr><td>port_number</td> <td>&#10004;</td> <td>integer</td> <td>Port number</td> </tr>
<tr><td>rhost</td> <td>&#10004;</td> <td>string</td> <td>Remote UDP tunnel host</td> </tr>
<tr><td>rport</td> <td>&#10004;</td> <td>integer</td> <td>Remote UDP tunnel port</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: udp</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: ethernet, tap</td> </tr>
</table>
Body
@@ -103,3 +59,9 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidcloudnodes.txt
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst
+18 -44
View File
@@ -32,6 +32,12 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidcloudnodesnodeid.txt
PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -53,20 +59,6 @@ Input
*******
Types
+++++++++
EthernetInterfacePort
^^^^^^^^^^^^^^^^^^^^^^
Ethernet interface port
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>interface</td> <td>&#10004;</td> <td>string</td> <td>Ethernet interface name e.g. eth0</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Port name</td> </tr>
<tr><td>port_number</td> <td>&#10004;</td> <td>integer</td> <td>Port number</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: ethernet</td> </tr>
</table>
HostInterfaces
^^^^^^^^^^^^^^^^^^^^^^
Interfaces on this host
@@ -79,36 +71,6 @@ Interfaces on this host
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: ethernet, tap</td> </tr>
</table>
TAPInterfacePort
^^^^^^^^^^^^^^^^^^^^^^
TAP interface port
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>interface</td> <td>&#10004;</td> <td>string</td> <td>TAP interface name e.g. tap0</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Port name</td> </tr>
<tr><td>port_number</td> <td>&#10004;</td> <td>integer</td> <td>Port number</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: tap</td> </tr>
</table>
UDPTunnelPort
^^^^^^^^^^^^^^^^^^^^^^
UDP tunnel port
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>lport</td> <td>&#10004;</td> <td>integer</td> <td>Local UDP tunnel port</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Port name</td> </tr>
<tr><td>port_number</td> <td>&#10004;</td> <td>integer</td> <td>Port number</td> </tr>
<tr><td>rhost</td> <td>&#10004;</td> <td>string</td> <td>Remote UDP tunnel host</td> </tr>
<tr><td>rport</td> <td>&#10004;</td> <td>integer</td> <td>Remote UDP tunnel port</td> </tr>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: udp</td> </tr>
</table>
Body
+++++++++
.. raw:: html
@@ -137,6 +99,12 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidcloudnodesnodeid.txt
DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -153,3 +121,9 @@ Response status codes
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidcloudnodesnodeid.txt
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+16 -4
View File
@@ -9,10 +9,10 @@ Add a NIO to a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
@@ -20,6 +20,12 @@ Response status codes
- **201**: NIO created
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -27,10 +33,10 @@ Remove a NIO from a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
@@ -38,3 +44,9 @@ Response status codes
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Start a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************