3 namespace "urn:opnfv:params:xml:ns:yang:yes-fault";
6 import yang-based-event-stream {
9 "wiki.opnfv.org/display/ves/VES+goes+YES";
14 "wiki.opnfv.org/display/ves/VES+goes+YES";
19 "RFC 8632: A YANG Data Model for Alarm Management";
23 "Open Platform for NFV (OPNFV) - Virtual Event Streaming (VES) project";
25 "wiki.opnfv.org/display/ves";
27 "This module is inspired by VES 7.1.1 but uses YANG concepts and types to
28 describe the exchanged data format.
30 Copyright 2020 highstreet technologies GmbH and others.
32 Licensed under the Apache License, Version 2.0 (the 'License');
33 you may not use this file except in compliance with the License.
34 You may obtain a copy of the License at
36 http://www.apache.org/licenses/LICENSE-2.0
38 Unless required by applicable law or agreed to in writing, software
39 distributed under the License is distributed on an 'AS IS' BASIS,
40 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
41 See the License for the specific language governing permissions and
42 limitations under the License.";
48 "ONAP SDN-R: wiki.onap.org/display/DW/SDN-R
49 VES: wiki.opnfv.org/display/ves/VES+Home
50 docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/services/ves-http
51 YES: wiki.opnfv.org/display/ves/VES+goes+YES";
60 "Indicates, that the event body contains fault(s) related asynchronous
64 identity category-id {
66 "Base identity for the alarm category. A unique identification of the
69 This identity is abstract and MUST NOT be used for alarm categories.";
75 "The alarm is related to a license.";
81 "The alarm is related to hardware.";
87 "The alarm is related to telecommunication and/or infrastructure
94 "The alarm is related to packet routing.";
100 "The alarm is related to security.";
105 "The alarm is related to network signaling.";
111 typedef category-id {
116 "Identifies an alarm category. The description of the alarm category
117 identifier MUST indicate if the alarm category identifier is abstract
119 An abstract alarm category identifier is used as a base for other
120 alarm category ids and will not be used as a value for a category or
121 be present in the fault event.";
134 "The alarm condition reported by the network function.";
139 "The card, port, channel or interface name of the network function
140 generating the alarm:
142 TODO: Shouldn't this leaf be mandatory for alarm correlation?";
147 "Event category, for example: license, link, routing, security,
151 type al:severity-with-clear;
154 "The event severity.";
162 "Type of event source; examples: card, host, other, port,
163 portThreshold, router, slotThreshold, switch, virtualMachine,
164 virtualNetworkFunction.
166 TODO: Is this needed? or What is the difference to category?";
168 leaf specific-problem {
173 "A short description of the alarm or problem.";
175 leaf network-function-status {
179 "The network function is operational.";
183 "The network function is not operational.";
187 "The operational status of the network function.";
190 "An object class containing all fault specific parameters.";
194 * Augmentation of YES
196 augment "/yes:event-history/yes:event" {
197 when "derived-from-or-self(/yes:event-history/yes:event/yes:header/yes:domain, 'yf:fault')" {
199 "The event header must indicate 'fault'.";
201 if-feature yes:event-history;
205 "A list for fault objects.";
208 "Adds to YES the specifics of fault notifications.";
211 augment "/yes:yang-based-event-stream/yes:event" {
212 when "derived-from-or-self(/yes:yang-based-event-stream/yes:event/yes:header/yes:domain, 'yf:fault')" {
214 "The event header must indicate 'fault'.";
219 "A list for fault objects.";
222 "Adds to YES the specifics of fault notifications.";