/
bbf-yang-types.yang
311 lines (275 loc) · 9.62 KB
/
bbf-yang-types.yang
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
module bbf-yang-types {
yang-version 1.1;
namespace "urn:bbf:yang:bbf-yang-types";
prefix bbf-yang;
organization
"Broadband Forum <https://www.broadband-forum.org>
Common YANG Work Area";
contact
"Comments or questions about this Broadband Forum YANG module
should be directed to <mailto:help@broadband-forum.org>.
Editor: Nick Hancock, Adtran
Editor: Ludwig Pauwels, Nokia
PS Leader: Joey Boyd, Adtran
WA Director: Joey Boyd, Adtran
WA Director: Sven Ooghe, Nokia";
description
"This module contains a collection of YANG definitions for
supporting the Broadband Forum requirements on reusable data
types as applicable to access network equipment. As such, this
module is specific to access network equipment (e.g.,
BBF-specified Access Nodes and FTTdp DPUs).
Specifically, this module defines common types used throughout
BBF data models.
Copyright (c) 2017-2023, Broadband Forum
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only.
Please reference the Forum IPR Policy for patent licensing terms
<https://www.broadband-forum.org/ipr-policy>.
Any moral rights which are necessary to exercise under the above
license grant are also deemed granted under this license.
This version of this YANG module is part of TR-383a6; see
the TR itself for full legal notices.";
revision 2023-03-07 {
description
"Amendment 6.
* Approval Date: 2023-03-07.
* Publication Date: 2023-03-07.";
reference
"TR-383a6: Common YANG Modules
<https://www.broadband-forum.org/technical/download/
TR-383_Amendment-6.pdf>";
}
revision 2022-03-01 {
description
"Amendment 5.
* Approval Date: 2022-03-01.
* Publication Date: 2022-03-01.";
reference
"TR-383a5: Common YANG Modules
<https://www.broadband-forum.org/technical/download/
TR-383_Amendment-5.pdf>";
}
revision 2021-06-02 {
description
"Amendment 4.
* Approval Date: 2021-06-02.
* Publication Date: 2021-06-02.";
reference
"TR-383a4: Common YANG Modules
<https://www.broadband-forum.org/technical/download/
TR-383_Amendment-4.pdf>";
}
revision 2020-10-13 {
description
"Amendment 3.
* Approval Date: 2020-10-13.
* Publication Date: 2020-10-13.";
reference
"TR-383a3: Common YANG Modules
<https://www.broadband-forum.org/technical/download/
TR-383_Amendment-3.pdf>";
}
revision 2019-10-21 {
description
"Amendment 2 Corrigendum 1.
* Approval Date: 2019-10-21.
* Publication Date: 2019-10-21.";
reference
"TR-383a2c1: Common YANG Modules
<https://www.broadband-forum.org/technical/download/
TR-383_Amendment-2.pdf>";
}
revision 2018-07-13 {
description
"Amendment 1.
* Approval Date: 2018-06-04.
* Publication Date: see revision date above.";
reference
"TR-383: Common YANG Modules
<https://www.broadband-forum.org/technical/download/
TR-383_Amendment-1.pdf>";
}
revision 2017-05-08 {
description
"Initial revision.
* Approval Date: see revision date above.
* Publication Date: 2017-06-02.";
reference
"TR-383: Common YANG Modules
<https://www.broadband-forum.org/technical/download/
TR-383.pdf>";
}
revision 2016-07-18 {
description
"Initial revision.
* Approval Date: see revision date above.
* Publication Date: 2016-08-05.";
reference
"TR-355: YANG Modules for FTTdp Management
<https://www.broadband-forum.org/technical/download/
TR-355.pdf>";
}
typedef name-string {
type string {
length "1..64";
}
description
"Used where a string is needed which has a maximum length of
64 characters and a minimum length of 1 character.";
}
typedef percent {
type uint8 {
range "0..100";
}
units "percent";
description
"A percentage.";
}
typedef performance-counter32 {
type uint32;
description
"The 'performance-counter32' type represents a non-negative
integer that monotonically increases until it reaches a maximum
value of 2^32-1 (4294967295 decimal), but does not wrap around
once the maximum value is reached.";
}
typedef performance-counter32-or-inactive {
type union {
type uint32;
type enumeration {
enum inactive {
description
"Indicates that this counter is not active.";
}
}
}
description
"The 'performance-counter32-or-inactive' type represents a
non-negative integer that monotonically increases until it
reaches a maximum value of 2^32-1 (4294967295 decimal), but
does not wrap around once the maximum value is reached.
A special value (enum inactive) indicates that this counter
is not active.";
}
typedef performance-counter64 {
type uint64;
description
"The 'performance-counter64' type represents a non-negative
integer that monotonically increases until it reaches a maximum
value of 2^64-1 (18446744073709551615 decimal), but does not
wrap around once the maximum value is reached.";
}
typedef string-ascii63-or-empty {
type string {
length "0..63";
pattern '[ -~]*';
// allows the 95 printable ASCII characters
}
description
"Used where a string is needed which has a maximum length of
63 characters and also allows for a null string (length = 0).
The character set is limited to the 95 printable ASCII
characters.";
}
typedef string-ascii64 {
type string {
length "1..64";
pattern '[ -~]*';
}
description
"Used where a string is represented using at least 1 and no more
than 64 ASCII characters.
The character set is limited to the 95 printable ASCII
characters.";
}
typedef string-ascii64-or-empty {
type string {
length "0..64";
pattern '[ -~]*';
}
description
"Used where a string is needed which has a maximum length of
64 characters and also allows for a null string (length = 0).
The character set is limited to the 95 printable ASCII
characters.";
}
typedef string-ascii128 {
type string {
length "1..128";
pattern '[ -~]*';
}
description
"Used where a string is represented using at least 1 and no more
than 128 ASCII characters.
The character set is limited to the 95 printable ASCII
characters.";
}
typedef string-ascii128-or-empty {
type string {
length "0..128";
pattern '[ -~]*';
}
description
"Used where a string is needed which has a maximum length of
128 characters and also allows for a null string (length = 0).
The character set is limited to the 95 printable ASCII
characters.";
}
typedef undetermined {
type enumeration {
enum undetermined {
description
"Indicates the value is not determined.";
}
}
description
"A type which defines an enumeration representing when
the value for an object is not determined. Often, this is
combined with other data via a union acting as a special value
to indicate the undetermined state.";
}
typedef data-rate32 {
type uint32;
units "kilobits per second";
description
"A type which represents the rate at which data is being
transferred.";
}
typedef data-rate32-or-undetermined {
type union {
type undetermined;
type data-rate32;
}
units "kilobits per second";
description
"A type which represents the rate at which data is being
transferred. A special value, 'undetermined', is used to
indicate the data rate is undetermined.";
}
}