NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2024-11-18 01:34:50 +02:00
Code Issues Packages Projects Releases Wiki Activity
ff5ba3742e
gns3-server/docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst

147 lines
12 KiB
ReStructuredText
Raw Normal View History

Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
/v2/compute/projects/{project_id}/iou/nodes/{node_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update docs
2016-06-04 11:40:39 +03:00
Get an IOU instance
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
Parameters
**********
Fix API status code for start/stop/suspend/reload a node. Fixes #1353. Fix issues with test. Update documentation.
2018-06-14 11:39:31 +03:00
- **project_id**: Project UUID
The server has now 2 notification streams * A new one for controller related events (compute, appliance templates etc.) * The existing one for project related events (links, nodes etc.)
2018-08-16 17:31:56 +03:00
- **node_id**: Node UUID
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03: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>
Update API documentation. Fixes #1253.
2018-01-08 06:57:07 +02:00
<tr><td>application_id</td> <td> </td> <td>integer</td> <td>Application ID for running IOU image</td> </tr>
<tr><td>command_line</td> <td> </td> <td>string</td> <td>Last command line used by GNS3 to start IOU</td> </tr>
The server has now 2 notification streams * A new one for controller related events (compute, appliance templates etc.) * The existing one for project related events (links, nodes etc.)
2018-08-16 17:31:56 +03:00
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, none</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>l1_keepalives</td> <td> </td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
<tr><td>md5sum</td> <td> </td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>IOU VM name</td> </tr>
Update docs
2016-06-04 11:40:39 +03:00
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>node_id</td> <td> </td> <td>string</td> <td>IOU VM UUID</td> </tr>
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
<tr><td>path</td> <td> </td> <td>string</td> <td>Path of iou binary</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
<tr><td>serial_adapters</td> <td> </td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
Update docs
2016-06-04 11:40:39 +03:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
</table>
Update API documentation
2018-01-08 10:26:44 +02:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidiounodesnodeid.txt
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
PUT /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update docs
2016-06-04 11:40:39 +03:00
Update an IOU instance
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
Parameters
**********
Fix API status code for start/stop/suspend/reload a node. Fixes #1353. Fix issues with test. Update documentation.
2018-06-14 11:39:31 +03:00
- **project_id**: Project UUID
The server has now 2 notification streams * A new one for controller related events (compute, appliance templates etc.) * The existing one for project related events (links, nodes etc.)
2018-08-16 17:31:56 +03:00
- **node_id**: Node UUID
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03: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>
Update API documentation. Fixes #1253.
2018-01-08 06:57:07 +02:00
<tr><td>application_id</td> <td> </td> <td>integer</td> <td>Application ID for running IOU image</td> </tr>
<tr><td>command_line</td> <td> </td> <td>string</td> <td>Last command line used by GNS3 to start IOU</td> </tr>
The server has now 2 notification streams * A new one for controller related events (compute, appliance templates etc.) * The existing one for project related events (links, nodes etc.)
2018-08-16 17:31:56 +03:00
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, none</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>l1_keepalives</td> <td> </td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
<tr><td>md5sum</td> <td> </td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>name</td> <td> </td> <td>string</td> <td>IOU VM name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>IOU VM UUID</td> </tr>
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
<tr><td>path</td> <td> </td> <td>string</td> <td>Path of iou binary</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
<tr><td>serial_adapters</td> <td> </td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
Update API documentation. Fixes #1253.
2018-01-08 06:57:07 +02:00
<tr><td>application_id</td> <td> </td> <td>integer</td> <td>Application ID for running IOU image</td> </tr>
<tr><td>command_line</td> <td> </td> <td>string</td> <td>Last command line used by GNS3 to start IOU</td> </tr>
The server has now 2 notification streams * A new one for controller related events (compute, appliance templates etc.) * The existing one for project related events (links, nodes etc.)
2018-08-16 17:31:56 +03:00
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, none</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>l1_keepalives</td> <td> </td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
<tr><td>md5sum</td> <td> </td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>IOU VM name</td> </tr>
Update docs
2016-06-04 11:40:39 +03:00
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>node_id</td> <td> </td> <td>string</td> <td>IOU VM UUID</td> </tr>
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
<tr><td>path</td> <td> </td> <td>string</td> <td>Path of iou binary</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
<tr><td>serial_adapters</td> <td> </td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
Update docs
2016-06-04 11:40:39 +03:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
Update documentation
2016-07-22 14:54:57 +03:00
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
</table>
Update API documentation
2018-01-08 10:26:44 +02:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidiounodesnodeid.txt
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
DELETE /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update docs
2016-06-04 11:40:39 +03:00
Delete an IOU instance
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
Parameters
**********
Fix API status code for start/stop/suspend/reload a node. Fixes #1353. Fix issues with test. Update documentation.
2018-06-14 11:39:31 +03:00
- **project_id**: Project UUID
The server has now 2 notification streams * A new one for controller related events (compute, appliance templates etc.) * The existing one for project related events (links, nodes etc.)
2018-08-16 17:31:56 +03:00
- **node_id**: Node UUID
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
Response status codes
**********************
Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630
2018-11-20 08:04:27 +02:00
- **204**: Instance deleted
Return command_line and node_directory via the controller
2016-05-12 11:39:50 +03:00
- **400**: Invalid request
- **404**: Instance doesn't exist
Update API documentation
2018-01-08 10:26:44 +02:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidiounodesnodeid.txt
Update docs
2017-03-21 14:32:04 +02:00
Reference in New Issue Copy Permalink