mirror of https://github.com/GNS3/gns3-server
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
156 lines
8.8 KiB
156 lines
8.8 KiB
/v2/compute/projects/{project_id}/cloud/nodes/{node_id}
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
.. contents::
|
|
|
|
GET /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Get a cloud instance
|
|
|
|
Parameters
|
|
**********
|
|
- **node_id**: Node UUID
|
|
- **project_id**: Project UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Success
|
|
- **400**: Invalid request
|
|
- **404**: Instance doesn't exist
|
|
|
|
Output
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
|
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
|
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
|
</table>
|
|
|
|
|
|
PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Update a cloud instance
|
|
|
|
Parameters
|
|
**********
|
|
- **node_id**: Node UUID
|
|
- **project_id**: Project UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Instance updated
|
|
- **400**: Invalid request
|
|
- **404**: Instance doesn't exist
|
|
- **409**: Conflict
|
|
|
|
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>✔</td> <td>string</td> <td>Ethernet interface name e.g. eth0</td> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Port name</td> </tr>
|
|
<tr><td>port_number</td> <td>✔</td> <td>integer</td> <td>Port number</td> </tr>
|
|
<tr><td>type</td> <td>✔</td> <td>enum</td> <td>Possible values: ethernet</td> </tr>
|
|
</table>
|
|
|
|
HostInterfaces
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
Interfaces on this host
|
|
|
|
.. 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</td> <td>Interface name</td> </tr>
|
|
<tr><td>type</td> <td>✔</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>✔</td> <td>string</td> <td>TAP interface name e.g. tap0</td> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Port name</td> </tr>
|
|
<tr><td>port_number</td> <td>✔</td> <td>integer</td> <td>Port number</td> </tr>
|
|
<tr><td>type</td> <td>✔</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>✔</td> <td>integer</td> <td>Local UDP tunnel port</td> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Port name</td> </tr>
|
|
<tr><td>port_number</td> <td>✔</td> <td>integer</td> <td>Port number</td> </tr>
|
|
<tr><td>rhost</td> <td>✔</td> <td>string</td> <td>Remote UDP tunnel host</td> </tr>
|
|
<tr><td>rport</td> <td>✔</td> <td>integer</td> <td>Remote UDP tunnel port</td> </tr>
|
|
<tr><td>type</td> <td>✔</td> <td>enum</td> <td>Possible values: udp</td> </tr>
|
|
</table>
|
|
|
|
Body
|
|
+++++++++
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
|
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
|
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
|
</table>
|
|
|
|
Output
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
|
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
|
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
|
</table>
|
|
|
|
|
|
DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Delete a cloud instance
|
|
|
|
Parameters
|
|
**********
|
|
- **node_id**: Node UUID
|
|
- **project_id**: Project UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **400**: Invalid request
|
|
- **404**: Instance doesn't exist
|
|
- **204**: Instance deleted
|
|
|