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 documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-08-15 17:39:08 +02:00
1 parent 3ca4edef93
commit e710eff22e
134 files changed
+753 -776
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an ATM switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to an ATM switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from an ATM switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an ATM switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a cloud instance
Parameters
**********
- **port_number**: Port on the cloud
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a cloud instance
Parameters
**********
- **port_number**: Port on the cloud
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a cloud instance
Parameters
**********
- **port_number**: Port on the cloud
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **port_number**: Port on the cloud
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Docker container
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a Docker container
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
- **port_number**: Port on the hub
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from an Ethernet hub instance
Parameters
**********
- **port_number**: Port on the hub
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
- **port_number**: Port on the hub
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
- **port_number**: Port on the hub
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a Frame Relay switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
- **port_number**: Port on the switch
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a IOU instance
Parameters
**********
- **port_number**: Port where the nio should be added
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a IOU instance
Parameters
**********
- **port_number**: Port from where the nio should be removed
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/project/projectsprojectid.rst
-44
View File
@@ -36,50 +36,6 @@ Sample session
.. literalinclude:: ../../../examples/compute_get_projectsprojectid.txt
PUT /v2/compute/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Project updated
- **403**: Forbidden to update this project
- **404**: The project doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the project on the server (work only with --local)</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectid.txt
DELETE /v2/compute/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a project from disk
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ 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
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ 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
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ 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
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ 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
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a VPCS instance
Parameters
**********
- **port_number**: Port where the nio should be added
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **port_number**: Port from where the nio should be removed
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a VPCS instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID
docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a VPCS instance
Parameters
**********
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
- **node_id**: Node UUID