/v2/projects/{project_id}/nodes/{node_id}

Contents

• /v2/projects/{project_id}/nodes/{node_id}
  • GET /v2/projects/{project_id}/nodes/{node_id}
    • Response status codes
    • Output
    • Sample session
  • PUT /v2/projects/{project_id}/nodes/{node_id}
    • Response status codes
    • Input
    • Output
    • Sample session
  • DELETE /v2/projects/{project_id}/nodes/{node_id}
    • Parameters
    • Response status codes
    • Sample session

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, 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/b97cbb09-8eef-4def-b338-ab29d9942bc2/nodes/8d4fce2b-5b61-446d-b7a7-93b07e4cabac'

GET /v2/projects/b97cbb09-8eef-4def-b338-ab29d9942bc2/nodes/8d4fce2b-5b61-446d-b7a7-93b07e4cabac HTTP/1.1



HTTP/1.1 200
Connection: close
Content-Length: 1123
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:31:59 GMT
Server: Python/3.6 GNS3/2.0.0dev11
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='4434431336'>",
    "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": "8d4fce2b-5b61-446d-b7a7-93b07e4cabac",
    "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": "b97cbb09-8eef-4def-b338-ab29d9942bc2",
    "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, 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, 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/2071abcf-98b8-42b8-a6e7-6e0e5571e223/nodes/86b1aa27-5c82-4596-8246-3f7384f853a1' -d '{"compute_id": "example.com", "name": "test", "node_type": "vpcs", "properties": {"startup_script": "echo test"}}'

PUT /v2/projects/2071abcf-98b8-42b8-a6e7-6e0e5571e223/nodes/86b1aa27-5c82-4596-8246-3f7384f853a1 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: Tue, 21 Mar 2017 09:31:59 GMT
Server: Python/3.6 GNS3/2.0.0dev11
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='4433145248'>",
    "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": "86b1aa27-5c82-4596-8246-3f7384f853a1",
    "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": "2071abcf-98b8-42b8-a6e7-6e0e5571e223",
    "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/856d9a5f-f0fc-4a14-ab9c-6cd61abde4f6/nodes/5d7c89f2-3a82-4ad5-918d-798dc70aefb3'

DELETE /v2/projects/856d9a5f-f0fc-4a14-ab9c-6cd61abde4f6/nodes/5d7c89f2-3a82-4ad5-918d-798dc70aefb3 HTTP/1.1



HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 21 Mar 2017 09:32:00 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/projects/{project_id}/nodes/{node_id}