Import OPNVF Yang based Event Stream
[scp/oam/modeling.git] / data-model / yang / published / opnfv / yes-pm-types-g826.yang
1 module yes-pm-types-g826 {
2
3     yang-version 1.1;
4     namespace "urn:opendaylight:params:xml:ns:yang:yes-pm-types-g826";
5     prefix ypmtg;
6
7     import yes-types {
8         prefix yt;
9         reference
10           "wiki.opnfv.org/display/ves/VES+goes+YES";
11     }
12
13     organization
14       "Open Platform for NFV (OPNFV) - Virtual Event Streaming (VES) project";
15     contact
16       "wiki.opnfv.org/display/ves";
17
18     description
19       "This module defines the performance measurement name identities
20        for yang based event streaming.
21
22        Copyright 2020 highstreet technologies GmbH and others.
23
24        Licensed under the Apache License, Version 2.0 (the 'License');
25        you may not use this file except in compliance with the License.
26        You may obtain a copy of the License at
27
28          http://www.apache.org/licenses/LICENSE-2.0
29
30        Unless required by applicable law or agreed to in writing, software
31        distributed under the License is distributed on an 'AS IS' BASIS,
32        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33        See the License for the specific language governing permissions and
34        limitations under the License.";
35
36     revision 2020-04-13 {
37         description
38           "Initial revision";
39         reference
40           "ITU T-REC-G.826 2002-12";
41     }
42
43     // --- typedef
44     identity performance-measurement-type-id {
45         base yt:performance-measurement-type-id;
46         description
47           "An abstract base performance measurement type which must not be
48            used as reference in data objects.";
49     }
50
51     identity errored-block {
52         base performance-measurement-type-id;
53         description
54           "errored block (EB):
55            A block in which one or more bits are in error.";
56     }
57
58     identity errored-second {
59         base performance-measurement-type-id;
60         description
61           "errored second (ES):
62            A one-second period with one or more errored blocks or at least
63            one defect.";
64     }
65
66     identity severely-errored-second {
67         base performance-measurement-type-id;
68         description
69           "severely errored second (SES):
70            A one-second period which contains ≥30% errored blocks or at least
71            one defect. SES is a subset of ES.";
72     }
73
74     identity errored-second-ratio {
75         base performance-measurement-type-id;
76         description
77           "errored second ratio (ESR):
78            The ratio of ES to total seconds in available time during a fixed
79            measurement interval. ";
80     }
81
82     identity severely-errored-second-ratio {
83         base performance-measurement-type-id;
84         description
85           "severely errored second ratio (SESR):
86            The ratio of SES to total seconds in available time during a fixed
87            measurement interval.";
88     }
89
90     identity background-block-error-ratio {
91         base performance-measurement-type-id;
92         description
93           "background block error ratio (BBER):
94            The ratio of Background Block Errors (BBE) to total blocks in
95            available time during a fixed measurement interval.";
96     }
97 }