gns3-server/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodes.rst

44 lines
2.4 KiB
ReStructuredText

/v2/compute/projects/{project_id}/frame_relay_switch/nodes
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>mappings</td> <td> </td> <td>object</td> <td>Frame Relay mappings</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Frame Relay switch name</td> </tr>
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>mappings</td> <td> </td> <td>object</td> <td>Frame Relay mappings</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Frame Relay switch name</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td>&#10004;</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>