1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-28 11:18:11 +00:00
gns3-server/docs/api/v1vpcsuuid.rst

87 lines
4.2 KiB
ReStructuredText
Raw Normal View History

2015-02-04 09:31:31 +00:00
/v1/vpcs/{uuid}
-----------------------------------------------------------
.. contents::
2015-02-04 09:31:31 +00:00
GET /v1/vpcs/**{uuid}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a VPCS instance
Parameters
**********
2015-01-26 08:36:26 +00:00
- **uuid**: Instance UUID
Response status codes
**********************
2015-01-21 21:33:41 +00:00
- **200**: Success
2015-01-26 08:36:26 +00:00
- **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>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>
2015-02-04 01:44:04 +00:00
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
2015-01-26 08:36:26 +00:00
<tr><td>script_file</td> <td> </td> <td>['string', 'null']</td> <td>VPCS startup script</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
<tr><td>uuid</td> <td>&#10004;</td> <td>string</td> <td>VPCS device UUID</td> </tr>
</table>
2015-02-04 09:31:31 +00:00
PUT /v1/vpcs/**{uuid}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a VPCS instance
2015-01-23 15:19:17 +00:00
Parameters
**********
2015-01-26 08:36:26 +00:00
- **uuid**: Instance UUID
2015-01-23 15:19:17 +00:00
Response status codes
**********************
2015-01-26 08:36:26 +00:00
- **200**: Instance updated
- **409**: Conflict
2015-01-26 08:36:26 +00:00
- **404**: Instance doesn't exist
Input
*******
.. 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>name</td> <td> </td> <td>['string', 'null']</td> <td>VPCS device name</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<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>
2015-02-04 01:44:04 +00:00
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>script_file</td> <td> </td> <td>['string', 'null']</td> <td>VPCS startup script</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
<tr><td>uuid</td> <td>&#10004;</td> <td>string</td> <td>VPCS device UUID</td> </tr>
</table>
2015-01-23 15:19:17 +00:00
2015-02-04 09:31:31 +00:00
DELETE /v1/vpcs/**{uuid}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-01-23 15:19:17 +00:00
Delete a VPCS instance
Parameters
**********
2015-01-26 08:36:26 +00:00
- **uuid**: Instance UUID
2015-01-23 15:19:17 +00:00
Response status codes
**********************
2015-01-26 08:36:26 +00:00
- **404**: Instance doesn't exist
- **204**: Instance deleted
2015-01-23 15:19:17 +00:00