1 module nbi-notifications {
3 namespace "nbi-notifications";
4 prefix nbinotifications;
6 import org-openroadm-service {
8 revision-date 2019-05-31;
10 import org-openroadm-common-service-types {
11 prefix org-openroadm-common-service-types;
12 revision-date 2019-05-31;
14 import org-openroadm-common-state-types {
15 prefix org-openroadm-common-state-types;
16 revision-date 2018-11-30;
22 "transportPCE committers - ODL";
24 "YANG definitions for using REST API in NBI notifications module. Copyright
25 (c) 2020 ORANGE and others. All rights reserved.";
29 "Rename the groupings, containers and RPCs";
34 "Implement new models, RPC for service alarms";
39 "Initial revision of NBI notifications";
42 grouping notification-process-service {
47 "Message for the specified service";
53 "Identifier for the service to be created in the ROADM network, e.g., CLFI, CLCI, etc.
54 This is reported against the service, but may not get reflected in the service in the network.";
59 "To be used by the ROADM controller to identify the routing constraints
60 received from planning application (PED).";
62 leaf connection-type {
63 type org-openroadm-common-service-types:connection-type;
66 container service-a-end {
67 uses org-openroadm-common-service-types:service-endpoint;
69 container service-z-end {
70 uses org-openroadm-common-service-types:service-endpoint;
72 leaf response-failed {
75 "Response of the error if the service request encountered an anomaly";
77 leaf operational-state {
78 type org-openroadm-common-state-types:state;
81 "Operational State: Actual state of service";
85 grouping notification-alarm-service {
90 "Message for the specified service";
96 "Identifier for the service to be created in the ROADM network, e.g., CLFI, CLCI, etc.
97 This is reported against the service, but may not get reflected in the service in the network.";
99 leaf connection-type {
100 type org-openroadm-common-service-types:connection-type;
103 leaf operational-state {
104 type org-openroadm-common-state-types:state;
107 "Operational State: Actual state of service";
111 container notification-process-service {
113 "Model used to send a notification from a service request";
114 uses notification-process-service;
117 container notification-alarm-service {
119 "Model used to send a notification from the service listener";
120 uses notification-alarm-service;
123 rpc get-notifications-process-service {
124 description "Get the notifications service sent by ServiceHandler through filtering connection type";
126 leaf connection-type {
127 type org-openroadm-common-service-types:connection-type;
130 "Type connection of the service ";
136 "Unique ID for the consumer";
142 "ID Group for the consumer";
146 list notifications-process-service {
147 uses notification-process-service;
152 rpc get-notifications-alarm-service {
153 description "Get the notifications alarm service sent by ServiceListener through filtering connection type";
155 leaf connection-type {
156 type org-openroadm-common-service-types:connection-type;
159 "Type connection of the service";
165 "Unique ID for the consumer";
171 "ID Group for the consumer";
175 list notifications-alarm-service {
176 uses notification-alarm-service;
181 notification publish-notification-process-service {
182 description "Publish the notifications service through a publisher";
183 leaf publisher-name {
187 "Name of the publisher";
189 uses notification-process-service;
192 notification publish-notification-alarm-service {
193 description "Publish the notifications service alarm through a publisher";
194 leaf publisher-name {
198 "Name of the publisher";
200 uses notification-alarm-service;