3 namespace "urn:opnfv:params:xml:ns:yang:yes-types";
6 import ietf-yang-types {
9 "RFC 6991: Common YANG Data Types.";
13 "Open Platform for NFV (OPNFV) - Virtual Event Streaming (VES) project";
15 "wiki.opnfv.org/display/ves";
17 "This module contains common type definitions and groupings of the
18 yang-based-event-stream (YES). Such definitions could be used also outside of
21 Copyright 2020 highstreet technologies GmbH and others.
23 Licensed under the Apache License, Version 2.0 (the 'License');
24 you may not use this file except in compliance with the License.
25 You may obtain a copy of the License at
27 http://www.apache.org/licenses/LICENSE-2.0
29 Unless required by applicable law or agreed to in writing, software
30 distributed under the License is distributed on an 'AS IS' BASIS,
31 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
32 See the License for the specific language governing permissions and
33 limitations under the License.";
39 "ONAP SDN-R: wiki.onap.org/display/DW/SDN-R
40 VES: wiki.opnfv.org/display/ves/VES+Home
41 docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/services/ves-http
42 YES: wiki.opnfv.org/display/ves/VES+goes+YES";
51 "Base identity for the event domain. A unique identification of the
54 This identity is abstract and MUST NOT be used for domains.";
57 identity event-type-id {
59 "Base identity for the event type. A unique identification of the
62 This identity is abstract and MUST NOT be used for event types.";
65 identity application {
68 "Indicates that the event is raised by a software application.";
70 "https://en.wikipedia.org/wiki/Application_software";
73 identity micro-service {
76 "Indicates that the event is raised by a software micro-service.";
78 "https://en.wikipedia.org/wiki/Microservices";
81 identity guest-operating-system {
84 "Indicates that the event is raised by the operating system of a
85 guest virtual network function.";
88 identity host-operating-system {
91 "Indicates that the event is raised by the operating system of a
92 host system running virtual network functions.";
98 "Indicates that the event is raised by the cloud and/or data center
102 identity physical-network-function {
105 "Indicates that the event is raised by a physical network function.";
108 identity performance-measurement-type-id {
110 "Base identity for performance measurement types. A unique identification
111 of the performance measurement value, not including the resource.
112 Different resources can share performance measurement types. If the
113 resource reports the same performance measurement type, it is to be
114 considered to be the same performance measurement.
116 This identity is abstract and MUST NOT be used for performance
120 identity performance-measurement-unit-id {
122 "Base identity for performance measurement units.
124 This identity is abstract and MUST NOT be used for performance
129 base performance-measurement-unit-id;
135 base performance-measurement-unit-id;
137 "dBm is unit of level used to indicate that a power ratio is expressed in
138 decibels (dB) with reference to one milliwatt (mW).";
142 base performance-measurement-unit-id;
147 identity fahrenheit {
148 base performance-measurement-unit-id;
150 "°F: Grad Fahrenheit";
154 base performance-measurement-unit-id;
160 base performance-measurement-unit-id;
174 "Identifies an event domain. The description of the domain
175 identifier MUST indicate if the domain identifier is abstract or not.
176 An abstract domain identifier is used as a base for other domain ids
177 and will not be used as a value for a domain or be present in
181 typedef event-type-id {
186 "Identifies an event type. The description of the event type
187 MUST indicate if the event type is abstract or not.
188 An abstract event type is used as a base for other event types
189 and will not be used as a value for an event.";
192 typedef pm-value-type {
204 "Inspired and copied from OpenROADM. A generic type definition
205 for performance monitoring values.";
208 typedef performance-measurement-type-id {
210 base performance-measurement-type-id;
213 "Identifies an performance-measurement type. The description of the
214 performance measurement type id MUST indicate if the performance
215 measurement type is abstract or not. An abstract performance measurement
216 type is used as a base for other performance measurement type ids
217 and will not be used as a value for an performance measurement or be
218 present in the performance measurement inventory.";
221 typedef performance-measurement-unit-id {
223 base performance-measurement-unit-id;
226 "Identifies an performance-measurement unit. The description of the
227 performance measurement unit id MUST indicate if the performance
228 measurement unit is abstract or not. An abstract performance measurement
229 unit is used as a base for other performance measurement unit ids
230 and will not be used as a value for an performance measurement or be
231 present in the performance measurement inventory.";
238 "Indicates the highest priority of an event. This value SHOULD
239 be used only in very rare cases, where it must be ensured,
240 that the event SHOULD be processed immediately by-passing any
245 "This value SHOULD be used to indicate that the event SHOULD
246 be processed faster than default. ";
250 "The default value of a event priority.";
254 "Indicates that such event can be process, when the processing
259 "A non-extensible enumeration defining the different priority levels.
260 In case of resource constrainer and overload scenarios an event with
261 a higher priority SHOULD be handled first.";
266 type instance-identifier {
267 require-instance false;
269 type yang:object-identifier;
274 "This is an identification of the event emitting resource, such as an
275 interface. It should be as fine-grained as possible both to
276 guide the operator and to guarantee uniqueness of the event emitting
279 If the resource is modeled in YANG, this type will
280 be an instance-identifier.
282 If the resource is an SNMP object, the type will be an
285 If the resource is anything else, for example a distinguished
286 name or a CIM path, this type will be a string.
288 If the alarming object is identified by a UUID use the uuid
289 type. Be cautious when using this type, since a UUID is hard
290 to use for an operator.
292 If the server supports several models, the precedence should
293 be in the order as given in the union definition.";
295 "RRC 8632: Type Definition 'resource'";
302 grouping schema-grp {
309 "The (YANG-) schema namespace as as unique reference.";
316 "The (YANG-) module name.";
319 type yang:date-and-time;
321 "The revision date of the (YANG-) schema.";
324 "An object class to reference a (YANG-) schema.";