]> git.proxmox.com Git - mirror_ifupdown2.git/blob - ifupdown2/man.rst/ifupdown-addons-interfaces.5.rst
Fixed new file addition breakage with 0b762139
[mirror_ifupdown2.git] / ifupdown2 / man.rst / ifupdown-addons-interfaces.5.rst
1 ==========================
2 ifupdown-addons-interfaces
3 ==========================
4 ---------------------------------------------------------
5 ifupdown2 addon modules interface configuration
6 ---------------------------------------------------------
7 :Author: roopa@cumulusnetworks.com
8 :Date: 2013-09-25
9 :Copyright: Copyright 2013 Cumulus Networks, Inc. All rights reserved.
10 :Version: 0.1
11 :Manual section: 5
12
13
14 DESCRIPTION
15 ===========
16 ifupdown2 addon modules add incremental functionality to
17 core ifupdown2 tool.
18
19 All installed addon modules are executed on every interface
20 listed in the interfaces file. Addon modules are installed under
21 /usr/share/ifupdownaddons. To see the list of active addon
22 modules, see ifaddon(8).
23
24 Addon modules add new attributes to the interfaces(5) file.
25 Below is a list of attribute options provided by each module.
26 These can be listed under each iface section in the interfaces(5)
27 file.
28
29
30 EXAMPLES
31 ========
32 Listed below are addon modules and their supported attributes.
33 The attributes if applicable go under the iface section in the
34 interfaces(5) file.
35
36 **ethtool**: ethtool configuration module for interfaces
37
38
39 **link-duplex**
40
41 **help**: set link duplex
42
43
44 **required**: False
45
46 **default**: half
47
48 **validvals**: half,full
49
50 **example**:
51 link-duplex full
52
53
54 **link-autoneg**
55
56 **help**: set autonegotiation
57
58
59 **required**: False
60
61 **default**: off
62
63 **validvals**: on,off
64
65 **example**:
66 link-autoneg on
67
68
69 **link-speed**
70
71 **help**: set link speed
72
73
74 **required**: False
75
76 **example**:
77 link-speed 1000
78
79
80
81 **bridge**: Bridge configuration module. Supports both vlan aware
82 and non vlan aware bridges. For the vlan aware bridge, the port sp
83 ecific attributes must be specified under the port. And for vlan u
84 naware bridge port specific attributes must be specified under the
85 bridge.
86
87
88 **bridge-vlan-aware**
89
90 **help**: vlan aware bridge. Setting this attribute to yes ena
91 bles vlan filtering on the bridge
92
93
94 **required**: False
95
96 **example**:
97 bridge-vlan-aware yes/no
98
99
100 **bridge-pathcosts**
101
102 **help**: bridge set port path costs
103
104
105 **required**: False
106
107 **default**: 100
108
109 **example**:
110 bridge-pathcosts swp1=100 swp2=100
111
112
113 **bridge-portprios**
114
115 **help**: bridge port prios
116
117
118 **required**: False
119
120 **default**: 32
121
122 **example**:
123 bridge-portprios swp1=32 swp2=32
124
125
126 **bridge-fd**
127
128 **help**: bridge forward delay
129
130
131 **required**: False
132
133 **default**: 15
134
135 **example**:
136 bridge-fd 15
137
138
139 **bridge-ageing**
140
141 **help**: bridge ageing
142
143
144 **required**: False
145
146 **default**: 300
147
148 **example**:
149 bridge-ageing 300
150
151
152 **bridge-hello**
153
154 **help**: bridge set hello time
155
156
157 **required**: False
158
159 **default**: 2
160
161 **example**:
162 bridge-hello 2
163
164
165 **bridge-gcint**
166
167 **help**: bridge garbage collection interval in secs
168
169
170 **required**: False
171
172 **default**: 4
173
174 **example**:
175 bridge-gcint 4
176
177
178 **bridge-mcquerier**
179
180 **help**: set multicast querier
181
182
183 **required**: False
184
185 **default**: 0
186
187 **example**:
188 bridge-mcquerier 0
189
190
191 **bridge-mclmc**
192
193 **help**: set multicast last member count
194
195
196 **required**: False
197
198 **default**: 2
199
200 **example**:
201 bridge-mclmc 2
202
203
204 **bridge-mcsqc**
205
206 **help**: set multicast startup query count
207
208
209 **required**: False
210
211 **default**: 2
212
213 **example**:
214 bridge-mcsqc 2
215
216
217 **bridge-mcrouter**
218
219 **help**: set multicast router
220
221
222 **required**: False
223
224 **default**: 1
225
226 **example**:
227 bridge-mcrouter 1
228
229
230 **bridge-stp**
231
232 **help**: bridge-stp yes/no
233
234
235 **required**: False
236
237 **default**: no
238
239 **validvals**: yes,on,off,no
240
241 **example**:
242 bridge-stp no
243
244
245 **bridge-pvid**
246
247 **help**: bridge port pvid. Must be specified under the bridge
248 port
249
250
251 **required**: False
252
253 **example**:
254 bridge-pvid 1
255
256
257 **bridge-mcsqi**
258
259 **help**: set multicast startup query interval (in secs)
260
261
262 **required**: False
263
264 **default**: 31
265
266 **example**:
267 bridge-mcsqi 31
268
269
270 **bridge-mcmi**
271
272 **help**: set multicast membership interval (in secs)
273
274
275 **required**: False
276
277 **default**: 260
278
279 **example**:
280 bridge-mcmi 260
281
282
283 **bridge-mclmi**
284
285 **help**: set multicast last member interval (in secs)
286
287
288 **required**: False
289
290 **default**: 1
291
292 **example**:
293 bridge-mclmi 1
294
295
296 **bridge-vids**
297
298 **help**: bridge port vids. Can be specified under the bridge
299 or under the port. If specified under the bridge the ports inh
300 erit it unless overridden by a bridge-vids attribuet under the
301 port
302
303
304 **required**: False
305
306 **example**:
307 bridge-vids 4000
308
309 bridge-vids 2000 2200-3000
310
311
312 **bridge-ports**
313
314 **help**: bridge ports
315
316
317 **required**: True
318
319 **example**:
320 bridge-ports swp1.100 swp2.100 swp3.100
321
322 bridge-ports glob swp1-3.100
323
324 bridge-ports regex (swp[1|2|3].100)
325
326
327 **bridge-mcqifaddr**
328
329 **help**: set multicast query to use ifaddr
330
331
332 **required**: False
333
334 **default**: 0
335
336 **example**:
337 bridge-mcqifaddr 0
338
339
340 **bridge-waitport**
341
342 **help**: wait for a max of time secs for the specified ports
343 to become available,if no ports are specified then those speci
344 fied on bridge-ports will be used here. Specifying no ports he
345 re should not be used if we are using regex or "all" on bridge
346 _ports,as it wouldnt work.
347
348
349 **required**: False
350
351 **default**: 0
352
353 **example**:
354 bridge-waitport 4 swp1 swp2
355
356
357 **bridge-mcqri**
358
359 **help**: set multicast query response interval (in secs)
360
361
362 **required**: False
363
364 **default**: 10
365
366 **example**:
367 bridge-mcqri 10
368
369
370 **bridge-hashel**
371
372 **help**: set hash elasticity
373
374
375 **required**: False
376
377 **default**: 4096
378
379 **example**:
380 bridge-hashel 4096
381
382
383 **bridge-mcqpi**
384
385 **help**: set multicast querier interval (in secs)
386
387
388 **required**: False
389
390 **default**: 255
391
392 **example**:
393 bridge-mcqpi 255
394
395
396 **bridge-hashmax**
397
398 **help**: set hash max
399
400
401 **required**: False
402
403 **default**: 4096
404
405 **example**:
406 bridge-hashmax 4096
407
408
409 **bridge-bridgeprio**
410
411 **help**: bridge priority
412
413
414 **required**: False
415
416 **default**: 32768
417
418 **example**:
419 bridge-bridgeprio 32768
420
421
422 **bridge-maxage**
423
424 **help**: bridge set maxage
425
426
427 **required**: False
428
429 **default**: 20
430
431 **example**:
432 bridge-maxage 20
433
434
435 **bridge-mcsnoop**
436
437 **help**: set multicast snooping
438
439
440 **required**: False
441
442 **default**: 1
443
444 **example**:
445 bridge-mcsnoop 1
446
447
448 **bridge-access**
449
450 **help**: bridge port access vlan. Must be specified under the
451 bridge port
452
453
454 **required**: False
455
456 **example**:
457 bridge-access 300
458
459
460 **bridge-maxwait**
461
462 **help**: forces to time seconds the maximum time that the Deb
463 ian bridge setup scripts will wait for the bridge ports to ge
464 t to the forwarding status, doesn't allow factional part. If i
465 t is equal to 0 then no waiting is done
466
467
468 **required**: False
469
470 **default**: 0
471
472 **example**:
473 bridge-maxwait 3
474
475
476 **bridge-portmcrouter**
477
478 **help**: set port multicast routers
479
480
481 **required**: False
482
483 **default**: 1
484
485 **example**:
486 under the bridge: bridge-portmcrouter swp1=1 swp2=1
487
488 under the port: bridge-portmcrouter 1
489
490
491 **bridge-portmcfl**
492
493 **help**: port multicast fast leave.
494
495
496 **required**: False
497
498 **default**: 0
499
500 **example**:
501 under the bridge: bridge-portmcfl swp1=0 swp2=0
502
503 under the port: bridge-portmcfl 0
504
505
506 **bridge-mcqi**
507
508 **help**: set multicast query interval (in secs)
509
510
511 **required**: False
512
513 **default**: 125
514
515 **example**:
516 bridge-mcqi 125
517
518
519
520 **usercmds**: user commands for interfaces
521
522
523 **down**
524
525 **help**: run command at interface down
526
527
528 **required**: False
529
530 **post-up**
531
532 **help**: run command after interface bring up
533
534
535 **required**: False
536
537 **up**
538
539 **help**: run command at interface bring up
540
541
542 **required**: False
543
544 **pre-down**
545
546 **help**: run command before bringing the interface down
547
548
549 **required**: False
550
551 **pre-up**
552
553 **help**: run command before bringing the interface up
554
555
556 **required**: False
557
558 **post-down**
559
560 **help**: run command after bringing interface down
561
562
563 **required**: False
564
565
566 **mstpctl**: mstp configuration module for bridges
567
568
569 **mstpctl-portadminedge**
570
571 **help**: enable/disable initial edge state of the port
572
573
574 **required**: False
575
576 **default**: no
577
578 **validvals**: yes,no
579
580 **example**:
581 mstpctl-portadminedge swp1=no swp2=no
582
583
584 **mstpctl-portbpdufilter**
585
586 **help**: enable/disable bpdu filter on a port. syntax varies
587 when defined under a bridge vs under a port
588
589
590 **required**: False
591
592 **default**: no
593
594 **validvals**: yes,no
595
596 **example**:
597 under a bridge: mstpctl-portbpdufilter swp1=no swp2=no
598
599 under a port: mstpctl-portbpdufilter yes
600
601
602 **mstpctl-fdelay**
603
604 **help**: set forwarding delay
605
606
607 **required**: False
608
609 **default**: 15
610
611 **example**:
612 mstpctl-fdelay 15
613
614
615 **mstpctl-portnetwork**
616
617 **help**: enable/disable bridge assurance capability for a por
618 t
619
620
621 **required**: False
622
623 **default**: no
624
625 **validvals**: yes,no
626
627 **example**:
628 mstpctl-portnetwork swp1=no swp2=no
629
630
631 **mstpctl-txholdcount**
632
633 **help**: bridge transmit holdcount
634
635
636 **required**: False
637
638 **default**: 6
639
640 **example**:
641 mstpctl-txholdcount 6
642
643
644 **mstpctl-forcevers**
645
646 **help**: bridge force stp version
647
648
649 **required**: False
650
651 **default**: rstp
652
653 **example**:
654 mstpctl-forcevers rstp
655
656
657 **mstpctl-portautoedge**
658
659 **help**: enable/disable auto transition to/from edge state of
660 the port
661
662
663 **required**: False
664
665 **default**: yes
666
667 **validvals**: yes,no
668
669 **example**:
670 mstpctl-portautoedge swp1=yes swp2=yes
671
672
673 **mstpctl-maxhops**
674
675 **help**: bridge max hops
676
677
678 **required**: False
679
680 **default**: 15
681
682 **example**:
683 mstpctl-maxhops 15
684
685
686 **mstpctl-treeprio**
687
688 **help**: tree priority
689
690
691 **required**: False
692
693 **default**: 32768
694
695 validrange: 0-65535
696
697 **example**:
698 mstpctl-treeprio 32768
699
700
701 **mstpctl-treeportprio**
702
703 **help**: port priority for MSTI instance
704
705
706 **required**: False
707
708 **default**: 128
709
710 validrange: 0-240
711
712 **example**:
713 mstpctl-treeportprio swp1=128 swp2=128
714
715
716 **mstpctl-portpathcost**
717
718 **help**: bridge port path cost
719
720
721 **required**: False
722
723 **default**: 0
724
725 **example**:
726 mstpctl-portpathcost swp1=0 swp2=1
727
728
729 **mstpctl-portrestrtcn**
730
731 **help**: enable/disable port ability to propagate received to
732 pology change notification of the port
733
734
735 **required**: False
736
737 **default**: no
738
739 **validvals**: yes,no
740
741 **example**:
742 mstpctl-portrestrtcn swp1=no swp2=no
743
744
745 **mstpctl-maxage**
746
747 **help**: max message age
748
749
750 **required**: False
751
752 **default**: 20
753
754 **example**:
755 mstpctl-maxage 20
756
757
758 **mstpctl-hello**
759
760 **help**: set hello time
761
762
763 **required**: False
764
765 **default**: 2
766
767 **example**:
768 mstpctl-hello 2
769
770
771 **mstpctl-portrestrrole**
772
773 **help**: enable/disable port ability to take root role of the
774 port
775
776
777 **required**: False
778
779 **default**: no
780
781 **validvals**: yes,no
782
783 **example**:
784 mstpctl-portrestrrole swp1=no swp2=no
785
786
787 **mstpctl-bpduguard**
788
789 **help**: enable/disable bpduguard
790
791
792 **required**: False
793
794 **default**: no
795
796 **validvals**: yes,no
797
798 **example**:
799 mstpctl-bpduguard swp1=no swp2=no
800
801
802 **mstpctl-ageing**
803
804 **help**: ageing time
805
806
807 **required**: False
808
809 **default**: 300
810
811 **example**:
812 mstpctl-ageing 300
813
814
815 **mstpctl-treeportcost**
816
817 **help**: port tree cost
818
819
820 **required**: False
821
822 **mstpctl-portp2p**
823
824 **help**: bridge port p2p detection mode
825
826
827 **required**: False
828
829 **default**: auto
830
831 **validvals**: yes,no,auto
832
833 **example**:
834 mstpctl-portp2p swp1=no swp2=no
835
836
837
838 **clagd**: This module generates the clagd defaults file.
839
840
841 **clagd-priority**
842
843 **help**: The priority of this clagd switch
844
845
846 **required**: False
847
848 **example**:
849 clagd-priority 30000
850
851
852 **clagd-backup-ip**
853
854 **help**: Backup IP address of the clagd peer
855
856
857 **required**: False
858
859 **example**:
860 clagd-backup-ip 192.1.1.1
861
862
863 **clagd-enable**
864
865 **help**: enable clagd
866
867
868 **required**: False
869
870 **validvals**: yes,no
871
872 **example**:
873 clagd-enable yes
874
875
876 **clag-id**
877
878 **help**: multi-chassis lag id
879
880
881 **required**: False
882
883 **default**: 0
884
885 validrange: 0-65535
886
887 **example**:
888 clag-id 1
889
890
891 **clagd-peer-ip**
892
893 **help**: The IP address of the clagd peer
894
895
896 **required**: True
897
898 **example**:
899 clagd-peer 10.10.10.2
900
901
902 **clagd-sys-mac**
903
904 **help**: The system ID of the CLAG pair
905
906
907 **required**: True
908
909 **example**:
910 clagd-sys-mac 44:38:39:ff:00:00
911
912
913 **clagd-args**
914
915 **help**: Additional command line arguments for clagd
916
917
918 **required**: False
919
920 **example**:
921 clagd-args --log /var/log/clagd.log
922
923 clagd-args --verbose --lacpPoll 10
924
925 clagd-args --debug 0x4
926
927
928
929 **vlan**: vlan module configures vlan interfaces.This module under
930 stands vlan interfaces with dot notations. eg swp1.100. Vlan inter
931 faces with any other names need to have raw device and vlan id att
932 ributes
933
934
935 **vlan-id**
936
937 **help**: vlan id
938
939
940 **required**: False
941
942 **vlan-raw-device**
943
944 **help**: vlan raw device
945
946
947 **required**: False
948
949
950 **bridgevlan**: bridgevlan module configures vlan attributes on a
951 vlan aware bridge. This module only understands vlan interface nam
952 e with dot notations. eg br0.100. where br0 is the vlan aware brid
953 ge this config is for
954
955
956 **bridge-igmp-querier-src**
957
958 **help**: bridge igmp querier src. Must be specified under the
959 vlan interface
960
961
962 **required**: False
963
964 **example**:
965 bridge-igmp-querier-src 172.16.101.1
966
967
968
969 **ifenslave**: bond configuration module
970
971
972 **bond-use-carrier**
973
974 **help**: bond use carrier
975
976
977 **required**: False
978
979 **default**: 1
980
981 **validvals**: 0,1
982
983 **example**:
984 bond-use-carrier 1
985
986
987 **bond-lacp-bypass-period**
988
989 **help**: grace period (seconds) for lacp bypass
990
991
992 **required**: False
993
994 **default**: 0
995
996 validrange: 0-900
997
998 **example**:
999 bond-lacp-bypass-period 100
1000
1001
1002 **bond-miimon**
1003
1004 **help**: bond miimon
1005
1006
1007 **required**: False
1008
1009 **default**: 0
1010
1011 validrange: 0-255
1012
1013 **example**:
1014 bond-miimon 0
1015
1016
1017 **bond-lacp-rate**
1018
1019 **help**: bond lacp rate
1020
1021
1022 **required**: False
1023
1024 **default**: 0
1025
1026 **validvals**: 0,1
1027
1028 **example**:
1029 bond-lacp-rate 0
1030
1031
1032 **bond-lacp-bypass-priority**
1033
1034 **help**: slave priority for lacp bypass
1035
1036
1037 **required**: False
1038
1039 **example**:
1040 bond-lacp-bypass-priority swp1=1 swp2=1 swp3=2
1041
1042
1043 **bond-min-links**
1044
1045 **help**: bond min links
1046
1047
1048 **required**: False
1049
1050 **default**: 0
1051
1052 **example**:
1053 bond-min-links 0
1054
1055
1056 **bond-slaves**
1057
1058 **help**: bond slaves
1059
1060
1061 **required**: True
1062
1063 **example**:
1064 bond-slaves swp1 swp2
1065
1066 bond-slaves glob swp1-2
1067
1068 bond-slaves regex (swp[1|2)
1069
1070
1071 **bond-lacp-bypass-allow**
1072
1073 **help**: allow lacp bypass
1074
1075
1076 **required**: False
1077
1078 **default**: 0
1079
1080 **validvals**: 0,1
1081
1082 **example**:
1083 bond-lacp-bypass-allow 0
1084
1085
1086 **bond-mode**
1087
1088 **help**: bond mode
1089
1090
1091 **required**: False
1092
1093 **default**: balance-rr
1094
1095 **validvals**: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb
1096
1097 **example**:
1098 bond-mode 802.3ad
1099
1100
1101 **bond-num-unsol-na**
1102
1103 **help**: bond slave devices
1104
1105
1106 **required**: False
1107
1108 **default**: 1
1109
1110 validrange: 0-255
1111
1112 **example**:
1113 bond-num-unsol-na 1
1114
1115
1116 **bond-ad-sys-priority**
1117
1118 **help**: 802.3ad system priority
1119
1120
1121 **required**: False
1122
1123 **default**: 65535
1124
1125 **example**:
1126 bond-ad-sys-priority 65535
1127
1128
1129 **bond-xmit-hash-policy**
1130
1131 **help**: bond slave devices
1132
1133
1134 **required**: False
1135
1136 **default**: layer2
1137
1138 **validvals**: layer2,layer3+4,layer2+3
1139
1140 **example**:
1141 bond-xmit-hash-policy layer2
1142
1143
1144 **bond-num-grat-arp**
1145
1146 **help**: bond use carrier
1147
1148
1149 **required**: False
1150
1151 **default**: 1
1152
1153 validrange: 0-255
1154
1155 **example**:
1156 bond-num-grat-arp 1
1157
1158
1159 **bond-ad-sys-mac-addr**
1160
1161 **help**: 802.3ad system mac address
1162
1163
1164 **required**: False
1165
1166 **default**: 00:00:00:00:00:00
1167
1168 **example**:
1169 bond-ad-sys-mac-addr 00:00:00:00:00:00
1170
1171
1172
1173 **address**: address configuration module for interfaces
1174
1175
1176 **broadcast**
1177
1178 **help**: broadcast address
1179
1180
1181 **required**: False
1182
1183 **example**:
1184 broadcast 10.0.1.255
1185
1186
1187 **hwaddress**
1188
1189 **help**: hw address
1190
1191
1192 **required**: False
1193
1194 **example**:
1195 hwaddress 44:38:39:00:27:b8
1196
1197
1198 **alias**
1199
1200 **help**: description/alias
1201
1202
1203 **required**: False
1204
1205 **example**:
1206 alias testnetwork
1207
1208
1209 **address**
1210
1211 **help**: ipv4 or ipv6 addresses
1212
1213
1214 **required**: False
1215
1216 **example**:
1217 address 10.0.12.3/24
1218
1219 address 2000:1000:1000:1000:3::5/128
1220
1221
1222 **scope**
1223
1224 **help**: scope
1225
1226
1227 **required**: False
1228
1229 **example**:
1230 scope host
1231
1232
1233 **address-purge**
1234
1235 **help**: purge existing addresses. By default any existing ip
1236 addresses on an interface are purged to match persistant addre
1237 sses in the interfaces file. Set this attribute to 'no'if you
1238 want to preserve existing addresses
1239
1240
1241 **required**: False
1242
1243 **default**: yes
1244
1245 **example**:
1246 address-purge yes/no
1247
1248
1249 **preferred-lifetime**
1250
1251 **help**: preferred lifetime
1252
1253
1254 **required**: False
1255
1256 **example**:
1257 preferred-lifetime forever
1258
1259 preferred-lifetime 10
1260
1261
1262 **gateway**
1263
1264 **help**: default gateway
1265
1266
1267 **required**: False
1268
1269 **example**:
1270 gateway 255.255.255.0
1271
1272
1273 **mtu**
1274
1275 **help**: interface mtu
1276
1277
1278 **required**: False
1279
1280 **default**: 1500
1281
1282 **example**:
1283 mtu 1600
1284
1285
1286
1287 **addressvirtual**: address module configures virtual addresses fo
1288 r interfaces. It creates a macvlan interface for every mac ip addr
1289 ess-virtual line
1290
1291
1292 **address-virtual**
1293
1294 **help**: bridge router virtual mac and ip
1295
1296
1297 **required**: False
1298
1299 **example**:
1300 address-virtual 00:11:22:33:44:01 11.0.1.254/24 11.0.1.254/24
1301
1302
1303
1304 **vxlan**: vxlan module configures vxlan interfaces.
1305
1306
1307 **vxlan-learning**
1308
1309 **help**: vxlan learning on/off
1310
1311
1312 **required**: False
1313
1314 **default**: on
1315
1316 **example**:
1317 vxlan-learning off
1318
1319
1320 **vxlan-id**
1321
1322 **help**: vxlan id
1323
1324
1325 **required**: True
1326
1327 **example**:
1328 vxlan-id 100
1329
1330
1331 **vxlan-remoteip**
1332
1333 **help**: vxlan remote ip
1334
1335
1336 **required**: False
1337
1338 **example**:
1339 vxlan-remoteip 172.16.22.127
1340
1341
1342 **vxlan-svcnodeip**
1343
1344 **help**: vxlan id
1345
1346
1347 **required**: False
1348
1349 **example**:
1350 vxlan-svcnodeip 172.16.22.125
1351
1352
1353 **vxlan-local-tunnelip**
1354
1355 **help**: vxlan local tunnel ip
1356
1357
1358 **required**: False
1359
1360 **example**:
1361 vxlan-local-tunnelip 172.16.20.103
1362
1363
1364
1365 SEE ALSO
1366 ========
1367 interfaces(5),
1368 ifup(8),
1369 ip(8),
1370 mstpctl(8),
1371 brctl(8),
1372 ethtool(8),
1373 clagctl(8)