/v2/projects/{project_id}/nodes/{node_id}¶
GET /v2/projects/{project_id}/nodes/{node_id}¶
Update a node instance
Response status codes¶
- 200: Node found
- 400: Invalid request
- 404: Node doesn’t exist
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
command_line | ['null', 'string'] | Command line use to start the node | |
compute_id | ✔ | string | Compute identifier |
console | ['integer', 'null'] | Console TCP port | |
console_host | string | 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. | |
console_type | enum | Possible values: vnc, telnet, http, https, spice, null | |
first_port_name | ['string', 'null'] | Name of the first port | |
height | integer | Height of the node (Read only) | |
label | object | ||
name | ✔ | string | Node name |
node_directory | ['null', 'string'] | Working directory of the node. Read only | |
node_id | string | Node UUID | |
node_type | ✔ | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
port_name_format | string | Formating for port name {0} will be replace by port number | |
port_segment_size | integer | Size of the port segment | |
ports | array | List of node ports READ only | |
project_id | string | Project UUID | |
properties | object | Properties specific to an emulator | |
status | enum | Possible values: stopped, started, suspended | |
symbol | ['string', 'null'] | Symbol of the node | |
width | integer | Width of the node (Read only) | |
x | integer | X position of the node | |
y | integer | Y position of the node | |
z | integer | Z position of the node |
Sample session¶
curl -i -X GET 'http://localhost:3080/v2/projects/27d4fc3f-0c57-4b34-bee2-497f1216f9b1/nodes/ef78b006-21e6-4b82-a0db-c259c3e59fda'
GET /v2/projects/27d4fc3f-0c57-4b34-bee2-497f1216f9b1/nodes/ef78b006-21e6-4b82-a0db-c259c3e59fda HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 1123
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:16:37 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/projects/{project_id}/nodes/{node_id}
{
"command_line": null,
"compute_id": "example.com",
"console": 2048,
"console_host": "<MagicMock name='mock.console_host' id='5864420576'>",
"console_type": null,
"first_port_name": null,
"height": 59,
"label": {
"rotation": 0,
"style": "font-size: 10;font-familly: Verdana",
"text": "test",
"x": null,
"y": -40
},
"name": "test",
"node_directory": null,
"node_id": "ef78b006-21e6-4b82-a0db-c259c3e59fda",
"node_type": "vpcs",
"port_name_format": "Ethernet{0}",
"port_segment_size": 0,
"ports": [
{
"adapter_number": 0,
"data_link_types": {
"Ethernet": "DLT_EN10MB"
},
"link_type": "ethernet",
"name": "Ethernet0",
"port_number": 0,
"short_name": "e0"
}
],
"project_id": "27d4fc3f-0c57-4b34-bee2-497f1216f9b1",
"properties": {
"startup_script": "echo test"
},
"status": "stopped",
"symbol": ":/symbols/computer.svg",
"width": 65,
"x": 0,
"y": 0,
"z": 0
}
PUT /v2/projects/{project_id}/nodes/{node_id}¶
Update a node instance
Response status codes¶
- 200: Instance updated
- 400: Invalid request
- 404: Instance doesn’t exist
Input¶
Name | Mandatory | Type | Description |
---|---|---|---|
command_line | ['null', 'string'] | Command line use to start the node | |
compute_id | string | Compute identifier | |
console | ['integer', 'null'] | Console TCP port | |
console_host | string | 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. | |
console_type | enum | Possible values: vnc, telnet, http, https, spice, null | |
first_port_name | ['string', 'null'] | Name of the first port | |
height | integer | Height of the node (Read only) | |
label | object | ||
name | string | Node name | |
node_directory | ['null', 'string'] | Working directory of the node. Read only | |
node_id | string | Node UUID | |
node_type | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu | |
port_name_format | string | Formating for port name {0} will be replace by port number | |
port_segment_size | integer | Size of the port segment | |
ports | array | List of node ports READ only | |
project_id | string | Project UUID | |
properties | object | Properties specific to an emulator | |
status | enum | Possible values: stopped, started, suspended | |
symbol | ['string', 'null'] | Symbol of the node | |
width | integer | Width of the node (Read only) | |
x | integer | X position of the node | |
y | integer | Y position of the node | |
z | integer | Z position of the node |
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
command_line | ['null', 'string'] | Command line use to start the node | |
compute_id | ✔ | string | Compute identifier |
console | ['integer', 'null'] | Console TCP port | |
console_host | string | 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. | |
console_type | enum | Possible values: vnc, telnet, http, https, spice, null | |
first_port_name | ['string', 'null'] | Name of the first port | |
height | integer | Height of the node (Read only) | |
label | object | ||
name | ✔ | string | Node name |
node_directory | ['null', 'string'] | Working directory of the node. Read only | |
node_id | string | Node UUID | |
node_type | ✔ | enum | Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu |
port_name_format | string | Formating for port name {0} will be replace by port number | |
port_segment_size | integer | Size of the port segment | |
ports | array | List of node ports READ only | |
project_id | string | Project UUID | |
properties | object | Properties specific to an emulator | |
status | enum | Possible values: stopped, started, suspended | |
symbol | ['string', 'null'] | Symbol of the node | |
width | integer | Width of the node (Read only) | |
x | integer | X position of the node | |
y | integer | Y position of the node | |
z | integer | Z position of the node |
Sample session¶
curl -i -X PUT 'http://localhost:3080/v2/projects/758ba972-b86f-4fe1-8ee4-55a47010ccd6/nodes/fc936387-be57-4907-b240-bc2806f28a30' -d '{"compute_id": "example.com", "name": "test", "node_type": "vpcs", "properties": {"startup_script": "echo test"}}'
PUT /v2/projects/758ba972-b86f-4fe1-8ee4-55a47010ccd6/nodes/fc936387-be57-4907-b240-bc2806f28a30 HTTP/1.1
{
"compute_id": "example.com",
"name": "test",
"node_type": "vpcs",
"properties": {
"startup_script": "echo test"
}
}
HTTP/1.1 200
Connection: close
Content-Length: 1080
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:16:37 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/projects/{project_id}/nodes/{node_id}
{
"command_line": null,
"compute_id": "example.com",
"console": 2048,
"console_host": "<MagicMock name='mock.console_host' id='5864971904'>",
"console_type": null,
"first_port_name": null,
"height": 59,
"label": {
"rotation": 0,
"style": "font-size: 10;font-familly: Verdana",
"text": "test",
"x": null,
"y": -40
},
"name": "test",
"node_directory": null,
"node_id": "fc936387-be57-4907-b240-bc2806f28a30",
"node_type": "vpcs",
"port_name_format": "Ethernet{0}",
"port_segment_size": 0,
"ports": [
{
"adapter_number": 0,
"data_link_types": {
"Ethernet": "DLT_EN10MB"
},
"link_type": "ethernet",
"name": "Ethernet0",
"port_number": 0,
"short_name": "e0"
}
],
"project_id": "758ba972-b86f-4fe1-8ee4-55a47010ccd6",
"properties": {},
"status": "stopped",
"symbol": ":/symbols/computer.svg",
"width": 65,
"x": 0,
"y": 0,
"z": 0
}
DELETE /v2/projects/{project_id}/nodes/{node_id}¶
Delete a node instance
Parameters¶
- project_id: Project UUID
- node_id: Node UUID
Response status codes¶
- 204: Instance deleted
- 400: Invalid request
- 404: Instance doesn’t exist
Sample session¶
curl -i -X DELETE 'http://localhost:3080/v2/projects/86bbdba1-356e-4abf-94af-42c002782a60/nodes/f22f2164-5f3f-4dd8-b88b-cca9e32f4f5c'
DELETE /v2/projects/86bbdba1-356e-4abf-94af-42c002782a60/nodes/f22f2164-5f3f-4dd8-b88b-cca9e32f4f5c HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Mon, 08 Jan 2018 08:16:38 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/projects/{project_id}/nodes/{node_id}