mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-29 10:18:10 +00:00
108 lines
6.7 KiB
ReStructuredText
108 lines
6.7 KiB
ReStructuredText
/v2/appliances/{appliance_id}
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
.. contents::
|
|
|
|
GET /v2/appliances/**{appliance_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Get an appliance
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Appliance found
|
|
- **400**: Invalid request
|
|
- **404**: Appliance doesn't exist
|
|
|
|
Output
|
|
*******
|
|
.. 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>✔</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>✔</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>✔</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>
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_get_appliancesapplianceid.txt
|
|
|
|
|
|
PUT /v2/appliances/**{appliance_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Update an appliance
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Appliance updated
|
|
- **400**: Invalid request
|
|
- **404**: Appliance doesn't exist
|
|
|
|
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> </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> </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> </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>✔</td> <td>string</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
|
|
<tr><td>appliance_type</td> <td>✔</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>✔</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>✔</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>
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_put_appliancesapplianceid.txt
|
|
|
|
|
|
DELETE /v2/appliances/**{appliance_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Delete an appliance
|
|
|
|
Parameters
|
|
**********
|
|
- **appliance_id**: appliance UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **204**: Appliance deleted
|
|
- **400**: Invalid request
|
|
- **404**: Appliance doesn't exist
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_delete_appliancesapplianceid.txt
|
|
|