1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-28 19:28:07 +00:00
gns3-server/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodes.rst

67 lines
4.2 KiB
ReStructuredText
Raw Normal View History

2016-06-04 08:40:39 +00:00
/v2/compute/projects/{project_id}/ethernet_switch/nodes
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **201**: Instance created
- **400**: Invalid request
2016-06-04 08:40:39 +00:00
- **409**: Conflict
Input
*******
Types
+++++++++
EthernetSwitchPort
^^^^^^^^^^^^^^^^^^^^^^
2024-01-12 02:21:34 +00:00
Ethernet switch port
2016-06-04 08:40:39 +00:00
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>ethertype</td> <td> </td> <td>enum</td> <td>Possible values: null, 0x8100, 0x88A8, 0x9100, 0x9200</td> </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>
<tr><td>type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: access, dot1q, qinq</td> </tr>
<tr><td>vlan</td> <td> </td> <td>integer</td> <td>VLAN number</td> </tr>
</table>
Body
+++++++++
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, none</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Ethernet switch 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>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, none</td> </tr>
2017-06-29 15:14:09 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Ethernet switch name</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</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>
2017-06-29 15:14:09 +00:00
<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>