1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-24 17:28:08 +00:00
gns3-server/docs/controller_notifications.rst
grossmj 7f72b90b0e The server has now 2 notification streams
* A new one for controller related events (compute, appliance templates etc.)
* The existing one for project related events (links, nodes etc.)
2018-08-16 21:31:57 +07:00

83 lines
1.5 KiB
ReStructuredText

Controller notifications
========================
Controller notifications can be received from the controller, they can be used to get information
about computes and appliance templates.
Notification endpoints
**********************
Listen to the HTTP stream endpoint or to the WebSocket endpoint.
* :doc:`api/v2/controller/notification/notifications`
* :doc:`api/v2/controller/notification/notificationsws`
It is recommended to use the WebSocket endpoint.
Available notifications
***********************
.. contents::
:local:
ping
----
Keep-alive between client and controller. Also used to receive the current CPU and memory usage.
.. literalinclude:: api/notifications/ping.json
compute.created
----------------
A compute has been created.
.. literalinclude:: api/notifications/compute.created.json
compute.updated
----------------
A compute has been updated.
.. literalinclude:: api/notifications/compute.updated.json
compute.deleted
---------------
A compute has been deleted.
.. literalinclude:: api/notifications/compute.deleted.json
log.error
---------
Sends an error
.. literalinclude:: api/notifications/log.error.json
log.warning
------------
Sends a warning
.. literalinclude:: api/notifications/log.warning.json
log.info
---------
Sends an information
.. literalinclude:: api/notifications/log.info.json
settings.updated
-----------------
GUI settings have been updated. Will be removed in a later release.
.. literalinclude:: api/notifications/settings.updated.json