gns3-server/docs/api/v1/vpcs/projectsprojectidvpcsvms.rst

/v1/projects/{project_id}/vpcs/vms
----------------------------------------------------------------------------------------------------------------------

.. contents::

POST /v1/projects/**{project_id}**/vpcs/vms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new VPCS instance

Parameters
**********
- **project_id**: UUID for the project

Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **409**: Conflict

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>&#10004;</td>                     <td>string</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>vm_id</td>                    <td> </td>                     <td></td>                     <td>VPCS VM identifier</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 VM name</td>                     </tr>
    <tr><td>project_id</td>                    <td>&#10004;</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>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Path of the VPCS startup script relative to project directory</td>                     </tr>
    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VPCS VM UUID</td>                     </tr>
    </table>

Sample session
***************


.. literalinclude:: ../../examples/post_projectsprojectidvpcsvms.txt
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00			`/v1/projects/{project_id}/vpcs/vms`
Better organisation of the API documentation 2015-02-17 09:37:09 +00:00			`----------------------------------------------------------------------------------------------------------------------`
Update documentation. 2015-02-05 00:48:33 +00:00
			`.. contents::`

Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00			`POST /v1/projects/{project_id}/vpcs/vms`
Better organisation of the API documentation 2015-02-17 09:37:09 +00:00			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
Update documentation. 2015-02-05 00:48:33 +00:00			`Create a new VPCS instance`

			`Parameters`
			`**********`
			`- project_id: UUID for the project`

			`Response status codes`
			`**********************`
			`- 400: Invalid request`
			`- 201: Instance created`
			`- 409: Conflict`

			`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</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>`
Turn off documentation sidebar because it's broken 2015-02-13 17:27:08 +00:00			`<tr><td>vm_id</td> <td> </td> <td></td> <td>VPCS VM identifier</td> </tr>`
Update documentation. 2015-02-05 00:48:33 +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</td> <td>console TCP port</td> </tr>`
			`<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>`
			`<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>`
Add a curl sample sessions 2015-02-27 17:39:20 +00:00			`<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>`
Update documentation. 2015-02-05 00:48:33 +00:00			`<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VPCS VM UUID</td> </tr>`
			`</table>`

Fix doc generation 2015-02-24 10:38:57 +00:00			`Sample session`
			`***************`


			`.. literalinclude:: ../../examples/post_projectsprojectidvpcsvms.txt`