mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-22 06:07:51 +00:00
109 lines
5.3 KiB
ReStructuredText
109 lines
5.3 KiB
ReStructuredText
|
/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}
|
||
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
|
||
|
|
GET /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Get an Ethernet hub 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>name</td> <td> </td> <td>string</td> <td>Ethernet hub 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}**/ethernet_hub/nodes/**{node_id}**
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Update an Ethernet hub 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
|
||
|
|
+++++++++
|
||
|
|
EthernetHubPort
|
||
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
||
|
|
Ethernet port
|
||
|
|
|
||
|
|
.. 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>Port name</td> </tr>
|
||
|
|
<tr><td>port_number</td> <td>✔</td> <td>integer</td> <td>Port number</td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Body
|
||
|
|
+++++++++
|
||
|
|
.. 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>Ethernet hub 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>name</td> <td> </td> <td>string</td> <td>Ethernet hub 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}**/ethernet_hub/nodes/**{node_id}**
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Delete an Ethernet hub instance
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
**********
|
||
|
|
- **node_id**: Node UUID
|
||
|
|
- **project_id**: Project UUID
|
||
|
|
|
||
|
|
Response status codes
|
||
|
|
**********************
|
||
|
|
- **400**: Invalid request
|
||
|
|
- **404**: Instance doesn't exist
|
||
|
|
- **204**: Instance deleted
|
||
|
|
|