gns3-server/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodes.rst

60 lines
2.9 KiB
ReStructuredText
Raw Normal View History

2016-06-04 08:40:39 +00:00
/v2/compute/projects/{project_id}/ethernet_hub/nodes
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
2018-01-08 08:26:44 +00:00
- **400**: Invalid request
- **201**: Instance created
2016-06-04 08:40:39 +00:00
- **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>&#10004;</td> <td>string</td> <td>Port name</td> </tr>
<tr><td>port_number</td> <td>&#10004;</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>&#10004;</td> <td>string</td> <td>Ethernet hub name</td> </tr>
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
2016-09-14 13:24:27 +00:00
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
2016-06-04 08:40:39 +00:00
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2017-06-29 15:14:09 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Ethernet hub name</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>ports_mapping</td> <td>&#10004;</td> <td>array</td> <td></td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>