-
Notifications
You must be signed in to change notification settings - Fork 4
/
netgate-interface.yang
2762 lines (2358 loc) · 53.8 KB
/
netgate-interface.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 netgate-interface {
yang-version 1.1;
namespace "urn:netgate:xml:yang:netgate-interface";
prefix "ngif";
import ietf-inet-types {
prefix "inet";
}
import ietf-yang-types {
prefix "yang";
}
import netgate-cli-extensions {
prefix "ngcliext";
}
import netgate-common {
prefix "ngcom";
}
import netgate-nat {
prefix "ngnat";
}
organization "Netgate";
contact "Web: <http://www.netgate.com>";
description
"This YANG module provides a data model for network interfaces.
Copyright 2017-2024 Rubicon Communications, LLC.
";
revision 2024-10-01 {
description
"TNSR Release 24.10.";
}
revision 2024-06-02 {
description
"TNSR Release 24.06.";
}
revision 2023-11-01 {
description
"TNSR Release 23.11.";
}
revision 2023-06-01 {
description
"TNSR Release 23.06.";
}
revision 2023-02-01 {
description
"TNSR Release 23.02.";
}
revision 2022-10-15 {
description
"TNSR Release 22.10.";
}
revision 2022-06-15 {
description
"TNSR Release 22.06.";
}
revision 2022-02-15 {
description
"TNSR Release 22.02.";
}
revision 2021-11-15 {
description
"TNSR Release 21.11.";
}
revision 2021-06-15 {
description
"TNSR Release 21.07.";
}
revision 2021-02-15 {
description
"TNSR Release 21.02.";
}
revision 2020-10-01 {
description
"TNSR Release 20.10.";
}
revision 2020-07-15 {
description
"TNSR Release 20.07.";
}
revision 2020-06-15 {
description
"TNSR Release 20.06.";
}
revision 2020-04-16 {
description
"Reorganized ACLs applied to an interface in state data.
Added sequence number, and used this for key";
}
revision 2020-02-26 {
description
"Added IPv4 MTU and IPv6 MTU data nodes.";
}
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-05-30 {
description
"TNSR Release 19.05.";
}
revision 2017-01-06 {
description
"Initial revision.";
}
typedef interface-ref {
type leafref {
path "/ngif:interfaces-config/ngif:interface/ngif:name";
}
description
"This type is used by data models that need to reference
interfaces.";
}
typedef loopback-name-63 {
type string {
pattern '[a-zA-Z_0-9][a-zA-Z0-9_/.-]*';
length "1..63";
}
}
typedef intf-vlan-id {
type union {
type uint16 {
range "1..4095";
}
type string {
pattern "any";
}
}
}
typedef intf-tag-rewrite-op {
type enumeration {
enum disable {
description
"IPv4";
}
enum pop-1 {
description
"Pop 1";
}
enum pop-2 {
description
"Pop 2";
}
enum push-1 {
description
"Push 1";
}
enum push-2 {
description
"Push 2";
}
enum translate-1-1 {
description
"Translate 1 1";
}
enum translate-1-2 {
description
"Translate 1 2";
}
enum translate-2-1 {
description
"Translate 2 1";
}
enum translate-2-2 {
description
"Translate 2 2";
}
}
}
typedef bond-mode {
type enumeration {
enum round-robin {
value 1;
description
"Round robin";
}
enum active-backup {
value 2;
description
"Active backup";
}
enum xor {
value 3;
description
"XOR";
}
enum broadcast {
value 4;
description
"Broadcast";
}
enum lacp {
value 5;
description
"LACP";
}
}
}
typedef bond-xor-lacp-load-balance {
type enumeration {
enum l2 {
value 0;
description
"L2";
}
enum l34 {
value 1;
description
"L34";
}
enum l23 {
value 2;
description
"L23";
}
}
}
typedef intf-rx-mode {
type enumeration {
enum polling {
description
"polling";
}
enum interrupt {
description
"interrupt";
}
enum adaptive {
description
"adaptive";
}
}
}
typedef bond-load-balance {
type enumeration {
enum l2 {
value 0;
description
"L2";
}
enum l34 {
value 1;
description
"L34";
}
enum l23 {
value 2;
description
"L23";
}
enum round-robin {
value 3;
description
"round-robin";
}
enum broadcast {
value 4;
description
"broadcast";
}
enum active-backup {
value 5;
description
"active-backup";
}
}
}
typedef lacp-rx-state {
type enumeration {
enum INITIALIZE {
value 0;
description
"Initialize";
}
enum PORT_DISABLED {
value 1;
description
"Port disabled";
}
enum EXPIRED {
value 2;
description
"Expired";
}
enum LACP_DISABLED {
value 3;
description
"LACP disabled";
}
enum DEFAULTED {
value 4;
description
"Defaulted";
}
enum CURRENT {
value 5;
description
"Current";
}
}
}
typedef lacp-tx-state {
type enumeration {
enum TRANSMIT {
value 0;
description
"Transmit PDU";
}
}
}
typedef lacp-mux-state {
type enumeration {
enum DETACHED {
value 0;
description
"Detached";
}
enum WAITING {
value 1;
description
"Waiting";
}
enum ATTACHED {
value 2;
description
"Attached";
}
enum COLLECTING_DISTRIBUTING {
value 3;
description
"Collecting distributing";
}
}
}
typedef lacp-ptx-state {
type enumeration {
enum NO_PERIODIC {
value 0;
description
"No periodic";
}
enum FAST_PERIODIC {
value 1;
description
"Fast periodic";
}
enum SLOW_PERIODIC {
value 2;
description
"Slow periodic";
}
enum PERIODIC_TX {
value 3;
description
"Periodic transmission";
}
}
}
typedef ip-reassembly-type {
type enumeration {
enum full {
value 0;
description
"Full ip-reassembly";
}
enum virtual {
value 1;
description
"Shallow virtual ip-reassembly";
}
}
}
typedef mss-clamp-direction {
type enumeration {
enum Tx {
description
"The MSS clamp value applies to transmitted packets.";
}
enum Rx {
description
"The MSS clamp value applies to received packets.";
}
enum TxRx {
description
"The MSS clamp value applies to both transmitted and
received packets.";
}
}
}
rpc clear-interface-counters {
input {
leaf interface {
type string;
description
"Should be a valid interface name. No name implies
clear all interfaces.";
}
}
}
rpc packet-counters {
output {
leaf stdout {
type string;
}
}
}
container interfaces-config {
description
"Interface configuration parameters.";
list interface {
key "name";
ngcliext:context "intf-interfaces,intf-vrrp";
description
"The list of configured interfaces on the device.";
ngcliext:pre-children-op "push";
ngcliext:node-fmt "interface @{name}$n";
leaf name {
type string;
description
"The name of the interface.";
}
leaf description {
type ngcom:description-63;
description
"A textual description of the interface.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^$% @@$n";
}
leaf enabled {
type boolean;
description
"This leaf contains the configured, desired state of
the interface.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^disable$n|^enable$n";
ngcliext:node-op "bool";
}
leaf mtu {
type uint16 {
range "0 | 68..max";
}
units octets;
description
"The size, in octets, of the largest packet that the
interface will send and receive.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^$% @@$n";
}
leaf nat-interface {
type ngnat:nat-side;
description
"NAT role.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^ip nat @@$n";
}
leaf mac-address {
type yang:mac-address;
description
"The Media Access Control (MAC) address of the
interface.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^$% @@$n";
}
leaf host-tap-name {
type string;
description
"If this interface is associated with a host tap,
this field names that host tap interface.";
}
leaf rx-mode {
type ngif:intf-rx-mode;
description
"Rx mode";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^$% @@$n";
}
leaf vrf {
type ngcom:rt-identifier-15;
description
"The name of the VRF this interface is bound to.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^$% @@$n";
}
container ipv4 {
description
"Parameters for the IPv4 address family.";
ngcliext:parent-fmt "^ip";
presence
"make container work the way code expects";
container address {
ngcliext:context "intf-interfaces";
ngcliext:parent-fmt "$< address";
leaf-list ip {
type inet:ipv4-prefix;
description
"An IPv4 address on the interface.";
ngcliext:node-fmt "$< @@$n";
}
}
container reassembly {
description
"ip-reassembly feature control.";
ngcliext:context "intf-interfaces";
ngcliext:parent-fmt "$< reassembly";
presence
"make container work the way code expects";
leaf enabled {
type boolean;
description
"IPv4 reassembly enabled for interface";
ngcliext:node-op "bool";
ngcliext:node-fmt "|$< enable$n";
}
leaf reassembly-type {
type ip-reassembly-type;
default full;
description
"Type of ip-reassembly on interface";
ngcliext:node-fmt "$< type @@$n";
}
}
leaf mtu {
type uint16 {
range "0 | 68..max";
}
units "octets";
description
"The size, in octets, of the largest IPv4 packet that
the interface will send and receive.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "$< $% @@$n";
}
container tcp {
description
"IPv4 TCP configuration values.";
ngcliext:context "intf-interfaces";
ngcliext:parent-fmt "$< tcp";
container mss {
description
"IPv4 TCP Maximum Segment Size values.";
ngcliext:node-fmt "$< $% @{value} @{directions}$n";
leaf value {
type uint16;
units "octets";
must '../directions != ""' {
error-message
"Both 'directions' and 'value' must
be set.";
}
description
"The IPv4 TCP maximum segment size.";
}
leaf directions {
type mss-clamp-direction;
must '../value != ""' {
error-message
"Both 'direction' and 'value' must
be set.";
}
description
"The directions to which the MSS applies.";
}
}
}
}
container ipv6 {
description
"Parameters for the IPv6 address family.";
ngcliext:parent-fmt "^ipv6";
presence
"make container work the way code expects";
container address {
ngcliext:context "intf-interfaces";
ngcliext:parent-fmt "$< address";
leaf-list ip {
type inet:ipv6-prefix;
description
"An IPv6 address on the interface.";
ngcliext:node-fmt "$< @@$n";
}
}
container reassembly {
description
"ip-reassembly feature control.";
ngcliext:context "intf-interfaces";
ngcliext:parent-fmt "$< reassembly";
presence
"make container work the way the code expects";
leaf enabled {
type boolean;
description
"IPv6 reassembly enabled for interface";
ngcliext:node-op "bool";
ngcliext:node-fmt "|$< enable$n";
}
leaf reassembly-type {
type ip-reassembly-type;
default full;
description
"Type of ip-reassembly on interface";
ngcliext:node-fmt "$< type @@$n";
}
}
leaf mtu {
type uint32 {
range "1280..max";
}
units "octets";
description
"The size, in octets, of the largest IPv6 packet that
the interface will send and receive.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "$< $% @@$n";
}
container tcp {
description
"IPv6 TCP configuration values.";
ngcliext:context "intf-interfaces";
ngcliext:parent-fmt "$< tcp";
container mss {
description
"IPv6 TCP Maximum Segment Size values.";
ngcliext:node-fmt "$< $% @{value} @{directions}$n";
leaf value {
type uint16;
units "octets";
must '../directions != ""' {
error-message
"Both 'directions' and 'value' must
be set.";
}
description
"The IPv4 TCP maximum segment size.";
}
leaf directions {
type mss-clamp-direction;
must '../value != ""' {
error-message
"Both 'direction' and 'value' must
be set.";
}
description
"The directions to which the MSS applies.";
}
}
}
}
container bridge {
presence
"indicates this interface is part of a bridge";
description
"If the interface is being used as a bridge, this
node contains the corresponding Bridge Domain Id,
Split Horizon, and/or Bridge Virtual Id information.";
ngcliext:context "intf-interfaces";
leaf bdi {
type uint32;
description
"Bridge Domain Id.";
ngcliext:node-fmt "^bridge domain @@%{bvi}%{shg}$n";
}
leaf bvi {
type boolean;
description
"Set up the interface as a BVI.";
ngcliext:sibling-op "bool";
ngcliext:sibling-fmt "| $%";
}
leaf shg {
type uint8;
description
"Split Horizon Group.";
ngcliext:sibling-fmt " $% @@";
}
}
container dhcp-client {
presence
"indicates that this interface has a DHCP client";
description
"If the interface is configured using a DHCP client,
that configuration is contained here.";
ngcliext:context "intf-interfaces";
ngcliext:node-fmt "^dhcp client ipv4";
ngcliext:post-node-fmt "$n";
leaf enable {
type boolean;
default false;
}
leaf hostname {
type string {
/*
* RFC-1123, RFC-2181.
*/
pattern '[a-zA-Z0-9]([-a-zA-Z0-9]){0,62}';
}
description
"An optional hostname to use.";
ngcliext:node-fmt " $% @@";
}
}
container access-list {
presence
"Indicates that this interface has ACLs";
description
"If the interface has any Access Control Lists,
they are listed here in two groups: those that apply
to packet ingress and those that apply to egresss.
The two sets of ACLs are sorted independenty and
applied in ascending sequence-number order.";
ngcliext:context "intf-interfaces";
container input {
description
"These are the ACL rule-sets that apply to ingress
packets.";
list acl-list {
key "acl-name";
description
"Each ACL rule-set can appear at most once within
the input list.";
ngcliext:node-fmt "^access-list input acl @{acl-name} sequence @{sequence}$n";
leaf acl-name {
type string;
description
"This is the name of an ACL rule-set
that will be be applied to packets on
this interface.";
}
leaf sequence {
type uint32;
description
"Set the ordering of the ACLs. Rules are
applied in ascending sequence number.";
}
}
}
container output {
description
"These are the ACL rule-sets that apply to egress
packets.";
list acl-list {
key "acl-name";
description
"Each ACL rule-set can appear at most once within
the output list.";
ngcliext:node-fmt "^access-list output acl @{acl-name} sequence @{sequence}$n";
leaf acl-name {
type string;
description
"This is the name of an ACL rule-set
that will be be applied to packets on
this interface.";
}
leaf sequence {
type uint32;
description
"Set the ordering of the ACLs. Rules are
applied in ascending sequence number.";
}
}
}
container macip {
description
"An interface may also have at most one ACL
based upon a combination of MAC address and
IP. If that ACL is present, it is always on
the ingress packets.";
ngcliext:node-fmt "^access-list macip @{macip-name}$n";
leaf macip-name {
type leafref {
path "/ngmacip:macip-config"
+ "/ngmacip:macip-table"
+ "/ngmacip:macip-list"
+ "/ngmacip:macip-name";
}
description
"This name references at most one MACIP ingress
rule-set from the ACL MACIP tables.";
}
}
}
leaf collect-detailed-stats {
type boolean;
description
"enable detailed counter keeping in VPP";
ngcliext:context "intf-interfaces";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^detailed-stats enable$n";
}
container lldp {
presence
"Indicates this interface has LLDP configured";
ngcliext:context "intf-interfaces";
leaf port-name {
type string;
description
"Port name used in LLDP packet.";
ngcliext:node-fmt "^lldp port-name @@$n";
}
container management {
leaf ipv4-address {
type inet:ipv4-address-no-zone;
description
"IPv4 management address.";
ngcliext:node-fmt "^lldp management ipv4 @@$n";
}
leaf ipv6-address {
type inet:ipv6-address-no-zone;
description
"IPv6 management address.";
ngcliext:node-fmt "^lldp management ipv6 @@$n";
}
leaf oid {
type ngcom:object-id-128;
description
"Management object ID.";
ngcliext:node-fmt "^lldp management oid @@$n";
}
}
}
container bond {
presence
"indicates this interface is a slave of a bonded interface";
description
"If the interface is being used as a slave, this node
contains the corresponding bond ID and slave options.";
ngcliext:context "intf-interfaces";
leaf instance {
type uint32;
description
"Bond unique identifier.";
ngcliext:node-fmt "^bond @@%{long-timeout}%{passive}$n";
}
leaf passive {
type boolean;
default false;
description
"The slave interface does not
initiate the LACP protocol,
remote must be active speaker.";
ngcliext:sibling-op "bool";
ngcliext:sibling-fmt "| $%";
}
leaf long-timeout {
type boolean;
default false;
description
"90 seconds VS default 3 seconds
neighbor timeout.";
ngcliext:sibling-op "bool";
ngcliext:sibling-fmt "| $%";
}
}
container map {
presence
"this interface perform MAP translations";
description
"Per-interface parameters for MAP-E and MAP-T.";
ngcliext:context "intf-interfaces";
leaf enabled {
type boolean;
description