mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Use "template" to name what we use to create new nodes.
This commit is contained in:
grossmj committed
1 parent
21c0a35f77
commit
d7c2e16c21
262 files changed
+16588
-16863
No files matched your search
@@ -3,57 +3,9 @@
|
||||
|
||||
.. 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>✔</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_post_appliances.txt
|
||||
|
||||
|
||||
GET /v2/appliances
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List of appliance
|
||||
List of appliances
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -1,107 +0,0 @@
|
||||
/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
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
/v2/appliances/{appliance_id}/duplicate
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/appliances/**{appliance_id}**/duplicate
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Duplicate an appliance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **appliance_id**: Appliance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Appliance duplicated
|
||||
- **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_post_appliancesapplianceidduplicate.txt
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
/v2/appliances/templates
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/appliances/templates
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List of appliance templates
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Appliance template list returned
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_appliancestemplates.txt
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
/v2/projects/{project_id}/appliances/{appliance_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/projects/**{project_id}**/appliances/**{appliance_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a node from an appliance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **appliance_id**: Appliance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Node created
|
||||
- **404**: The project or appliance doesn't exist
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>compute_id</td> <td> </td> <td>['null', 'string']</td> <td>If the appliance don't have a default compute use this compute</td> </tr>
|
||||
<tr><td>x</td> <td>✔</td> <td>integer</td> <td>X position</td> </tr>
|
||||
<tr><td>y</td> <td>✔</td> <td>integer</td> <td>Y position</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>['null', 'string']</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
|
||||
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_auto_start</td> <td> </td> <td>boolean</td> <td>Automatically start the console when the node has started</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, spice+agent, none, null</td> </tr>
|
||||
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Node name</td> </tr>
|
||||
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>node_type</td> <td>✔</td> <td>enum</td> <td>Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
|
||||
<tr><td>port_name_format</td> <td> </td> <td>string</td> <td>Formating for port name {0} will be replace by port number</td> </tr>
|
||||
<tr><td>port_segment_size</td> <td> </td> <td>integer</td> <td>Size of the port segment</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td>List of node ports READ only</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
|
||||
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
|
||||
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
|
||||
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
|
||||
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Reference in new issue
Block a user