1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-25 01:38:08 +00:00
gns3-server/docs/api/vpcs.rst

46 lines
2.3 KiB
ReStructuredText
Raw Normal View History

2015-01-14 00:05:26 +00:00
/vpcs
2015-01-20 14:21:13 +00:00
---------------------------------------------
2015-01-14 00:05:26 +00:00
.. contents::
POST /vpcs
2015-01-20 14:21:13 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new VPCS instance
2015-01-14 00:05:26 +00:00
Response status codes
2015-01-20 14:21:13 +00:00
**********************
- **201**: VPCS instance created
2015-01-14 00:05:26 +00:00
- **409**: Conflict
Input
*******
.. raw:: html
<table>
2015-01-20 14:21:13 +00:00
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS device name</td> </tr>
<tr><td>project_uuid</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>uuid</td> <td> </td> <td>string</td> <td>VPCS device UUID</td> </tr>
<tr><td>vpcs_id</td> <td> </td> <td>integer</td> <td>VPCS device instance ID (for project created before GNS3 1.3)</td> </tr>
2015-01-14 00:05:26 +00:00
</table>
Output
*******
.. raw:: html
<table>
2015-01-20 14:21:13 +00:00
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS device name</td> </tr>
<tr><td>project_uuid</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>uuid</td> <td>&#10004;</td> <td>string</td> <td>VPCS device UUID</td> </tr>
2015-01-14 00:05:26 +00:00
</table>
Sample session
***************
.. literalinclude:: examples/post_vpcs.txt