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