2016-06-21 08:47:22 +00:00
|
|
|
Endpoints
|
|
|
|
|
------------
|
|
|
|
|
|
2018-03-12 06:38:50 +00:00
|
|
|
GNS3 exposes two type of endpoints:
|
2016-06-21 08:47:22 +00:00
|
|
|
|
2018-03-12 06:38:50 +00:00
|
|
|
* Controller endpoints
|
|
|
|
|
* Compute endpoints
|
2016-06-21 08:47:22 +00:00
|
|
|
|
2018-03-12 06:38:50 +00:00
|
|
|
Controller endpoints
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~
|
2016-06-21 08:47:22 +00:00
|
|
|
|
2018-03-12 06:38:50 +00:00
|
|
|
The controller manages everything, it is the central decision point
|
|
|
|
|
and has a complete view of your network topologies, what nodes run on
|
2018-11-27 11:14:51 +00:00
|
|
|
which compute, the links between them etc.
|
2016-06-21 08:47:22 +00:00
|
|
|
|
2018-03-12 06:38:50 +00:00
|
|
|
This is the high level API which can be used by users to manually control
|
|
|
|
|
the GNS3 backend. The controller will call the compute endpoints when needed.
|
|
|
|
|
|
|
|
|
|
A standard GNS3 setup is to have one controller and one or many computes.
|
2016-06-21 08:47:22 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:glob:
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
api/v2/controller/*
|
|
|
|
|
|
|
|
|
|
|
2018-03-12 06:38:50 +00:00
|
|
|
Compute Endpoints
|
|
|
|
|
~~~~~~~~~~~~~~~~~~
|
2016-06-21 08:47:22 +00:00
|
|
|
|
2018-03-12 06:38:50 +00:00
|
|
|
A compute is the GNS3 process running on a host. It controls emulators in order to run nodes
|
|
|
|
|
(e.g. VMware VMs with VMware Workstation, IOS routers with Dynamips etc.)
|
2016-06-21 08:47:22 +00:00
|
|
|
|
|
|
|
|
.. WARNING::
|
2018-03-12 06:38:50 +00:00
|
|
|
These endpoints should be considered low level and private.
|
|
|
|
|
They should only be used by the controller or for debugging purposes.
|
2016-06-21 08:47:22 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:glob:
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
api/v2/compute/*
|
|
|
|
|
|
