NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-07-11 15:37:57 +02:00
1 parent 91ec61b88d
commit 27269fb13a
142 files changed
+1072 -796
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **node_id**: Node UUID
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **node_id**: Node UUID
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **node_id**: Node UUID
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **node_id**: Node UUID
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **node_id**: Node UUID
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: Project UUID
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
- **node_id**: Node UUID
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **node_id**: Node UUID
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **node_id**: Node UUID
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a IOU instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a IOU instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
- **node_id**: Node UUID
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on an IOU VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **node_id**: Node UUID
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on an IOU VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/network/interfaces.rst → docs/api/v2/compute/network/networkinterfaces.rst
+3 -3
View File
@@ -1,9 +1,9 @@
/v2/compute/interfaces
/v2/compute/network/interfaces
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/interfaces
GET /v2/compute/network/interfaces
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List all the network interfaces available on the server
@@ -15,5 +15,5 @@ Sample session
***************
.. literalinclude:: ../../../examples/compute_get_interfaces.txt
.. literalinclude:: ../../../examples/compute_get_networkinterfaces.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst
+1
View File
@@ -124,6 +124,7 @@ Input
<tr><td>kernel_image</td> <td> </td> <td>string</td> <td>QEMU kernel image path</td> </tr>
<tr><td>kernel_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
<tr><td>legacy_networking</td> <td> </td> <td>['boolean', 'null']</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>mac_address</td> <td> </td> <td>['string', 'null']</td> <td>QEMU MAC address</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>QEMU VM instance name</td> </tr>
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: Project UUID
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
@@ -27,8 +27,8 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: Project UUID
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a VPCS instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **node_id**: Node UUID
@@ -33,8 +33,8 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
- **node_id**: Node UUID
docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a packet capture on a VPCS instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **node_id**: Node UUID
docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a packet capture on a VPCS instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter
- **node_id**: Node UUID
docs/api/v2/controller/compute/s.rst
+3 -1
View File
@@ -33,8 +33,10 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>connected</td> <td>&#10004;</td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
docs/api/v2/controller/compute/sid.rst
+6 -2
View File
@@ -35,8 +35,10 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>connected</td> <td>&#10004;</td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
@@ -60,8 +62,10 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>connected</td> <td>&#10004;</td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
+43
View File
@@ -3,6 +3,49 @@
.. contents::
PUT /v2/projects/**{project_id}**/links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a link instance
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Link updated
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr>
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr>
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
<tr><td>nodes</td> <td>&#10004;</td> <td>array</td> <td>List of the VMS</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr>
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr>
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
<tr><td>nodes</td> <td>&#10004;</td> <td>array</td> <td>List of the VMS</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
</table>
DELETE /v2/projects/**{project_id}**/links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a link instance
docs/api/v2/controller/node/projectsprojectidnodes.rst
+10 -6
View File
@@ -27,6 +27,7 @@ Input
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -36,9 +37,10 @@ Input
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Output
@@ -52,6 +54,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -61,9 +64,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+10 -6
View File
@@ -24,6 +24,7 @@ Input
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -33,9 +34,10 @@ Input
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Output
@@ -49,6 +51,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -58,9 +61,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session
docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<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>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<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>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<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>
<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>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</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>
Sample session