arno/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-01 12:48:14 +00:00
Code Issues Releases Wiki Activity
e3493870b2
gns3-server/docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst

167 lines
17 KiB
ReStructuredText
Raw Normal View History

Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
/v2/projects/{project_id}/nodes/{node_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
Update documentations
2016-09-27 15:15:40 +00:00
GET /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630
2018-11-20 06:04:27 +00:00
Get a node
Update documentations
2016-09-27 15:15:40 +00:00
Response status codes
**********************
- **200**: Node found
- **400**: Invalid request
- **404**: Node 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>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
Rebuild the documentation
2017-06-29 15:14:09 +00:00
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
Update documentations
2016-09-27 15:15:40 +00:00
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</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 14:31:56 +00:00
<tr><td>console_auto_start</td> <td> </td> <td>boolean</td> <td>Automatically start the console when the node has started</td> </tr>
Update api documentations
2016-10-20 08:54:07 +00:00
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</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 14:31:56 +00:00
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, spice+agent, none, null</td> </tr>
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
Update documentations
2016-09-27 15:15:40 +00:00
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
Refresh documentation
2019-03-30 08:56:26 +00:00
<tr><td>locked</td> <td> </td> <td>boolean</td> <td>Whether the element locked or not</td> </tr>
Rebuild the documentation
2017-06-29 15:14:09 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Node name</td> </tr>
Update documentations
2016-09-27 15:15:40 +00:00
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
Update API documentation
2018-06-07 08:26:06 +00:00
<tr><td>node_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
Update documentations
2016-09-27 15:15:40 +00:00
<tr><td>port_name_format</td> <td> </td> <td>string</td> <td>Formating for port name {0} will be replace by port number</td> </tr>
<tr><td>port_segment_size</td> <td> </td> <td>integer</td> <td>Size of the port segment</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td>List of node ports READ only</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
Update api documentations
2016-10-20 08:54:07 +00:00
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
Use "template" to name what we use to create new nodes.
2018-11-28 09:12:57 +00:00
<tr><td>template_id</td> <td> </td> <td>['null', 'string']</td> <td>Template UUID from which the node has been created. Read only</td> </tr>
Update documentations
2016-09-27 15:15:40 +00:00
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Update API documentation
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeid.txt
Update documentations
2016-09-27 15:15:40 +00:00
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
PUT /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a node instance
Response status codes
**********************
Update docs
2016-06-04 08:40:39 +00:00
- **200**: Instance updated
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
- **400**: Invalid request
Update docs
2016-06-04 08:40:39 +00:00
- **404**: Instance doesn't exist
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</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 14:31:56 +00:00
<tr><td>console_auto_start</td> <td> </td> <td>boolean</td> <td>Automatically start the console when the node has started</td> </tr>
Update api documentations
2016-10-20 08:54:07 +00:00
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</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 14:31:56 +00:00
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, spice+agent, none, null</td> </tr>
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
Rebuild documentation
2016-09-14 13:24:27 +00:00
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
Rebuild documentation
2016-08-25 12:43:19 +00:00
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
Update documentation
2016-06-14 08:24:55 +00:00
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
Refresh documentation
2019-03-30 08:56:26 +00:00
<tr><td>locked</td> <td> </td> <td>boolean</td> <td>Whether the element locked or not</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
Update API documentation
2018-06-07 08:26:06 +00:00
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
Rebuild documentation
2016-09-14 13:24:27 +00:00
<tr><td>port_name_format</td> <td> </td> <td>string</td> <td>Formating for port name {0} will be replace by port number</td> </tr>
<tr><td>port_segment_size</td> <td> </td> <td>integer</td> <td>Size of the port segment</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td>List of node ports READ only</td> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
Update api documentations
2016-10-20 08:54:07 +00:00
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
Use "template" to name what we use to create new nodes.
2018-11-28 09:12:57 +00:00
<tr><td>template_id</td> <td> </td> <td>['null', 'string']</td> <td>Template UUID from which the node has been created. Read only</td> </tr>
Rebuild documentation
2016-08-25 12:43:19 +00:00
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
Update documentation
2016-07-11 13:37:57 +00:00
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
Rebuild the documentation
2017-06-29 15:14:09 +00:00
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</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 14:31:56 +00:00
<tr><td>console_auto_start</td> <td> </td> <td>boolean</td> <td>Automatically start the console when the node has started</td> </tr>
Update api documentations
2016-10-20 08:54:07 +00:00
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</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 14:31:56 +00:00
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, spice+agent, none, null</td> </tr>
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
Rebuild documentation
2016-09-14 13:24:27 +00:00
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
Rebuild documentation
2016-08-25 12:43:19 +00:00
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
Update documentation
2016-06-14 08:24:55 +00:00
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
Refresh documentation
2019-03-30 08:56:26 +00:00
<tr><td>locked</td> <td> </td> <td>boolean</td> <td>Whether the element locked or not</td> </tr>
Rebuild the documentation
2017-06-29 15:14:09 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Node name</td> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
Update API documentation
2018-06-07 08:26:06 +00:00
<tr><td>node_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
Rebuild documentation
2016-09-14 13:24:27 +00:00
<tr><td>port_name_format</td> <td> </td> <td>string</td> <td>Formating for port name {0} will be replace by port number</td> </tr>
<tr><td>port_segment_size</td> <td> </td> <td>integer</td> <td>Size of the port segment</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td>List of node ports READ only</td> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
Update docs
2016-06-04 08:40:39 +00:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
Update api documentations
2016-10-20 08:54:07 +00:00
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
Use "template" to name what we use to create new nodes.
2018-11-28 09:12:57 +00:00
<tr><td>template_id</td> <td> </td> <td>['null', 'string']</td> <td>Template UUID from which the node has been created. Read only</td> </tr>
Rebuild documentation
2016-08-25 12:43:19 +00:00
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
Update documentation
2016-07-11 13:37:57 +00:00
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
</table>
Update API documentation
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectidnodesnodeid.txt
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
DELETE /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a node instance
Parameters
**********
Fix API status code for start/stop/suspend/reload a node. Fixes #1353. Fix issues with test. Update documentation.
2018-06-14 08:39:31 +00: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 14:31:56 +00:00
- **node_id**: Node UUID
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
Response status codes
**********************
Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630
2018-11-20 06:04:27 +00:00
- **204**: Instance deleted
Return command_line and node_directory via the controller
2016-05-12 08:39:50 +00:00
- **400**: Invalid request
Update docs
2016-06-04 08:40:39 +00:00
- **404**: Instance doesn't exist
Update API documentation
2019-10-23 14:00:00 +00:00
- **409**: Cannot delete locked node
Update API documentation
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidnodesnodeid.txt
Update docs
2017-03-21 12:32:04 +00:00
Reference in New Issue Copy Permalink