mirror of
https://github.com/GNS3/gns3-server
synced 2024-11-28 19:28:07 +00:00
280 lines
8.9 KiB
ReStructuredText
280 lines
8.9 KiB
ReStructuredText
Communications
|
|
===============
|
|
|
|
All the communication are done over HTTP using JSON.
|
|
|
|
Errors
|
|
======
|
|
|
|
In case of error a standard HTTP error is raise and you got a
|
|
JSON like that
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"status": 409,
|
|
"message": "Conflict"
|
|
}
|
|
|
|
409 error could be display to the user. They are normal behavior
|
|
they are used to warn user about something he should change and
|
|
they are not an internal software error.
|
|
|
|
Sample session using curl
|
|
=========================
|
|
|
|
You need to read the :doc:`glossary` before.
|
|
|
|
.. warning::
|
|
|
|
Beware the output of this sample is truncated in order
|
|
to simplify the understanding. Please read the
|
|
documentation for the exact output.
|
|
|
|
You can check the server version with a simple curl command:
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl "http://localhost:3080/v2/version"
|
|
{
|
|
"version": "2.0.0dev1"
|
|
}
|
|
|
|
We will list the computes node where we can run our nodes:
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl "http://localhost:3080/v2/computes"
|
|
[
|
|
{
|
|
"compute_id": "local",
|
|
"connected": true,
|
|
"host": "127.0.0.1",
|
|
"name": "Local",
|
|
"port": 3080,
|
|
"protocol": "http",
|
|
"user": "admin"
|
|
}
|
|
]
|
|
|
|
In this sample we have only one compute where we can run our nodes. This compute as a special id: local. This
|
|
mean it's the local server embed in the GNS3 controller.
|
|
|
|
The next step is to create a project.
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl -X POST "http://localhost:3080/v2/projects" -d '{"name": "test"}'
|
|
{
|
|
"name": "test",
|
|
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f",
|
|
}
|
|
|
|
|
|
With this project id we can now create two VPCS Node.
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes" -d '{"name": "VPCS 1", "node_type": "vpcs", "compute_id": "local"}'
|
|
{
|
|
"compute_id": "local",
|
|
"console": 5000,
|
|
"console_host": "127.0.0.1",
|
|
"console_type": "telnet",
|
|
"name": "VPCS 1",
|
|
"node_id": "f124dec0-830a-451e-a314-be50bbd58a00",
|
|
"node_type": "vpcs",
|
|
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f",
|
|
"properties": {
|
|
"startup_script": null,
|
|
"startup_script_path": null
|
|
},
|
|
"status": "stopped"
|
|
}
|
|
|
|
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes" -d '{"name": "VPCS 2", "node_type": "vpcs", "compute_id": "local"}'
|
|
{
|
|
"compute_id": "local",
|
|
"console": 5001,
|
|
"console_host": "127.0.0.1",
|
|
"console_type": "telnet",
|
|
"name": "VPCS 2",
|
|
"node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74",
|
|
"node_type": "vpcs",
|
|
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f",
|
|
"properties": {
|
|
"startup_script": null,
|
|
"startup_script_path": null
|
|
},
|
|
"status": "stopped"
|
|
}
|
|
|
|
The properties dictionnary contains all setting specific to a node type (dynamips, docker, vpcs...)
|
|
|
|
Now we need to link the two VPCS by connecting their port 0 together.
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/links" -d '{"nodes": [{"adapter_number": 0, "node_id": "f124dec0-830a-451e-a314-be50bbd58a00", "port_number": 0}, {"adapter_number": 0, "node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74", "port_number": 0}]}'
|
|
{
|
|
"capture_file_name": null,
|
|
"capture_file_path": null,
|
|
"capturing": false,
|
|
"link_id": "007f2177-6790-4e1b-ac28-41fa226b2a06",
|
|
"nodes": [
|
|
{
|
|
"adapter_number": 0,
|
|
"node_id": "f124dec0-830a-451e-a314-be50bbd58a00",
|
|
"port_number": 0
|
|
},
|
|
{
|
|
"adapter_number": 0,
|
|
"node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74",
|
|
"port_number": 0
|
|
}
|
|
],
|
|
"project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f"
|
|
}
|
|
|
|
Now we can start the two nodes.
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/f124dec0-830a-451e-a314-be50bbd58a00/start" -d "{}"
|
|
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/83892a4d-aea0-4350-8b3e-d0af3713da74/start" -d "{}"
|
|
|
|
Everything should be started now. You can connect via telnet to the different Node.
|
|
The port is the field console in the create Node request.
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# telnet 127.0.0.1 5000
|
|
Trying 127.0.0.1...
|
|
Connected to localhost.
|
|
Escape character is '^]'.
|
|
|
|
Welcome to Virtual PC Simulator, version 0.6
|
|
Dedicated to Daling.
|
|
Build time: Dec 29 2014 12:51:46
|
|
Copyright (c) 2007-2014, Paul Meng (mirnshi@gmail.com)
|
|
All rights reserved.
|
|
|
|
VPCS is free software, distributed under the terms of the "BSD" licence.
|
|
Source code and license can be found at vpcs.sf.net.
|
|
For more information, please visit wiki.freecode.com.cn.
|
|
|
|
Press '?' to get help.
|
|
|
|
VPCS> ip 192.168.1.1
|
|
Checking for duplicate address...
|
|
PC1 : 192.168.1.1 255.255.255.0
|
|
|
|
VPCS> disconnect
|
|
|
|
Good-bye
|
|
Connection closed by foreign host.
|
|
|
|
# telnet 127.0.0.1 5001
|
|
Trying 127.0.0.1...
|
|
Connected to localhost.
|
|
Escape character is '^]'.
|
|
|
|
Welcome to Virtual PC Simulator, version 0.6
|
|
Dedicated to Daling.
|
|
Build time: Dec 29 2014 12:51:46
|
|
Copyright (c) 2007-2014, Paul Meng (mirnshi@gmail.com)
|
|
All rights reserved.
|
|
|
|
VPCS is free software, distributed under the terms of the "BSD" licence.
|
|
Source code and license can be found at vpcs.sf.net.
|
|
For more information, please visit wiki.freecode.com.cn.
|
|
|
|
Press '?' to get help.
|
|
|
|
VPCS> ip 192.168.1.2
|
|
Checking for duplicate address...
|
|
PC1 : 192.168.1.2 255.255.255.0
|
|
|
|
VPCS> ping 192.168.1.1
|
|
84 bytes from 192.168.1.1 icmp_seq=1 ttl=64 time=0.179 ms
|
|
84 bytes from 192.168.1.1 icmp_seq=2 ttl=64 time=0.218 ms
|
|
84 bytes from 192.168.1.1 icmp_seq=3 ttl=64 time=0.190 ms
|
|
84 bytes from 192.168.1.1 icmp_seq=4 ttl=64 time=0.198 ms
|
|
84 bytes from 192.168.1.1 icmp_seq=5 ttl=64 time=0.185 ms
|
|
|
|
VPCS> disconnect
|
|
Good-bye
|
|
Connection closed by foreign host.
|
|
|
|
And we stop the two nodes.
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/f124dec0-830a-451e-a314-be50bbd58a00/stop" -d "{}"
|
|
# curl -X POST "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/nodes/83892a4d-aea0-4350-8b3e-d0af3713da74/stop" -d "{}"
|
|
|
|
You can see notification about the changes via the notification feed:
|
|
|
|
.. code-block:: shell-session
|
|
|
|
# curl "http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/notifications"
|
|
{"action": "ping", "event": {"compute_id": "local", "cpu_usage_percent": 35.7, "memory_usage_percent": 80.7}}
|
|
{"action": "node.updated", "event": {"command_line": "/usr/local/bin/vpcs -p 5001 -m 1 -i 1 -F -R -s 10001 -c 10000 -t 127.0.0.1", "compute_id": "local", "console": 5001, "console_host": "127.0.0.1", "console_type": "telnet", "name": "VPCS 2", "node_id": "83892a4d-aea0-4350-8b3e-d0af3713da74", "node_type": "vpcs", "project_id": "b8c070f7-f34c-4b7b-ba6f-be3d26ed073f", "properties": {"startup_script": null, "startup_script_path": null}, "status": "started"}}
|
|
|
|
A websocket version is also available on http://localhost:3080/v2/projects/b8c070f7-f34c-4b7b-ba6f-be3d26ed073f/notifications/ws
|
|
|
|
If you start the server with **--debug** you can see all the requests made by the client and by the controller to the computes nodes.
|
|
|
|
Limitations
|
|
============
|
|
|
|
Concurrency
|
|
------------
|
|
|
|
A node can't process multiple request in the same time. But you can make
|
|
multiple request on multiple node. It's transparent for the client
|
|
when the first request on a Node start a lock is acquire for this node id
|
|
and released for the next request at the end. You can safely send all
|
|
the requests in the same time and let the server manage an efficent concurrency.
|
|
|
|
We think it can be a little slower for some operations, but it's remove a big
|
|
complexity for the client due to the fact only some command on some node can be
|
|
concurrent.
|
|
|
|
|
|
Authentication
|
|
-----------------
|
|
|
|
You can use HTTP basic auth to protect the access to the API. And run
|
|
the API over HTTPS.
|
|
|
|
|
|
Notifications
|
|
=============
|
|
|
|
You can receive notification from the server if you listen the HTTP stream /notifications or the websocket.
|
|
|
|
The available notification are:
|
|
* ping
|
|
* compute.created
|
|
* compute.updated
|
|
* compute.deleted
|
|
* node.created
|
|
* node.updated
|
|
* node.deleted
|
|
* link.created
|
|
* link.updated
|
|
* link.deleted
|
|
* log.error
|
|
* log.warning
|
|
* log.info
|
|
|
|
Previous versions
|
|
=================
|
|
|
|
API version 1
|
|
-------------
|
|
Shipped with GNS3 1.3, 1.4 and 1.5.
|
|
This API doesn't support the controller system and save used a commit system instead of live save.
|
|
|