1 module yang-based-event-stream {
3 namespace "urn:opnfv:params:xml:ns:yang:yang-based-event-stream";
9 "wiki.opnfv.org/display/ves/VES+goes+YES";
11 import ietf-yang-types {
14 "RFC 6991: Common YANG Data Types.";
18 "Open Platform for NFV (OPNFV) - Virtual Event Streaming (VES) project";
20 "wiki.opnfv.org/display/ves";
22 "This module is inspired by VES 7.1.1 but uses YANG concepts and types to
23 describe the exchanged data format.
25 Copyright 2020 highstreet technologies GmbH and others.
27 Licensed under the Apache License, Version 2.0 (the 'License');
28 you may not use this file except in compliance with the License.
29 You may obtain a copy of the License at
31 http://www.apache.org/licenses/LICENSE-2.0
33 Unless required by applicable law or agreed to in writing, software
34 distributed under the License is distributed on an 'AS IS' BASIS,
35 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36 See the License for the specific language governing permissions and
37 limitations under the License.";
43 "ONAP SDN-R: wiki.onap.org/display/DW/SDN-R
44 VES: wiki.opnfv.org/display/ves/VES+Home
45 docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/services/ves-http
46 YES: wiki.opnfv.org/display/ves/VES+goes+YES";
53 feature event-history {
55 "This feature means that the server supports local
56 storage (memory, flash, or disk) of send event
69 "The eventing domain associated with the event";
77 "The event key that is unique to the event source.";
83 "A unique event name. A names space ensures the uniqueness
84 between the data-models.";
87 type yt:event-type-id;
89 "Copy from VES description
90 'for example - applicationNf, guestOS, hostOS, platform.'
92 TODO: Open! How should this field by used and what is the
93 difference to 'yes:domain'? From the VES description it looks,
94 more like a VNF type than an event-type.";
97 type yang:date-and-time;
100 "The latest time aka epoch time associated with the event from any component.";
102 leaf nfc-naming-code {
107 "The network function component type, aligned with vfc naming
110 TODO: Add a reference to the VFC naming standard.";
112 leaf nf-naming-code {
117 "The network function type, aligned with network-function (NF)
120 TODO: Add a reference to the NF naming standard.";
123 case nf-vendor-private-enterprise-number {
127 "Network function vendor IANA private enterprise number.";
131 leaf nf-vendor-name {
134 "Network function vendor name according to IANA Private Enterprise Numbers";
138 "The network function vendor can be identified by its name or by its
139 IANA private enterprise number (PEN)";
141 "IANA Private Enterprise Numbers
142 http://www.iana.org/assignments/enterprise-numbers/enterprise-numbers";
148 "The event priority to control the processing of the event.";
150 leaf reporting-entity-id {
153 "The entity reporting the event, for example an OAM VM.";
155 leaf reporting-entity-name {
161 "The name of the entity reporting the event, for example, an EMS
162 name; may be the same as 'source-name'.";
168 "Ordering of events communicated by an event source instance or 0, if not needed.";
173 "UUID identifying the entity experiencing the event issue.";
179 "The name of the entity experiencing the event issue,";
182 type yang:date-and-time;
185 "The earliest time aka epoch time associated with the event from
189 "An object class containing common parameters to all types of
197 "This contains all the parameters which are common to all
201 "An object class defining the data structure of a single
202 event. An event is an asynchronous message send from the system to its
210 container event-history {
211 if-feature "event-history";
213 leaf maximum-number-of-entries {
219 "The maximum number of item in the event list supported by
224 "This contains the set of asynchronous messages.";
228 "The root container of an event log. ";
235 notification yang-based-event-stream {
237 "This notification contains list of events.";
240 "This contains the set of asynchronous messages.";