1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-28 19:28:07 +00:00
gns3-server/docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst

52 lines
3.9 KiB
ReStructuredText
Raw Normal View History

/v2/projects/{project_id}/nodes/{node_id}/reload
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Reload a node instance
Parameters
**********
2016-06-14 08:24:55 +00:00
- **project_id**: Project UUID
2016-06-17 09:12:22 +00:00
- **node_id**: Node UUID
Response status codes
**********************
- **400**: Invalid request
2016-06-04 08:40:39 +00:00
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Output
*******
.. 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>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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>
2016-06-04 08:40:39 +00:00
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
2016-06-14 08:24:55 +00:00
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
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>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
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>
2016-06-14 08:24:55 +00:00
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidreload.txt