2016-05-12 08:39:50 +00:00
/v2/compute/projects/{project_id}/vpcs/nodes/{node_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents ::
GET /v2/compute/projects/**{project_id}** /vpcs/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a VPCS instance
Parameters
***** *****
2016-11-03 17:20:51 +00:00
- **project_id** : Project UUID
2017-03-06 13:35:39 +00:00
- **node_id** : Node UUID
2016-05-12 08:39:50 +00:00
Response status codes
***** ***** ***** ***** **
- **200** : Success
- **400** : Invalid request
- **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>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>Console TCP port</td> </tr>
2016-05-12 08:39:50 +00:00
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>
2017-03-06 13:35:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>node_id</td> <td>✔</td> <td>string</td> <td>Node UUID</td> </tr>
2016-05-12 08:39:50 +00:00
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
<tr><td>startup_script_path</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</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>
2016-05-12 08:39:50 +00:00
</table>
2017-03-21 12:32:04 +00:00
Sample session
***** ***** *****
.. literalinclude :: ../../../examples/compute_get_projectsprojectidvpcsnodesnodeid.txt
2016-05-12 08:39:50 +00:00
PUT /v2/compute/projects/**{project_id}** /vpcs/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a VPCS instance
Parameters
***** *****
2016-11-03 17:20:51 +00:00
- **project_id** : Project UUID
2017-03-06 13:35:39 +00:00
- **node_id** : Node UUID
2016-05-12 08:39:50 +00:00
Response status codes
***** ***** ***** ***** **
- **200** : Instance updated
- **400** : Invalid request
- **404** : Instance doesn't exist
- **409** : Conflict
Input
***** **
.. raw :: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
2016-05-12 08:39:50 +00:00
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>VPCS VM name</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
<tr><td>startup_script_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory (IGNORED)</td> </tr>
</table>
Output
***** **
.. raw :: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>Console TCP port</td> </tr>
2016-05-12 08:39:50 +00:00
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>
2017-03-06 13:35:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>node_id</td> <td>✔</td> <td>string</td> <td>Node UUID</td> </tr>
2016-05-12 08:39:50 +00:00
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
<tr><td>startup_script_path</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</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>
2016-05-12 08:39:50 +00:00
</table>
2017-03-21 12:32:04 +00:00
Sample session
***** ***** *****
.. literalinclude :: ../../../examples/compute_put_projectsprojectidvpcsnodesnodeid.txt
2016-05-12 08:39:50 +00:00
DELETE /v2/compute/projects/**{project_id}** /vpcs/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a VPCS instance
Parameters
***** *****
2016-11-03 17:20:51 +00:00
- **project_id** : Project UUID
2017-03-06 13:35:39 +00:00
- **node_id** : Node UUID
2016-05-12 08:39:50 +00:00
Response status codes
***** ***** ***** ***** **
2017-03-06 13:35:39 +00:00
- **204** : Instance deleted
2016-05-12 08:39:50 +00:00
- **400** : Invalid request
- **404** : Instance doesn't exist
2017-03-21 12:32:04 +00:00
Sample session
***** ***** *****
.. literalinclude :: ../../../examples/compute_delete_projectsprojectidvpcsnodesnodeid.txt
