Table of Contents
The SDN-R Websocketmanager is a server which a client can connect to, to receive NETCONF notifications forwarded by the the devicemanagers. To get rid of all old protocol issues we redesigned all the messages.
The user scope registration
This is a full example of a registration for notifications of a specific type. In this case all problem-notification notifications of the node with the node-id node1 implemented in the email@example.com.
In fact there are a lot of use cases to receive a lot of different notifications or specific notifications for a bunch of nodes, most properties are optional
|node-id||yes||filter for notifications only from node with node-id|
|schema||yes||filter for specific notifications implemented by a model|
|schema.namespace||no||if schema is set, namespace has to be set, otherwise a schema is not valid|
|schema.revision||yes||filter for a specific revision of the implemented model|
|schema.notification||yes||filter for specific notification types of the model|
|ratio||yes||maximum of notifications per minute to receive (format: "[num]/min")|
If the user scope registration succeeds you will get a response with your submitted scopes
If not you will receive an error message with the cause, e.g.
User scope registration examples
Example 1: All notifications for node-id:
Example 2: All notifications for node-id for all yang-models:
Example 3: All notifications(every node) for all yang-models:
Example 4: All notifications(every node) implemented in microwave-model:
Example 5: All notifications(every node) of type problem-notification of microwave-model:
Example 6: All notifications(every node) of type problem-notification of microwave-model@2018-10-10:
Example 7: All notifications for node-id of type problem-notification of microwave-model@2018-10-10:
A notification has the following structure
|node-id||node-id which is the source the notification|
|event-time||timestamp of the notification|
Inside the opendaylight container the websocketmanager does not implement a yang-generated RPC anymore. Instead ther is nor a more simplified and more generic interface to submit notifications to it.
Notification Rate Limitation
In fact that this interface is also used to provide notifications for a Web-UI like ODLUX and a large amount of notifications can result in a inresponsive UI, there has to be an option to reduce the ratio of notifications per time unit that wanted to be received with the knowledge that this can result in lost notifications for the websocket client. For ODLUX it's not that big problem, because all notifications are also logged in the database and are only lost for live popup notification.
So we like to extend the user scope registration message with an additional property
So from this point of view it is basically a server side implementation.
Additionally there will be a notification (yang-spec) specified which will be send once a to be specified time frame which tells how much notifications were not send if at least one was not send.
Of course only sent, if you registered for this scope