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 API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630

Browse Source
This commit is contained in:
grossmj committed 2018-11-20 13:04:27 +07:00
1 parent e5950674f8
commit ff5ba3742e
343 files changed
+12431 -11199
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/appliance/appliances.rst
+48
View File
@@ -3,6 +3,54 @@
.. contents::
POST /v2/appliances
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new appliance
Response status codes
**********************
- **201**: Appliance created
- **400**: Invalid request
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>appliance_id</td> <td> </td> <td>string</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
<tr><td>appliance_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>builtin</td> <td> </td> <td>boolean</td> <td>Appliance is builtin</td> </tr>
<tr><td>category</td> <td> </td> <td></td> <td>Appliance category</td> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>default_name_format</td> <td> </td> <td>string</td> <td>Default name format</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Appliance name</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the appliance</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>appliance_id</td> <td>&#10004;</td> <td>string</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
<tr><td>appliance_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>builtin</td> <td>&#10004;</td> <td>boolean</td> <td>Appliance is builtin</td> </tr>
<tr><td>category</td> <td>&#10004;</td> <td></td> <td>Appliance category</td> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>default_name_format</td> <td>&#10004;</td> <td>string</td> <td>Default name format</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Appliance name</td> </tr>
<tr><td>symbol</td> <td>&#10004;</td> <td>string</td> <td>Symbol of the appliance</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_appliances.txt
GET /v2/appliances
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List of appliance
docs/api/v2/controller/appliance/projectsprojectidappliancesapplianceid.rst
+2 -2
View File
@@ -10,12 +10,12 @@ Create a node from an appliance
Parameters
**********
- **project_id**: Project UUID
- **appliance_id**: Appliance template UUID
- **appliance_id**: Appliance UUID
Response status codes
**********************
- **201**: Node created
- **404**: The project or template doesn't exist
- **404**: The project or appliance doesn't exist
Input
*******