-
Notifications
You must be signed in to change notification settings - Fork 4
/
netgate-bfd.yang
405 lines (346 loc) · 9.01 KB
/
netgate-bfd.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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
module netgate-bfd {
yang-version 1.1;
namespace "urn:netgate:xml:yang:netgate-bfd";
prefix "ngbfd";
import ietf-inet-types {
prefix "inet";
}
import netgate-cli-extensions {
prefix "ngcliext";
}
organization "Netgate";
contact "Web: <http://www.netgate.com>";
description
"This YANG module provides a Netgate-defined data-model
for Bidirectional Forwarding Detection (BFD) data.
Copyright 2017-2020 Rubicon Communications, LLC.
";
revision 2021-02-15 {
description
"TNSR Release 21.02.";
}
revision 2020-06-15 {
description
"TNSR Release 20.06.";
}
revision 2020-02-15 {
description
"TNSR Release 20.02.";
}
revision 2019-12-15 {
description
"TNSR Release 19.12.";
}
revision 2019-08-30 {
description
"TNSR Release 19.08.";
}
revision 2019-02-15 {
description
"TNSR Release 19.02.";
}
revision 2017-04-17 {
description
"Initial revision.";
}
typedef bfd-auth-key-type {
type enumeration {
enum keyed-sha1 {
description
"keyed-sha1";
}
enum meticulous-keyed-sha1 {
description
"meticulous-keyed-sha1";
}
}
}
typedef bfd-session-state-type {
type enumeration {
enum admin-down {
description
"admin_down";
}
enum down {
description
"down";
}
enum init {
description
"init";
}
enum up {
description
"up";
}
}
}
container "bfd-config" {
description
"The bfd-config node contains BFD keys and session.";
container key-table {
description
"This table contains BFD Conf Keys.";
list key-entry {
key "conf-key-id";
description
"BFD Conf Key Entry.";
ngcliext:node-fmt "bfd conf-key-id @{conf-key-id}$n";
ngcliext:pre-children-op "push";
leaf conf-key-id {
type uint32;
description
"This is the unique integer Id of the BFD key.";
}
leaf type {
type bfd-auth-key-type;
mandatory true;
description
"This is one of the supported key-types 'keyed-sha1',
or 'meticulous-keyed-sha1'. The other key types
from RFC-5880 are not supported.";
ngcliext:node-fmt "^authentication type @@$n";
}
leaf secret {
type string {
pattern '(([0-9a-fA-F]{2}){1,20})';
}
mandatory true;
description
"This is the hex encoded secret with maximum
length 20 bytes.";
ngcliext:node-fmt "^secret @@$n";
}
}
}
container bfd-table {
description
"Host BFD interface configuration table.";
list bfd-session {
key "name";
description
"Each session has its own unique name.";
ngcliext:node-fmt "bfd session @{name}$n";
ngcliext:pre-children-op "push";
leaf name {
type string;
mandatory true;
description
"This is the name of the BFD session.";
}
leaf interface {
type string;
mandatory true;
description
"The session's interface name.";
ngcliext:node-fmt "^$% @@$n";
}
leaf local-ip-address {
type inet:ip-address-no-zone;
mandatory true;
description
"The session's local IPv4 or IPv6 address.";
ngcliext:node-fmt "^local address @@$n";
}
leaf peer-ip-address {
type inet:ip-address-no-zone;
mandatory true;
description
"The session's peer IPv4 or IPv6 address.";
ngcliext:node-fmt "^peer address @@$n";
}
leaf desired-min-tx {
type uint32 {
range "1..4294967295";
}
mandatory true;
description
"This is the minimum interval, in
microseconds, that the local system would
like to use when transmitting BFD Control
packets, less any jitter applied. The value
zero is reserved.";
ngcliext:node-fmt "^$% @@$n";
}
leaf required-min-rx {
type uint32;
mandatory true;
description
"This is the minimum interval, in
microseconds, between received BFD Control
packets that this system is capable of
supporting, less any jitter applied by
the sender. If this value is zero, the
transmitting system does not want the remote
system to send any periodic BFD Control
packets.";
ngcliext:node-fmt "^$% @@$n";
}
leaf detect-multiplier {
type uint8 {
range "1..255";
}
mandatory true;
description
"The desired Detection Time multiplier for BFD
Control packets on the local system. This
variable MUST be a nonzero integer. This
value is (roughly speaking, due to jitter)
the number of packets that have to be missed
in a row to declare the session to be down.";
ngcliext:node-fmt "^$% @@$n";
}
leaf bfd-key-id {
type uint32;
description
"The BFD key.";
ngcliext:node-fmt "^$% @@$n";
}
leaf conf-key-id {
type uint32;
description
"The conf authentication key id.";
ngcliext:node-fmt "^$% @@$n";
}
leaf enable {
type boolean;
default true;
description
"If true, BFD is enabled on this interface.
This is defaulted to true because when VPP
creates a session, this is how it is created.";
ngcliext:node-fmt "^$% @@$n";
}
leaf delayed {
type boolean;
description
"If true, authentication begins when a packet
is received from the peer.";
ngcliext:node-fmt "^$% @@$n";
}
}
}
}
container "bfd-state" {
config "false";
description
"The bfd-config node contains BFD keys and session.";
container key-table {
description
"This table contains BFD Conf Keys.";
list key-entry {
key "conf-key-id";
description
"BFD Conf Key Entry.";
leaf conf-key-id {
type uint32;
description
"This is the unique integer Id of the BFD
configuration key.";
}
leaf type {
type bfd-auth-key-type;
description
"This is one of the supported key-types 'keyed-sha1',
or 'meticulous-keyed-sha1'. The other key types
from RFC-5880 are not supported.";
}
leaf use-count {
type uint8;
description
"The number of times this key is used.";
}
}
}
container bfd-table {
description
"Host BFD interface configuration table.";
list bfd-session {
key "session-number";
description
"Each session has its own unique name.";
leaf session-number {
type uint32;
description
"The session number.";
}
leaf session-name {
type string;
description
"session name";
}
leaf interface {
type string;
description
"interface name";
}
leaf local-ip-address {
type inet:ip-address-no-zone;
description
"The session's local IPv4 or IPv6 address.";
}
leaf peer-ip-address {
type inet:ip-address-no-zone;
description
"The session's peer IPv4 or IPv6 address.";
}
leaf state {
type bfd-session-state-type;
description
"The state of the session, 'admin_down', 'down',
'init', or 'up'";
}
leaf authenticated {
type boolean;
description
"If true, authentication is in use.";
}
leaf desired-min-tx {
type uint32 {
range "1..4294967295";
}
description
"This is the minimum interval, in
microseconds, that the local system would
like to use when transmitting BFD Control
packets, less any jitter applied. The value
zero is reserved.";
}
leaf required-min-rx {
type uint32;
description
"This is the minimum interval, in
microseconds, between received BFD Control
packets that this system is capable of
supporting, less any jitter applied by
the sender. If this value is zero, the
transmitting system does not want the remote
system to send any periodic BFD Control
packets.";
}
leaf detect-multiplier {
type uint8 {
range "1..255";
}
description
"The desired Detection Time multiplier for BFD
Control packets on the local system. This
variable MUST be a nonzero integer. This
value is (roughly speaking, due to jitter)
the number of packets that have to be missed
in a row to declare the session to be down.";
}
leaf bfd-key-id {
type uint32;
description
"The BFD key.";
}
leaf conf-key-id {
type uint32;
description
"The conf authentication key id.";
}
}
}
}
}