forked from FRRouting/frr
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfrr-zebra.yang
3010 lines (2698 loc) · 71.5 KB
/
frr-zebra.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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
module frr-zebra {
yang-version 1.1;
namespace "http://frrouting.org/yang/zebra";
prefix frr-zebra;
import ietf-yang-types {
prefix yang;
}
import ietf-inet-types {
prefix inet;
}
import frr-affinity-map {
prefix frr-affinity-map;
}
import frr-route-map {
prefix frr-route-map;
}
import frr-route-types {
prefix frr-route-types;
}
import ietf-routing-types {
prefix rt-types;
}
import frr-nexthop {
prefix frr-nh;
}
import frr-routing {
prefix frr-rt;
}
import frr-interface {
prefix frr-interface;
}
import frr-vrf {
prefix frr-vrf;
}
organization
"FRRouting";
contact
"FRR Users List: <mailto:frog@lists.frrouting.org>
FRR Development List: <mailto:dev@lists.frrouting.org>";
description
"This module defines a model for managing the FRR zebra daemon.
Copyright 2020 FRRouting
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.
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.";
revision 2019-06-01 {
description
"Initial revision.";
}
feature ipv6-router-advertisements {
description
"Support for IPv6 Router Advertisements.";
}
feature ptm-bfd {
description
"Using an external PTM daemon that implements BFD.";
}
typedef unix-timestamp {
type uint32;
units "seconds";
description
"An absolute time in seconds since the unix epoch.";
}
identity zebra-interface-type {
description
"zebra interface type.";
}
identity zif-other {
base zebra-interface-type;
description
"Zebra interface type other.";
}
identity zif-bridge {
base zebra-interface-type;
description
"Zebra interface type bridge.";
}
identity zif-vlan {
base zebra-interface-type;
description
"Zebra interface type vlan.";
}
identity zif-vxlan {
base zebra-interface-type;
description
"Zebra interface type vxlan.";
}
identity zif-vrf {
base zebra-interface-type;
description
"Zebra interface type vrf.";
}
identity zif-veth {
base zebra-interface-type;
description
"Zebra interface type veth.";
}
identity zif-bond {
base zebra-interface-type;
description
"Zebra interface type bond.";
}
identity zif-macvlan {
base zebra-interface-type;
description
"Zebra interface type macvlan.";
}
identity zif-gre {
base zebra-interface-type;
description
"Zebra interface type gre.";
}
/*
* Multicast RPF mode configurable type
*/
typedef mcast-rpf-lookup-mode {
type enumeration {
enum "none" {
value 0;
description
"No mode set.";
}
enum "mrib-only" {
value 1;
description
"Lookup in unicast RIB only.";
}
enum "urib-only" {
value 2;
description
"Lookup in multicast RIB only.";
}
enum "mrib-then-urib" {
value 3;
description
"Try multicast RIB first, fall back to unicast RIB.";
}
enum "lower-distance" {
value 4;
description
"Lookup both unicast and mcast, use entry with lower distance.";
}
enum "longer-prefix" {
value 5;
description
"Lookup both unicast and mcast, use entry with longer prefix.";
}
}
description
"Multicast RPF lookup behavior";
}
// End of ip6-route
/*
* VxLAN Network Identifier type
*/
typedef vni-id-type {
type uint32 {
range "0..16777215";
}
description
"A VxLAN network identifier value.";
}
typedef vni-vtep-flood-type {
type enumeration {
enum "head-end-repl" {
value 0;
description
"Head-end replication.";
}
enum "disabled" {
value 1;
description
"Flooding disabled.";
}
enum "pim-sm" {
value 2;
description
"Multicast PIM-SM.";
}
}
}
/*
* Common route data, shared by v4 and v6 routes.
*/
grouping route-common {
description
"Common information about a route.";
leaf distance {
type uint8;
description
"Admin distance based on routing protocol.";
}
leaf metric {
type uint32;
description
"Route metric value.";
}
leaf tag {
type uint32 {
range "1..4294967295";
}
description
"Route tag value.";
}
leaf selected {
type empty;
description
"Route is the selected or preferred route for the prefix.";
}
leaf installed {
type empty;
description
"Route is installed in the FIB.";
}
leaf failed {
type empty;
description
"Route installation in FIB has failed.";
}
leaf queued {
type empty;
description
"Route has a pending FIB operation that has not completed.";
}
leaf internal-flags {
type int32;
description
"Internal flags for the route.";
}
leaf internal-status {
type int32;
description
"Internal status for the route.";
}
leaf uptime {
type yang:date-and-time;
description
"Uptime for the route.";
}
uses frr-nh:frr-nexthop-group-operational;
}
// End of route-common
/*
* IPv4 Route object.
*/
grouping ip4-route {
description
"An IPv4 route.";
leaf prefix {
type inet:ipv4-prefix;
description
"IP address (in the form A.B.C.D) and prefix length,
separated by the slash (/) character. The range of
values for the prefix-length is 0 to 32.";
}
leaf protocol {
type frr-route-types:frr-route-types-v4;
description
"The protocol owning the route.";
}
uses route-common;
}
// End of ip4-route
/*
* IPv6 Route object.
*/
grouping ip6-route {
description
"An IPv6 route.";
leaf prefix {
type inet:ipv6-prefix;
description
"The route's IPv6 prefix.";
}
leaf protocol {
type frr-route-types:frr-route-types-v6;
description
"The protocol owning the route.";
}
uses route-common;
}
// End of ip6-route
/*
* Information about EVPN VNIs
*/
grouping vni-information {
choice type-choice {
case l2 {
leaf is-layer2 {
type empty;
description
"Information about an L2 VNI.";
}
leaf vtep-count {
type uint32;
description
"Number of VTEPs.";
}
}
case l3 {
leaf is-layer3 {
type empty;
description
"Information about an L3 VNI.";
}
}
}
leaf vni-id {
type vni-id-type;
description
"The VNI identifier.";
}
leaf vxlan-ifname {
type frr-interface:interface-ref;
description
"The VxLAN interface name.";
}
leaf mac-count {
type uint32;
description
"Number of valid MACs.";
}
leaf neighbor-count {
type uint32;
description
"Number of neighbors.";
}
leaf vrf {
type frr-vrf:vrf-ref;
description
"The tenant VRF.";
}
leaf local-vtep-addr {
type inet:ipv4-address;
description
"The local VTEP IP address.";
}
}
/*
* Detailed EVPN VNI information for L2.
*/
grouping vni-l2-detail {
leaf if-index {
type uint32;
description
"The VxLAN ifindex.";
}
leaf advertise-gw {
type empty;
description
"The gateway MAC-IP is being advertised.";
}
leaf mcast-group {
type rt-types:ipv4-multicast-group-address;
description
"The VNI multicast group for BUM traffic.";
}
list remote-vtep-list {
leaf remote-vtep {
type inet:ipv4-address;
description
"The remote VTEP IP address.";
}
leaf vtep-flood {
type vni-vtep-flood-type;
}
}
}
/*
* Detailed EVPN VNI information for L3.
*/
grouping vni-l3-detail {
leaf svi-interface {
type frr-interface:interface-ref;
description
"The SVI interface.";
}
leaf is-up {
type empty;
description
"The state is active.";
}
leaf prefix-only {
type empty;
description
"Prefix routes only";
}
leaf router-mac {
type yang:mac-address;
description
"The VNI Router MAC address.";
}
list vni-list {
description
"A list of the associated L2 VNIs.";
leaf vni-id {
type vni-id-type;
description
"An L2 VNI identifier.";
}
}
}
/*
* Debug options
*/
grouping zebra-debugs {
leaf debug-events {
type boolean;
description
"Debug ZAPI events.";
}
leaf debug-zapi-send {
type boolean;
description
"Debug ZAPI messages sent.";
}
leaf debug-zapi-recv {
type boolean;
description
"Debug ZAPI messages received.";
}
leaf debug-zapi-detail {
type boolean;
description
"Debug ZAPI details.";
}
leaf debug-kernel {
type boolean;
description
"Debug kernel events.";
}
leaf debug-kernel-msg-send {
type boolean;
description
"Debug kernel messages sent.";
}
leaf debug-kernel-msg-recv {
type boolean;
description
"Debug kernel messages received.";
}
leaf debug-rib {
type boolean;
description
"Debug RIB processing.";
}
leaf debug-rib-detail {
type boolean;
description
"Debug RIB processing details.";
}
leaf debug-fpm {
type boolean;
description
"Debug the FIB Push Interface subsystem.";
}
leaf debug-nht {
type boolean;
description
"Debug Nexthop-tracking.";
}
leaf debug-nht-detail {
type boolean;
description
"Debug Nexthop-tracking details.";
}
leaf debug-mpls {
type boolean;
description
"Debug MPLS.";
}
leaf debug-vxlan {
type boolean;
description
"Debug VxLAN.";
}
leaf debug-pw {
type boolean;
description
"Debug pseudowires.";
}
leaf debug-dplane {
type boolean;
description
"Debug the dataplane subsystem.";
}
leaf debug-dplane-detail {
type boolean;
description
"Debug dataplane subsystem details.";
}
leaf debug-mlag {
type boolean;
description
"Debug MLAG.";
}
}
grouping ribs {
container ribs {
config false;
description
"RIBs supported by FRR.";
list rib {
key "afi-safi-name table-id";
leaf afi-safi-name {
type identityref {
base frr-rt:afi-safi-type;
}
description
"AFI, SAFI name.";
}
leaf table-id {
type uint32;
default "254";
description
"Routing Table id (default id - 254).";
}
list route {
key "prefix";
leaf prefix {
type inet:ip-prefix;
description
"The route's prefix.";
}
list route-entry {
key "protocol";
leaf protocol {
type frr-route-types:frr-route-types;
description
"The protocol owning the route.";
}
leaf instance {
type uint16;
must "../protocol = \"ospf\"";
description
"Retrieve routes from a specific OSPF instance.";
}
uses route-common;
}
}
}
}
}
grouping vrf-vni-mapping {
description
"EVPN L3-VNI mapping corresponding to a VRF.";
leaf l3vni-id {
type vni-id-type;
description
"EVPN L3-VNI id to map to the VRF.";
}
leaf prefix-only {
type boolean;
default "false";
description
"EVPN asymmetric mode advertise prefix routes only.";
}
}
// End of zebra container
/*
* RPCs
*/
rpc get-route-information {
description
"Retrieve IPv4 or IPv6 unicast routes.";
input {
choice ip-type {
case v4 {
leaf ipv4 {
type empty;
mandatory true;
description
"Retrieve IPv4 routes.";
}
leaf prefix-v4 {
type inet:ipv4-prefix;
description
"Retrieve routes matching a specific prefix.";
}
leaf supernets-only {
type empty;
description
"Skip routes that are subnets of classful prefix sizes.";
}
}
case v6 {
leaf ipv6 {
type empty;
mandatory true;
description
"Retrieve IPv6 routes.";
}
leaf prefix-v6 {
type inet:ipv6-prefix;
description
"Retrieve routes matching a specific prefix.";
}
}
}
choice vrf-choice {
case single {
leaf vrf {
type frr-vrf:vrf-ref;
description
"Retrieve routes in a non-default vrf.";
}
}
case all {
leaf all-vrfs {
type empty;
description
"Retrieve routes from all vrfs.";
}
}
}
leaf fib-routes {
type empty;
description
"Retrieve FIB routes rather than RIB routes.";
}
leaf table-id {
type uint32 {
range "1..4294967295";
}
description
"Routing table id to retrieve.";
}
leaf protocol {
type frr-route-types:frr-route-types-v4;
description
"Retrieve routes from a specific protocol daemon.";
}
leaf ospf-instance {
type uint32 {
range "1..65535";
}
must "../protocol = \"ospf\"";
description
"Retrieve routes from a specific OSPF instance.";
}
choice detail {
case det {
leaf include-detail {
type empty;
description
"Include detailed information.";
}
}
case summ {
leaf summary {
type empty;
description
"Include summary information only.";
}
}
}
}
// End of input
output {
choice route-list {
case v4 {
container routes-v4 {
description
"IPv4 route information.";
list route {
uses ip4-route;
}
}
}
case v6 {
container routes-v6 {
description
"IPv6 route information.";
list route {
uses ip6-route;
}
}
}
}
}
// End of output
}
// End get-route-information
rpc get-v6-mroute-info {
description
"Retrieve IPv6 multicast routes.";
input {
choice vrf-choice {
case single {
leaf vrf {
type frr-vrf:vrf-ref;
description
"Retrieve routes in a non-default vrf.";
}
}
case all {
leaf all-vrfs {
type empty;
description
"Retrieve routes from all vrfs.";
}
}
}
}
output {
container routes {
description
"IPv6 mcast route information.";
list route {
uses ip6-route;
}
}
}
}
// End get-v6-mroute-info
rpc get-vrf-info {
description
"Retrieve VRF information; the default VRF is elided.";
// Note: no input clause.
output {
list vrf-list {
leaf name {
type frr-vrf:vrf-ref;
description
"The VRF name";
}
leaf is-user-config {
type empty;
description
"The VRF was configured by an admin.";
}
leaf vrf-id {
type uint32;
description
"The VRF id.";
}
choice vrf-type {
case inactive {
leaf is-inactive {
type empty;
description
"The VRF is inactive.";
}
}
case netns {
leaf netns-name {
type string;
description
"The net namespace name associated with the VRF.";
}
}
case table {
leaf table-id {
type uint32;
description
"The table-id associated with the VRF.";
}
}
}
}
}
}
// End get-vrf-info
rpc get-vrf-vni-info {
description
"Retrieve mappings between EVPN VNI and VRF.";
// Note: no input clause.
output {
list vrf-vni-list {
leaf vrf-name {
type frr-vrf:vrf-ref;
description
"The VRF name.";
}
leaf vni-id {
type vni-id-type;
description
"The EVPN VNI.";
}
leaf vxlan-if-name {
type frr-interface:interface-ref;
description
"The VxLAN interface name.";
}
leaf svi-if-name {
type frr-interface:interface-ref;
description
"The SVI interface name.";
}
leaf router-mac-addr {
type yang:mac-address;
description
"Router MAC address.";
}
leaf is-up {
type empty;
description
"The state is active.";
}
}
}
}
// End get-vrf-vni-info
rpc get-evpn-info {
description
"Retrieve global information about EVPN.";
// Note: No input clause.
output {
leaf l2vni-count {
type uint32;
description
"Number of L2 VNIs.";
}
leaf l3vni-count {
type uint32;
description
"Number of L3 VNIs.";
}
leaf advertise-gateway {
type empty;
description
"Advertise the gateway MAC-IP.";
}
leaf advertise-svi {
type empty;
description
"Advertise SVI MAC-IP.";
}
leaf dup-detect {
type empty;
description
"Duplicate address detection is enabled.";
}
leaf dad-max-moves {
type uint32;
description
"Maximum moves allowed before address is considered duplicate.";
}