Académique Documents
Professionnel Documents
Culture Documents
VYATTA, INC.
Vyatta System
Command Reference
Vyatta
Suite 200
1301 Shoreway Road
Belmont, CA 94002
vyatta.com
Copyright
COPYRIGHT
Copyright 20052008 Vyatta, Inc. All rights reserved.
Vyatta reserves the right to make changes to software, hardware, and documentation without notice. For the most recent version of documentation,
visit the Vyatta web site at vyatta.com.
PROPRIETARY NOTICES
Vyatta is a trademark of Vyatta, Inc.
VMware, VMware ESX, and VMware server are trademarks of VMware, Inc.
All other trademarks are the property of their respective owners.
ISSUE DATE: August 2008
DOCUMENT REVISION. VC4.1 v03
RELEASED WITH: VC4.1.3
PART NO. A0-0099-10-0002
iii
Table of Contents
iv
Command Reference
Rel VC4.1 v. 03
Vyatta
Command Reference
Rel VC4.1 v. 03
Vyatta
vi
Command Reference
Rel VC4.1 v. 03
Vyatta
vii
Chapter 6 Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface . . . . . . . . . . . . . . . . 218
clear interfaces ethernet counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
clear interfaces loopback counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
interfaces ethernet <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
interfaces ethernet <ethx> address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
interfaces ethernet <ethx> description <descr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
interfaces ethernet <ethx> disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
interfaces ethernet <ethx> disable-link-detect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
interfaces ethernet <ethx> duplex <duplexity> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
interfaces ethernet <ethx> hw-id <mac-addr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
interfaces ethernet <ethx> mac <mac-addr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
interfaces ethernet <ethx> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
interfaces ethernet <ethx> smp_affinity <mask> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
interfaces ethernet <ethx> speed <speed> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
interfaces ethernet <ethx> vif <vlan-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
interfaces ethernet <ethx> vif <vlan-id> address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
interfaces ethernet <ethx> vif <vlan-id> description <descr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
interfaces ethernet <ethx> vif <vlan-id> disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
interfaces ethernet <ethx> vif <vlan-id> disable-link-detect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
interfaces loopback lo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
interfaces loopback lo address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
interfaces loopback lo description <descr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
show interfaces ethernet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
show interfaces ethernet detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
show interfaces ethernet <ethx> brief . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
show interfaces ethernet <ethx> identify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
show interfaces ethernet <ethx> physical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
show interfaces ethernet <ethx> queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
show interfaces ethernet <ethx> vif <vlan-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
show interfaces ethernet <ethx> vif <vlan-id> brief . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
show interfaces ethernet <ethx> vif <vlan-id> queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
show interfaces loopback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
show interfaces loopback detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
show interfaces loopback lo brief . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Command Reference
Rel VC4.1 v. 03
Vyatta
viii
Command Reference
Rel VC4.1 v. 03
Vyatta
ix
Command Reference
Rel VC4.1 v. 03
Vyatta
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> idle-timeout <timeout> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> name-server <param> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> password <password> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> qos-policy out <policy-name> . . . . . . . . . . . . . . . . . . . . . . . 476
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> service-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> user-id <user-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
interfaces ethernet <ethx> pppoe <num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
interfaces ethernet <ethx> pppoe <num> access-concentrator <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
interfaces ethernet <ethx> pppoe <num> connect-on-demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
interfaces ethernet <ethx> pppoe <num> default-route <param> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
interfaces ethernet <ethx> pppoe <num> idle-timeout <timeout> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
interfaces ethernet <ethx> pppoe <num> local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
interfaces ethernet <ethx> pppoe <num> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
interfaces ethernet <ethx> pppoe <num> name-server <param> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
interfaces ethernet <ethx> pppoe <num> password <password> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
interfaces ethernet <ethx> pppoe <num> qos-policy out <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
interfaces ethernet <ethx> pppoe <num> remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
interfaces ethernet <ethx> pppoe <num> service-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
interfaces ethernet <ethx> pppoe <num> user-id <user-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
set interface pppoe <num> down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
set interface pppoe <num> up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
show interfaces pppoe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Command Reference
Rel VC4.1 v. 03
Vyatta
xi
Command Reference
Rel VC4.1 v. 03
Vyatta
xii
Command Reference
Rel VC4.1 v. 03
Vyatta
xiii
Command Reference
Rel VC4.1 v. 03
Vyatta
xiv
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . 780
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . 782
interfaces ethernet <ethx> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
interfaces ethernet <ethx> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
interfaces ethernet <ethx> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
interfaces ethernet <ethx> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
interfaces ethernet <ethx> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
interfaces ethernet <ethx> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
interfaces ethernet <ethx> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
interfaces ethernet <ethx> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
interfaces ethernet <ethx> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
interfaces ethernet <ethx> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
interfaces ethernet <ethx> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
interfaces ethernet <ethx> pppoe <num> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
interfaces ethernet <ethx> pppoe <num> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
interfaces ethernet <ethx> pppoe <num> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
interfaces ethernet <ethx> pppoe <num> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
interfaces ethernet <ethx> pppoe <num> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
interfaces ethernet <ethx> pppoe <num> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
interfaces ethernet <ethx> pppoe <num> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
interfaces ethernet <ethx> pppoe <num> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
interfaces ethernet <ethx> pppoe <num> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
interfaces ethernet <ethx> pppoe <num> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 826
interfaces ethernet <ethx> pppoe <num> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
interfaces ethernet <ethx> vif <vlan-id> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
interfaces ethernet <ethx> vif <vlan-id> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
interfaces ethernet <ethx> vif <vlan-id> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
interfaces ethernet <ethx> vif <vlan-id> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
interfaces ethernet <ethx> vif <vlan-id> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
interfaces ethernet <ethx> vif <vlan-id> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
interfaces ethernet <ethx> vif <vlan-id> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
interfaces ethernet <ethx> vif <vlan-id> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
interfaces ethernet <ethx> vif <vlan-id> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
interfaces ethernet <ethx> vif <vlan-id> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
interfaces ethernet <ethx> vif <vlan-id> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
interfaces loopback lo ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
interfaces loopback lo ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
interfaces loopback lo ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
interfaces loopback lo ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
interfaces loopback lo ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
interfaces loopback lo ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
interfaces loopback lo ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
interfaces loopback lo ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
interfaces loopback lo ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Command Reference
Rel VC4.1 v. 03
Vyatta
xv
Command Reference
Rel VC4.1 v. 03
Vyatta
xvi
Command Reference
Rel VC4.1 v. 03
Vyatta
xvii
Command Reference
Rel VC4.1 v. 03
Vyatta
xvii
Command Reference
Rel VC4.1 v. 03
Vyatta
xix
Command Reference
Rel VC4.1 v. 03
Vyatta
xx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxi
Command Reference
Rel VC4.1 v. 03
Vyatta
xxii
Command Reference
Rel VC4.1 v. 03
Vyatta
xxii
Command Reference
Rel VC4.1 v. 03
Vyatta
xxi
Command Reference
Rel VC4.1 v. 03
Vyatta
xxv
xxv
Command Reference
Rel VC4.1 v. 03
Vyatta
xxv
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 746
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 748
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . 756
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . 591
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> access-concentrator <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> connect-on-demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> default-route <param> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> idle-timeout <timeout> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . 765
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 770
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 772
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . 780
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . 598
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> name-server <param> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> password <password> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> qos-policy out <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> service-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> user-id <user-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
interfaces bridge <brx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
interfaces bridge <brx> address <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
interfaces bridge <brx> aging <age> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
interfaces bridge <brx> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
interfaces bridge <brx> disable <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
interfaces bridge <brx> forwarding-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
interfaces bridge <brx> hello-time <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Command Reference
Rel VC4.1 v. 03
Vyatta
xxv
Command Reference
Rel VC4.1 v. 03
Vyatta
xxi
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
interfaces serial <wanx> frame-relay vif <dlci> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
interfaces serial <wanx> frame-relay vif <dlci> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 939
interfaces serial <wanx> frame-relay vif <dlci> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
interfaces serial <wanx> frame-relay vif <dlci> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
interfaces serial <wanx> frame-relay vif <dlci> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
interfaces serial <wanx> frame-relay vif <dlci> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
interfaces serial <wanx> frame-relay vif <dlci> pvc rx-inverse-arp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
interfaces serial <wanx> frame-relay vif <dlci> pvc tx-inverse-arp <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
interfaces serial <wanx> ppp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
interfaces serial <wanx> ppp authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
interfaces serial <wanx> ppp lcp-echo-failure <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
interfaces serial <wanx> ppp lcp-echo-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
interfaces serial <wanx> ppp logging <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
interfaces serial <wanx> ppp mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
interfaces serial <wanx> ppp mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
interfaces serial <wanx> ppp multilink <bundle> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
interfaces serial <wanx> ppp vif 1 address local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
interfaces serial <wanx> ppp vif 1 address prefix-length <prefix> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
interfaces serial <wanx> ppp vif 1 address remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
interfaces serial <wanx> ppp vif 1 description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
interfaces serial <wanx> ppp vif 1 ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
interfaces serial <wanx> ppp vif 1 ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
interfaces serial <wanx> ppp vif 1 ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
interfaces serial <wanx> ppp vif 1 ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
interfaces serial <wanx> ppp vif 1 ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
interfaces serial <wanx> ppp vif 1 ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
interfaces serial <wanx> ppp vif 1 ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
interfaces serial <wanx> ppp vif 1 ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
interfaces serial <wanx> ppp vif 1 ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
interfaces serial <wanx> ppp vif 1 ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
interfaces serial <wanx> ppp vif 1 ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
interfaces serial <wanx> ppp vif 1 ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
interfaces serial <wanx> ppp vif 1 ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
interfaces serial <wanx> ppp vif 1 ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
interfaces serial <wanx> qos-policy out <policy> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
interfaces serial <wanx> t1-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
interfaces serial <wanx> t1-options clock <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
interfaces serial <wanx> t1-options lbo <range> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
interfaces serial <wanx> t1-options mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
interfaces serial <wanx> t1-options mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
interfaces serial <wanx> t1-options timeslots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
interfaces serial <wanx> t3-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
interfaces serial <wanx> t3-options clock <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
interfaces serial <wanx> t3-options framing <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xxx
Command Reference
Rel VC4.1 v. 03
Vyatta
xl
Command Reference
Rel VC4.1 v. 03
Vyatta
xli
Command Reference
Rel VC4.1 v. 03
Vyatta
xlii
Command Reference
Rel VC4.1 v. 03
Vyatta
xliii
Command Reference
Rel VC4.1 v. 03
Vyatta
xliv
Use this list to help you locate examples youd like to try or look at.
Example 1-1 Entering configuration mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Example 2-1 commit: Committing configuration changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Example 2-2 configure: Entering configuration mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Example 2-3 delete: Deleting configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Example 2-4 discard: Discarding configuration changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Example 2-5 edit: Navigating in the configuration tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Example 2-6 Loading configuration from a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Example 2-7 run: Running an operational command in configuration mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Example 2-8 save: Saving configuration to a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Example 2-9 save: Saving configuration to a file on a TFTP server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Example 2-10 set: Adding a configuration node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Example 2-11 show: Displaying configuration information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Example 2-12 show configuration: Displaying the configuration tree in operational mode . . . . . . . . . . . . . . . . . . . . 45
Example 2-13 top: Navigating to the top of the configuration tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Example 2-14 up: Navigating up through the configuration tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Example 3-1 Upgrading Vyatta software with full-upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Example 3-2 init-floppy: Initializing a floppy diskette for saving configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Example 3-3 reboot: Rebooting the system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Example 3-4 Set the date and time directly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Example 3-5 Set the date and time using an NTP server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Example 3-6 show arp: Displaying the ARP cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Example 3-7 show date: Displaying the system date and time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Example 3-8 show files <directory>: Displaying file information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Example 3-9 show hardware cpu: Showing CPU information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Example 3-10 show hardware dmi: Showing DMI information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
xlv
Command Reference
Rel VC4.1 v. 03
Vyatta
xlvi
Example 6-12 show interfaces loopback lo: Displaying detailed loopback interface information. . . . . . . . . . . . . . . 272
Example 6-13 show interfaces loopback detail: Displaying detailed loopback interface statistics and information. . 273
Example 6-14 show interfaces loopback lo brief: Displaying loopback interface status. . . . . . . . . . . . . . . . . . . . . . 274
Example 7-1 clear interfaces serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Example 7-2 clear interfaces serial wan0 counters cisco-hdlc: Displaying the result of the clear command. . . . . . . 281
Example 7-3 show interfaces serial: Displaying serial interface information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Example 7-4 show interfaces serial wanx ppp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Example 7-5 show interfaces serial wanx trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Example 8-1 clear interfaces multilink: Clearing multilink statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Example 8-2 clear interfaces multilink: Clearing multilink statistics on one interface . . . . . . . . . . . . . . . . . . . . . . . . 400
Example 8-3 show interfaces multilink: Displaying summary multilink information . . . . . . . . . . . . . . . . . . . . . . . . . 427
Example 8-4 show interfaces multilink: Displaying detailed information for a multilink bundle . . . . . . . . . . . . . . . . 428
Example 9-1 show interfaces tunnel: Displaying tunnel configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Example 11-1 show ip forwarding: Displaying IP forwarding status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
Example 11-2 show ip route: Displaying routes in the RIB and FIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Example 11-3 show ip route <ipv4>: Displaying information about a specific address . . . . . . . . . . . . . . . . . . . . . . 519
Example 11-4 show ip route <ipv4net> longer-prefixes: Displaying routes with longer prefixes . . . . . . . . . . . . . . . 520
Example 11-5 show ip route cache: Displaying routes in the kernel route cache . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Example 11-6 show ip route cache <ipv4net>: Displaying information about a route in the kernel route cache . . . 522
Example 11-7 show ip route connected: Displaying connected routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Example 11-8 show ip route forward: Displaying routes in the FIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
Example 11-9 show ip route forward <ipv4net>: Displaying information for a route in the FIB . . . . . . . . . . . . . . . 525
Example 11-10 show ip route kernel: Displaying kernel routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Example 11-11 show ip route static: Displaying static routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Example 11-12 show ip route supernets-only: Displaying supernet routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Example 11-13 show table: Displaying the routing table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Example 14-1 show ip route rip: Displaying routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Example 14-2 show ip rip: Displaying RIP information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Example 15-1 show ip ospf: Displaying OSPF configuration information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
Example 15-2 show ip ospf border-router: Displaying OSPF border router information . . . . . . . . . . . . . . . . . . . . 1050
Example 15-3 show ip ospf database: Displaying general OSPF database information . . . . . . . . . . . . . . . . . . . . . 1052
Example 15-4 show ip ospf interface: Displaying OSPF configuration and status information . . . . . . . . . . . . . . . . 1053
Example 15-5 show ip ospf neighbor: Displaying OSPF neighbor information . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
Example 15-6 show ip ospf route: Displaying OSPF route information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
Command Reference
Rel VC4.1 v. 03
Vyatta
xlvi
Command Reference
Rel VC4.1 v. 03
Vyatta
xlvi
Preface
This guide explains how to use the Vyatta system router, and how to use Vyatta
system router commands in the command-line interface. It provides an overview
of the routers functionality, highlighting core concepts, and a detailed description
of each available command.
This preface provides information about using this guide. The following topics are
covered:
Intended Audience
Document Conventions
Vyatta Publications
Intended Audience
Intended Audience
This guide is intended for experienced system and network administrators. Depending on
the functionality to be used, readers should have specific knowledge in the following areas:
TCP/IP protocols
Routing protocols
Network administration
Network security
Command Reference
Chapter
Description
22
49
117
132
218
Rel VC4.1 v. 03
Page
Vyatta
xlix
Command Reference
275
398
430
455
513
530
564
571
688
1060
1276
1377
1445
1472
1495
1510
Rel VC4.1 v. 03
Vyatta
Document Conventions
1515
1529
1529
1533
Glossary of Acronyms
1537
Document Conventions
This guide contains advisory paragraphs and uses typographic conventions.
Advisory Paragraphs
This guide may use the following advisory paragraphs:
Warnings alert you to situations that may pose a threat to personal safety, as in the
following example:
WARNING Risk of injury. Switch off power at the main breaker before attempting to
connect the remote cable to the service power at the utility box.
Cautions alert you to situations that might cause harm to your system or damage to
equipment, or that may affect service, as in the following example:
CAUTION Risk of loss of service. Restarting a running system will interrupt service.
Notes provide information you might need to avoid problems or configuration errors:
NOTE
You must create and configure network interfaces before enabling them for
routing protocols.
Tip: Use tips to save
time and effort.
Command Reference
Tips (see left) provide helpful information for doing something in a faster or easier way,
or for optimizing the performance of your system.
Rel VC4.1 v. 03
Vyatta
li
Document Conventions
Typographic Conventions
In addition to advisory paragraphs, this document may use the following typographic
conventions:
Command Reference
Courier
boldface
Courier
boldface
italics
<key>
[ arg1 | arg2]
num1numN
arg1..argN
Rel VC4.1 v. 03
Vyatta
lii
Vyatta Publications
Vyatta Publications
The Vyatta technical library includes the following publications:
Command Reference
Rel VC4.1 v. 03
Vyatta
liii
Command Modes
Command Prompts
Command Completion
Command History
Command Editing
Log on using the the user ID and password of a defined user account.
By default, the system has two predefined user accounts:
root. This user has administrator-level privileges, which allows execution of all Vyatta
and operating system commands. Command completion and CLI help show all
commands and files, including operating system commands and files. The root user
cannot be deleted.
User ID: root
Default password: vyatta
vyatta. This user has administrator-level privileges, which allows execution of all
Vyatta and operating system commands. Command completion and CLI help show
only Vyatta commands.
User ID: vyatta
Default password: vyatta
NOTE
You can change user accounts using operating system commands, but the
changes will not persist across reboots. For persistent changes to user account
information, use the Vyatta CLI.
Command Reference
Rel VC4.1 v. 03
Vyatta
Commands provided by the operating system shell in which the Vyatta CLI operates.
The commands you can execute depend on your user role. However, any command you are
able to execute can be run from within the Vyatta CLI.
Admin level
Operator level
The system also supports a special root user account. This account has an admin role;
however, command completion and CLI help for the root user show both Vyatta commands
plus operating system commands and files.
This section presents the following topics:
Admin Role
OperatorRole
Admin Role
Admin users have full access to the Vyatta CLI. Admin users can view, configure, and
delete information, and execute all Vyatta operational commands. Admin users can also
execute all operating system shell commands and constructs.
The default user vyatta is an admin user.
To create an admin user, issue the following commands in configuration mode:
vyatta@vyatta# set system login user user-name level admin
vyatta@vyatta# set system login user user-name authentication
plaintext-password password
vyatta@vyatta# commit
where user-name is the ID of the user account you are creating and password is the
password you are assigning to the user.
Command Reference
Rel VC4.1 v. 03
Vyatta
Although operating system shell commands are always available to admin users, they are
not shown when these users use command completion to query the CLI for available
commands. This is because there are several hundred operating system shell commands and
constructs available at any time: showing all available operating system shell commands
would make it very difficult to distinguish available Vyatta CLI commands.
Adminusers can see available commands by entering help at the command prompt.
You can remove the restriction on command completion by setting the
VYATTA_RESTRICTED_MODE environment variable to none:
export VYATTA_RESTRICTED_MODE=none
This removes command completion restriction for all users, regardless of privilege level.
OperatorRole
Operator users have read-only access to configuration plus the ability to execute Vyatta
operational commands. Operator users can view in operational mode (using show
commands), configure their terminal settings (using the terminal command), and exit from
the Vyatta CLI (using the exit command). Operator users cannot enter configuration mode;
however they can display configuration by issuing the show configuration command in
operational mode.
Basic commands for displaying information (for example, show configuration plus the
pipe commands, such as more, for managing display output) are available. Commands
that use control constructs (such as if, for, and so on), list operators (such as ;, &&, and
so on), and redirection are not available to operator users.
To create an operator user, issue the following command:
vyatta@vyatta# set system login user user-name level operator
vyatta@vyatta# set system login user user-name authentication
plaintext-password password
vyatta@vyatta# commit
where user-name is the ID of the user account you are creating and password is the
password you are assigning to the user.
Operating system shell commands are not available to operator users and consequently, the
list of commands returned using command completion for operator-level users is restricted
to Vyatta commands.
You can remove the restriction on command completion by setting the
VYATTA_RESTRICTED_MODE environment variable to none:
export VYATTA_RESTRICTED_MODE=none
This removes command completion restriction for all users, regardless of privilege level.
Command Reference
Rel VC4.1 v. 03
Vyatta
Command Modes
Command Modes
There are two command modes in the Vyatta CLI: operational mode and configuration
mode.
Operational mode provides access to operational commands for showing and clearing
information and enabling or disabling debugging, as well as commands for configuring
terminal settings, loading and saving configuration, and restarting the system.
To enter configuration mode from operational mode, issue the configure command.
To return to operational mode from configuration mode, issue the exit command. If
there are uncommitted configuration changes, you must either commit the changes
using the commit command, or enter exit discard to discard the changes before you
can exit to operational mode.
Issuing the exit command in operational mode logs you out of the system.
Command Reference
Rel VC4.1 v. 03
Vyatta
Command Prompts
Command Prompts
The command prompts show you where you are in the CLI, what user account you are
logged on under, and the hostname of the router you are logged onto.
Table 1-3 shows some examples of command prompts and what they mean.
Table 1-1 Command history keystrokes
The prompt shows this
vyatta@R1:~$
User: vyatta
Hostname: R1
Command mode: Operational mode
R1:~$
User: root
Hostname: R1
Command mode: Operational mode
vyatta@R1#
User: vyatta
Hostname: R1
Command mode: Configuration mode
root@R1#
User: root
Hostname: R1
Command mode: Configuration mode
In this example, the space characters separate the command line into three components:
show, interfaces, and ethernet.
If you want to enter string that includes a literal character understood by the shell as a
special character, you must enclose the character in double quotation marks. For example,
if you want to enter a string that includes a space, you must enclose the string in double
quotation marks as shown below:
prompt> set firewall name TEST description "external inbound"
Command Reference
Rel VC4.1 v. 03
Vyatta
In this example, the space within the string external inbound is within quotes and
therefore loses its special meaning as a token separator.
Another example of a special character is the pipe character (also called the vertical bar,
|), which separates two commands and means that the output of the left-hand side
command should be processed using the right-hand side command, as shown in the
following example:
prompt> show interfaces | match eth
In this example, the pipe character tells the shell to execute the show interfaces command
and then process the output using the match eth command; as a result, only lines that
contain the string eth will be displayed. As for the space character, if you want a literal
vertical bar in a command component, you must enclose it in double quotation marks.
In addition to the space and vertical bar, the following characters have special meaning for
the shell:
ampersand (&)
semi-colon (;)
comma (,)
backslash (\)
In general, if you are unsure what characters are special, a good rule of thumb is to enclose
anything that is not alphanumeric within double quotation marks.
Note that within a quoted string, you can include a literal quote mark by preceding it with
a backslash, as follows:
"some \"quotes\" within quotes"
Of course, the rules become more complex if you want a literal backslash. As a general rule,
try to avoid using quotataion marks or backslashes as literal configuration values.
Command Reference
Rel VC4.1 v. 03
Vyatta
Command Completion
Command Completion
You can have the system auto-complete a command syntax by entering any of the following
at the command prompt:
Table 1-2 CLI Help Keystrokes
Type this:
To see this:
<Tab>
Auto-completes a command.
If the command is unambiguous, the system generates the next
token in the syntax.
If more than one completion is possible, the system displays the
set of next possible tokens.
(Note that the space following a command or keyword counts as a
token.)
Pressing <Tab> a second time generates CLI help for the current set
of tokens.
<Tab>
<Alt>-?
vyatta@R1:~$ <Tab>
clear
init-floppy
configure
install-system
debug
no
delete
ping
vyatta@R1:~$
reboot
set
show
telnet
terminal
traceroute
undebug
vpn
The following example requests command completion for the typed string sh. In this
example, the command to be completed is unambiguous.
vyatta@R1~$: sh<Tab>
vyatta@R1~$: show
Command Reference
Rel VC4.1 v. 03
Vyatta
Command History
The following example requests command completion for the typed string s. In this case,
there is more than one command that could complete the entry and the system lists all valid
completions.
vyatta@R1~$:s<Tab>
set
show
Note that neither the <Tab> key nor the <Alt>+? key combination provides a help function
when double-quoted. When used within double quotes, the <Tab> key generates a tab
character and the <Alt>+? key combination generates a question mark (?) character.
Command History
The Vyatta system shell supports a command history, where commands you execute are
stored in an internal buffer and can be re-executed or edited.
Table 1-3 shows the most important history keystrokes.
Table 1-3 Command history keystrokes
Type this
To do this
<Up-Arrow>
<Control>-p
<Down-Arrow>
<Control>-n
Command Editing
The Vyatta system shell supports emacs-style command editing.
Table 1-4 shows the most important editing keystrokes.
Table 1-4 Command-Line Editing Keystrokes
Command Reference
Type this
To do this
<Left-Arrow>
<Control>-b
Rel VC4.1 v. 03
Vyatta
To do this
<Right-Arrow>
<Control>-f
<Control>-a
<Control>-e
<Control>-d
<Control>-t
Toggle (swap) the character under the cursor with the character
immediately preceding it.
<Control>-<Space>
<Control>-w
Delete the text between the mark and the current cursor position,
copying the deleted text to the cut buffer.
<Control>-k
Kill (delete) from the cursor to the end of the line, copying the
deleted text into the cut buffer.
<Control>-y
Yank (paste) from the cut buffer into the command line, inserting
it at the cursor location.
Press this
Exit More
q
Q
<Space>
f
<Ctrl>+f
b
<Ctrl>+b
Command Reference
Rel VC4.1 v. 03
Vyatta
10
d
<Ctrl>+d
u
<Ctrl>+u
<Enter>
e
<Ctrl>+e
<Down Arrow>
Scroll up one line.
y
<Ctrl>+y
<Up Arrow>
Command Reference
Type this
To do this
count
Count occurrences.
match pattern
more
Paginate output
no-match pattern
Show only text that does not match the specified pattern.
no-more
Rel VC4.1 v. 03
Vyatta
11
Configuration Hierarchy
Viewing Configuration
Deleting Configuration
Saving Configuration
vyatta@vyatta:~$ configure
[edit]
vyatta@vyatta#
to this:
user@host:#
To exit configuration mode, use the exit command from the top level of configuration.
If you have changed configuration, you must either commit changes or discard them using
the exit discard command.
Command Reference
Rel VC4.1 v. 03
Vyatta
12
Configuration Hierarchy
Vyatta system configuration is organized as a hierarchy of configuration statements, with a
a hierarchical tree of nodes similar to the directory structure on a UNIX file system. There
are three kinds of statements:
Attribute statements. These set the values or characteristics for parameters within a
node.
From the systems point of view, a configuration node is different from a simple
configuration attribute statement. A configuration attribute statement takes the form
attribute: value, as in the following example.
protocol-version: v2
A configuration node always has an enclosing pair of braces, which may be empty, as in
the following example:
dns-server ipv4 {}
ssh {
port: 165534
protocol-version: [v1|v2|all]
}
Command Reference
Rel VC4.1 v. 03
Vyatta
13
When you are in another location, the edit prompt displays your location by showing the
node hierarchy in order, like this:
[edit protocols bgp]
Result
edit config-node
exit
top
up
Using the edit command lets you navigate to the part of the hierarchy that you are interested
in and execute commands relative to your location. This saves typing if you need to work
on a particular part of the configuration hierarchy.
The following example navigates to the configuration node for the Ethernet interface eth2.
Once you have navigated to the node, you can show configuration directly without
specifying the full path.
Viewing Configuration
Use the show command in configuration mode to display configuration. You can restrict
the display to a particular node by specifying the path to the node.
For example, the following example shows configuration for all configured interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
14
address "10.1.0.62/24"
hw-id: 00:40:63:e2:e4:00
}
ethernet eth1 {
address "172.16.234.23/25"
hw-id: 00:40:63:e2:e3:dd
vrrp {
virtual-address: 172.16.99.99
vrrp-group: 20
}
}
loopback lo {
}
}
The following example shows configuration only for the Ethernet interface eth0.
When the display is too large for one screen, it stops with one screen displayed. In this case:
Command Reference
Rel VC4.1 v. 03
Vyatta
15
Note the + in front of the new statement. This shows that this statement has been added
to the configuration but the change is not yet committed. The change does not take effect
until configuration is committed using the commit command.
You can modify configuration from the root of the configuration tree or use the edit
command to navigate to the part of the tree where you want to change or add.
The configuration tree is nearly empty when you first start up, except for a few
automatically configured nodes. You must create a node for any functionality you want to
configure on the router. When a node is created, any default values that exist for its
attributes are applied to the node.
One thing you cant do with the set command is change the identifier of a node for which
there can be multiple instances (a multi-node), such as a DNS server or an IP address for
an interface. If a multi-node has an incorrect identifier, you must delete the node and
recreate it with the correct identifier.
Deleting Configuration
Use the delete command to delete configuration statement or a complete configuration
node. For example:
Note the - in front of the deleted statement. This shows that this statement has been
deleted from the configuration but the change is not yet committed. The change does not
take effect until configuration is committed using the commit command.
Command Reference
Rel VC4.1 v. 03
Vyatta
16
Some configuration nodes are mandatory; these cannot be deleted. Some configuration
nodes are mandatory, but have default values; if you delete one of these nodes, the default
value is restored.
vyatta@R1# commit
OK
[edit]
Uncommitted changes are flagged with either a plus sign (for added or modified changes)
or a minus sign (for deleted changes). Once you commit the changes, the sign disappears,
as in the following example:
vyatta@R1# exit
ERROR: There are uncommitted changes
Use "commit" to commit the changes, or "exit discard" to discard
them
vyatta@R1# exit discard
vyatta@R1:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
17
Saving Configuration
The running configuration can be saved using the save command in configuration mode.
By default, configuration is saved to the file config.boot in the standard configuration
directory.
vyatta@R1# save
Saving configuration to '/opt/vyatta/etc/config/config.boot'...
Done
[edit]
vyatta@R1#
You can save configuration to a different location by specifying a different file name.
You can also save a configuration file to a location path other than the standard
configuration directory /opt/vyatta/etc/config, by specifying a different path. You can save
to a hard drive, compact Flash or USB device by including the drive identifier in the path.
Note that the save command writes only committed changes. If you try to save
uncommitted changes the system warns you that it is saving only the committed changes.
Table 1-8 shows the syntax for file specification for various circumstances.
Table 1-8 Specifying locations for the configuration file
Command Reference
Location
Specification
An absolute path
A relative path
Specify the path name relative to the location configured for the
the config-directory parameter of the rtrmgr configuration node.
Rel VC4.1 v. 03
Vyatta
18
Specification
TFTP server
FTP server
HTTP server
If you are running the system from LiveCD, configuration can be saved only to floppy disk.
If you do not save your running configuration to floppy disk, any changes you have made
will be lost after reboot.
Before you can save configuration to a floppy disk, you must initialize the floppy disk using
the init-floppy command in operational mode.
Command Reference
Rel VC4.1 v. 03
Vyatta
19
Command Reference
Rel VC4.1 v. 03
Vyatta
20
encrypted-password: "$1$$Ht7gBYnxI1xCdO/JOnodh."
}
}
}
ntp-server "69.59.150.135"
}
vyatta@R1:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
21
22
This chapter describes the basic commands for using the CLI.
This chapter contains the following commands.
Command
Description
delete
discard
edit
exit
load
run
save
set
show
23
Command
Description
top
up
exit
init-floppy
show arp
show configuration
Command Reference
Rel VC4.1 v. 03
Vyatta
commit
commit
Applies any uncommitted configuration changes.
Syntax
commit
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to apply changes to configuration.
When you add configuration to the system, modify existing configuration, or delete
configuration from the system, the changes you make must be committed before they take
effect. To do this, you issue the commit statement.
If you try to exit or quit from configuration mode while there are still uncommitted
configuration changes, the system will give you a warning. You will not be able to exit from
configuration mode until you either commit the changes by issuing the commit statement,
or you discard the changes using the exit discard statement (see page 33).
Until a configuration change is committed, the system marks the change when displaying
the information.
Committing information can take time, depending on the complexity of the configuration
and how busy the system is. Be prepared to wait for several seconds for the system to
complete committing the information.
If two or more users are logged on to the system in configuration mode and one user
changes the configuration, the other user(s) will receive a warning.
Command Reference
Rel VC4.1 v. 03
Vyatta
24
commit
Examples
Example 2-1 shows an uncommitted deletion which is then committed. In this example,
note how the uncommitted deletion is flagged with a minus sign (-), which disappears
after the change is committed.
Example 2-1 commit: Committing configuration changes
Command Reference
Rel VC4.1 v. 03
Vyatta
25
configure
configure
Enters configuration mode.
Syntax
configure
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enter configuration mode from operational mode. In configuration
mode, you can add, delete, and modify configuration information.
When you are in configuration mode, the command prompt changes to mark the change in
command mode.
Examples
Example 2-2 shows the systems response to entering configuration mode. In this example,
notice how the command prompt changes when the user enters configuration mode.
Example 2-2 configure: Entering configuration mode
vyatta@vyatta:~$ configure
[edit]
vyatta@vyatta#
Command Reference
Rel VC4.1 v. 03
Vyatta
26
delete
delete
Deletes a configuration node.
Syntax
delete config-node
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
config-node
Default
None.
Usage Guidelines
Use this command to delete a part of configuration. To do this, you delete the appropriate
subnode of a configuration node.
If you show configuration before it is committed, you will see the deleted statement flagged
with a minus sign (-); the statement disappears after the configuration change is
committed.
Some configuration nodes and statements are mandatory; these nodes or statements cannot
be deleted. Some configuration statements are mandatory but have default values; if you
delete one of these statements, the default value is restored.
Command Reference
Rel VC4.1 v. 03
Vyatta
27
delete
Examples
Example 2-3 deletes a DNS server from system configuration.
Example 2-3 delete: Deleting configuration
Command Reference
Rel VC4.1 v. 03
Vyatta
28
discard
discard
Discards any uncommitted configuration changes.
Syntax
discard
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to discard all uncommitted changes to configuration.
Examples
Example 2-4 shows an uncommitted deletion and an uncommitted addition which are then
discarded. In this example, note how the uncommitted deletion (flagged with a minus sign
-) and the uncommitted addition (flagged with a plus sign +), disappear after the
discard command is invoked.
Example 2-4 discard: Discarding configuration changes
Command Reference
Rel VC4.1 v. 03
Vyatta
29
discard
Command Reference
Rel VC4.1 v. 03
Vyatta
30
edit
edit
Navigates to a subnode in the configuration tree for editing.
Syntax
edit path
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
path
Default
None.
Usage Guidelines
Use this command to navigate to a specific configuration subnode for editing. The [edit]
prompt changes dynamically to mark your place in the configuration tree.
Once at that location, any actions you take such as showing, creating, or deleting
configuration are relative to your location in the tree.
You can only navigate to a configuration node that has already been created and committed.
Configuration nodes are created and modified using the set command (see page 41) and are
committed using the commit command (see page 24).
Command Reference
Rel VC4.1 v. 03
Vyatta
31
edit
Examples
The following example begins at the top of the configuration tree in configuration mode
and navigates to the system login configuration node. Once at the system login node, a
show command displays just the contents of the login node.
In this example, notice how the prompt changes to mark the location in the configuration
tree.
Example 2-5 edit: Navigating in the configuration tree
[edit]
vyatta@vyatta# edit system login
[edit system login]
vyatta@vyatta# show
user mike {
authentication {
encrypted-password: "$1$hccJixQo$V6sL5hDl6CUmVZvaH1vTf0"
plaintext-password: ""
}
}
user root {
authentication {
encrypted-password: "$1$$Ht7gBYnxI1xCdO/JOnodh."
}
}
user vyatta {
authentication {
encrypted-password: "$1$$Ht7gBYnxI1xCdO/JOnodh."
}
}
[edit system login]
Command Reference
Rel VC4.1 v. 03
Vyatta
32
exit
exit
Navigates up one level of use.
Syntax
exit [discard]
Command Mode
Configuration mode.
Operational mode.
Configuration Statement
None.
Parameters
discard
Default
None.
Usage Guidelines
Use this command from a subnode in the configuration tree to navigate to the top of the
configuration tree.
Use this command from the top of the configuration tree to exit from configuration mode
to operational mode.
Command Reference
Rel VC4.1 v. 03
Vyatta
33
exit
If you try to exit from configuration mode while there are still uncommitted configuration
changes, the system will give you a warning. You will not be able to exit from configuration
mode until you either commit the changes by issuing the commit statement, or you discard
the changes using the exit command with the discard option. This is the only case where
this option applies.
Use this command in operational mode to exit from the system.
Command Reference
Rel VC4.1 v. 03
Vyatta
34
load
load
Loads a saved configuration.
Syntax
load file-name
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
file-name
The name of the configuration file, including the full path to its
location.
Default
None.
Usage Guidelines
Use this command to manually load a configuration previously saved to a file.
The loaded configuration becomes the active (running) configuration and the previous
running configuration is discarded.
Configuration can be loaded from a hard disk (including a Flash disk or USB device), a
TFTP server, an FTP server, or an HTTP server. Note that you cannot load an empty
configuration file; the configuration file must contain at least one configuration node.
The default configuration directory is /opt/vyatta/etc/config.
The following table shows the syntax for file specification for different file locations.
Table 2-1
Command Reference
Location
Specification
An absolute path
Rel VC4.1 v. 03
Vyatta
35
load
Table 2-1
Location
Specification
A relative path
TFTP server
FTP server
HTTP server
Examples
Example 2-6 loads the configuration file testconfig from the default configuration
directory.
Example 2-6 Loading configuration from a file
Command Reference
Rel VC4.1 v. 03
Vyatta
36
run
run
Runs an operational command without leaving configuration mode.
Syntax
run command
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
command
Default
None.
Usage Guidelines
Use this command to run an operational command without leaving configuration mode.
Examples
Example 2-7 executes the show date command (an operational command) from
configuration mode.
Example 2-7 run: Running an operational command in configuration mode
Command Reference
Rel VC4.1 v. 03
Vyatta
37
save
save
Saves the running configuration to a file.
Syntax
save file-name
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
file-name
The name of the file where the information is to be saved, including the
path to the file.
Default
None.
Usage Guidelines
Use this command to save the running configuration to a file.
The resulting file can later be loaded into the running system to replace the previous
running configuration, using the load command (see page 35). A non-absolute path is
interpreted relative to the default configuration directory, which is /opt/vyatta/etc/config.
The following table shows the syntax for file specification for different file locations.
Table 2-2
Command Reference
Location
Specification
An absolute path
A relative path
Rel VC4.1 v. 03
Vyatta
38
save
Table 2-2
Location
Specification
TFTP server
FTP server
HTTP server
If you overwrite a configuration file, the system retains one backup, using a file-name~
convention. For example, if you save over my-config.boot, the system moves the previous
file to my-config.boot~.
Note that the save command only writes committed changes. If you makes configuration
changes and try to save, the system warns you that you have uncommitted changes and then
saves only the committed changes.
Examples
Example 2-8 saves the running configuration into the file my-config in the default
configuration directory, exits from configuration mode, and displays the set of files stored
in the configuration directory.
Example 2-8 save: Saving configuration to a file
vyatta@vyatta# save
Saving configuration to '/opt/vyatta/etc/config/config.boot'...
Done
[edit]
vyatta@vyatta# exit
vyatta@vyatta:~$ show files
total 24K
-rw-rw-r-- 1 vyatta xorp 2.8K Nov 28 10:30 config.boot
-rw-rw-r-- 1 vyatta xorp 2.8K Nov 27 14:32 config.boot~
-rw-rw-r-- 1 vyatta xorp 2.8K Nov 28 10:30 my-config
Command Reference
Rel VC4.1 v. 03
Vyatta
39
save
Example 2-9 saves the current running configuration to the file my-config in the root
directory of a TFTP server at 10.1.0.35.
Example 2-9 save: Saving configuration to a file on a TFTP server
Command Reference
Rel VC4.1 v. 03
Vyatta
40
set
set
Creates a new configuration node, or modifies a value in an existing configuration node.
Syntax
To create a new configuration node, the syntax is as follows:
set config-node [identifier]
To set an attribute within a configuration node, the syntax is as follows:
set config-node [identifier] attribute [value]
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
config-node
identifier
attribute
value
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
41
set
Usage Guidelines
Use this command to add a configuration element to the current configurationfor
example, to enable a routing protocol or define an interface.
You can also use this command to modify the value of an existing configuration item. When
setting configuration values, note that the change does not take effect until the change is
committed, using the commit command (see page 24).
Once a configuration node has been added, you can modify it later using the set command
(see page 41), or delete it using the delete command (see page 27).
Examples
Example 2-10 adds a configuration node for an Ethernet interface and commits the change.
Example 2-10 set: Adding a configuration node
Command Reference
Rel VC4.1 v. 03
Vyatta
42
show
show
Displays configuration information in configuration mode.
Syntax
show [-all] config-node
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
config-node
The configuration node you want to view, including the path. The node
must exist and the created node must have been committed.
The configuration node specification is interpreted relative to your
current position in the configuration tree.
all
Default
When used with no configuration node specification, this command displays all existing
configuration nodes and sub-nodes starting from your current location in the configuration
tree.
When used without the all option, default information is not shown
Usage Guidelines
Use this command in configuration mode to display the configured state of the system.
This command displays the specified configuration node and all sub-nodes. The node
specification is interpreted relative to your current location in the configuration tree.
Unless the all keyword is used, default information is not included in displayed
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
43
show
Examples
Example 2-11 shows the service node displayed using the show command in configuration
mode.
Example 2-11 show: Displaying configuration information
Command Reference
Rel VC4.1 v. 03
Vyatta
44
show configuration
show configuration
Displays system configuration from operational mode.
Syntax
show [-all] configuration
Command Mode
Operational mode.
Parameters
Table 2-3
-all
Default
Displays only the values that have been set explicitly (that is, non-default values).
Usage Guidelines
Use this command to list configuration information while remaining in operational mode.
Using show configuration in operational mode is equivalent to using show in
configuration mode. You can display any configuration node by specifying the path for the
node. For example, show configuration firewall in operational mode is equivalent to show
firewall in configuration mode.
Examples
Example 2-12 displays the firewall configuration node from operational mode.
Example 2-12 show configuration: Displaying the configuration tree in operational mode
Command Reference
Rel VC4.1 v. 03
Vyatta
45
show configuration
ip-src-route: "disable"
broadcast-ping: "disable"
syn-cookies: "enable"
vyatta@vyatta:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
46
top
top
Exits to the top level of configuration mode.
Syntax
top
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
None.
Usage Guidelines
Use this command to quickly navigate to the top level of configuration mode.
Examples
Example 2-13 navigates down through several nodes of the configuration tree, then uses
the top command to jump directly to the top of the tree. In this example, notice how the
[edit] line displays your location in the configuration tree.
Example 2-13 top: Navigating to the top of the configuration tree
Command Reference
Rel VC4.1 v. 03
Vyatta
47
up
up
Navigates up one level in the configuration tree.
Syntax
up
Command Mode
Configuration mode.
Configuration Statement
None.
Parameters
None.
Usage Guidelines
Use this command to navigate one level up in configuration mode.
Examples
Example 2-14 navigates down through several nodes of the configuration tree, then uses
the up command to navigate successively higher in the tree. In this example, notice how
the [edit] line displays your location in the configuration tree.
Example 2-14 up: Navigating up through the configuration tree
Command Reference
Rel VC4.1 v. 03
Vyatta
48
49
This chapter describes commands required for basic system management tasks.
This chapter contains the following commands.
Command
Description
system login
50
Command
Description
system package
system syslog
clear console
full-upgrade
init-floppy
install-system
reboot
set date
show arp
show date
show files
show host
show interfaces
Command Reference
Rel VC4.1 v. 03
Vyatta
51
Command
Description
show license
show ntp
show tech-support
show version
terminal
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear arp address ipv4
Command Mode
Operational mode.
Parameters
ipv4
Removes the ARP entry for the specified IP address from the ARP
cache.
Default
None.
Usage Guidelines
Use this command to remove ARP entries associated with a specific IP address from the
ARP cache.
Command Reference
Rel VC4.1 v. 03
Vyatta
52
Syntax
clear arp interface eth0..eth23
Command Mode
Operational mode.
Parameters
eth0..eth23
Clears the entire ARP cache for the specified Ethernet interface. The
range of values is eth0 to eth23.
Default
None.
Usage Guidelines
Use this command to remove ARP entries associated with an Ethernet interface from the
ARP cache.
Command Reference
Rel VC4.1 v. 03
Vyatta
53
clear console
clear console
Clears the users console.
Syntax
clear console
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to clear the screen of the console.
Command Reference
Rel VC4.1 v. 03
Vyatta
54
Syntax
clear interfaces counters
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to clear the counters for all interfaces of all types, including ADSL,
bridge, Ethernet, loopback, multilink, serial, and tunnel.
Command Reference
Rel VC4.1 v. 03
Vyatta
55
full-upgrade
full-upgrade
Upgrades Vyatta system software.
Syntax
full-upgrade [-h | -i | -k ]
Command Mode
Operational mode.
Parameters
-h
-i
-k
Keep all non-Vyatta packages - Where possible, this option keeps all
non-Vyatta packages during the upgrade. There may be cases where, due
to package dependencies, it is not possible to keep all non-Vyatta
packages. Some of the non-Vyatta packages may be removed or changed
to a different version. After the upgrade is complete, the system will
consist of all the packages from the latest Vyatta release plus all the
non-Vyatta packages that the system was able to keep. This option is
recommended for users who have manually installed non-Vyatta
software on their system and do not want to remove it.
Default
When run with no parameters the command will display the same information as provided
by the -h option.
Usage Guidelines
Use this command to upgrade system software. You must be logged in as root to use this
command. Prior to its use the appropriate repository must be configured. The repository
information can be changed using the system package repository <repository> command
(see page 1518) and related system package repository commands.
Command Reference
Rel VC4.1 v. 03
Vyatta
56
full-upgrade
Examples
Example 3-1 confirms that repository information is configured correctly and then
proceeds to upgrade using full-upgrade.
Example 3-1 Upgrading Vyatta software with full-upgrade
R1:~# configure
[edit]
root@R1# show system package
auto-sync 1
repository community {
components main
distribution testing
url http://packages.vyatta.com/vyatta
}
[edit]
root@R1# exit
exit
R1:~# full-upgrade -k
Reading package lists...
Building dependency tree...
Reading state information...
0 upgraded, 0 newly installed, 0 to remove and 1 not upgraded.
Hit http://packages.vyatta.com testing Release.gpg
Hit http://packages.vyatta.com testing Release
Ign http://packages.vyatta.com testing/main Packages/DiffIndex
Hit http://packages.vyatta.com testing/main Packages
Reading package lists...
Reading package lists...
Building dependency tree...
Reading state information...
vyatta-base is already the newest version.
0 upgraded, 0 newly installed, 0 to remove and 1 not upgraded.
R1:~#
Command Reference
Rel VC4.1 v. 03
Vyatta
57
init-floppy
init-floppy
Formats a floppy diskette and prepares it to receive a configuration file.
Syntax
init-floppy
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to format a disk in the floppy disk drive.
The system puts a file system on the floppy disk and makes it accessible to the Vyatta
system. It also saves a copy of the running configuration to
/media/floppy/config/config.boot.
Initializing the floppy disk erases any previous data on the disk. The system reminds you
of this, and provides a 5-second window in which you can quit out of the command by
typing y in response to the question Continue (y/n)? [y] or pressing <Ctrl>+c.
Once the floppy disk has been formatted, the config.boot file is automatically saved to it.
You can also save the config.boot configuration file to disk using the save command (see
page 38).
Examples
Example 3-2 prepares a floppy disk for receiving a configuration file and saves the running
configuration to /media/floppy/config/config.boot.
Example 3-2 init-floppy: Initializing a floppy diskette for saving configuration files
vyatta@R1:~$ init-floppy
This will erase all data on floppy /dev/fd0.
Your configuration was saved in:
/media/floppy/config/config.boot
Command Reference
Rel VC4.1 v. 03
Vyatta
58
init-floppy
vyatta@R1:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
59
install-system
install-system
Installs Vyatta system software to a persistent device.
Syntax
install-system
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to install the Vyatta system software from the LiveCD onto a persistent
device such as a hard disk.
For instructions on installing the Vyatta system software on a variety of persistent devices,
see the Vyatta System Quick Start Guide.
Command Reference
Rel VC4.1 v. 03
Vyatta
60
reboot
reboot
Reboots the system.
Syntax
reboot
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to reboot the system.
Before the system reboots, a message from the root user is broadcast to all logged on users
warning them of the reboot.
Examples
Example 3-3 reboots the system.
Example 3-3 reboot: Rebooting the system
vyatta@R1:~$ reboot
Proceed with reboot? [confirm]y
Broadcast message from root@R1 (tty1) (Mon Jan 21 17:52:37 2008):
The system is going down for reboot NOW!
Command Reference
Rel VC4.1 v. 03
Vyatta
61
set date
set date
Sets the system date and time directly or specifies an NTP server to acquire it from.
Syntax
set date {datetime | ntp ntpserver}
Command Mode
Operational mode.
Parameters
datetime
Set the date and time directly using one of the following
formats:
MMDDhhmm
MMDDhhmmYY
MMDDhhmmCCYY
MMDDhhmmCCYY.ss
Note that the hour field (hh) uses the 24 hour clock (e.g.
3:00 pm would be represented as 15 in the hour field).
ntpserver
Default
None.
Usage Guidelines
Use this command to set the system date and time either directly or by specifying a Network
Time Protocol (NTP) server to acquire the date and time from. If a timezone has not been
configured then GMT is assumed. The timezone is set using the system time-zone <zone>
command (see page 114).
Command Reference
Rel VC4.1 v. 03
Vyatta
62
set date
Examples
Example 3-4 sets the system date and time to May 15, 2008 at 10:55 pm (assuming that the
timezone is set to Pacific Daylight Time).
Example 3-4 Set the date and time directly
Example 3-5 sets the system date and time using an NTP server.
Example 3-5 Set the date and time using an NTP server
Command Reference
Rel VC4.1 v. 03
Vyatta
63
show arp
show arp
Displays the systems ARP cache.
Syntax
show arp
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display the systems ARP cache.
Table 3-1 shows possible ARP states.
Table 3-1 ARP states
Command Reference
State
Description
incomplete
reachable
stale
More than the configured elapsed time has passed since reachability
confirmation was received from this neighbor.
delay
More than the configured elapsed time has passed since reachability
confirmation was received from this neighbor. This state allows TCP
to confirm the neighbor. If not, a probe should be sent after the next
delay time has elapsed.
probe
A solicitation has been sent and the router is waiting for a response
from this neighbor.
failed
Rel VC4.1 v. 03
Vyatta
64
show arp
Description
noarp
permanent
none
No state is defined.
Examples
Example 3-6 shows the ARP cache of router R1.
Example 3-6 show arp: Displaying the ARP cache
vyatta@R1:~$
Address
172.16.215.1
10.1.0.1
vyatta@R1:~$
Command Reference
show arp
HWtype
HWaddress
ether
00:12:D9:74:BE:91
ether
00:04:23:09:0F:79
Rel VC4.1 v. 03
Flags Mask
C
C
Iface
eth0
eth0
Vyatta
65
show date
show date
Displays the system date and time.
Syntax
show date [utc]
Command Mode
Operational mode.
Parameters
utc
Default
None.
Usage Guidelines
Use this command to display the system date and time in either local time or UTC time.
Examples
Example 3-6 shows the system date and time on R1.
Example 3-7 show date: Displaying the system date and time
Command Reference
Rel VC4.1 v. 03
Vyatta
66
show files
show files
Displays file information.
Syntax
show files directory
Command Mode
Operational mode.
Parameters
directory
Default
None.
Usage Guidelines
Use this command to display information about files in the specified directory.
Examples
Example 3-8 shows information about the files in /opt/vyatta/etc/config on R1.
Example 3-8 show files <directory>: Displaying file information
Command Reference
Rel VC4.1 v. 03
Vyatta
67
Syntax
show hardware cpu
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to view information about the processor used in the systems hardware
platform.
Examples
Example 3-9 shows CPU information on R1.
Example 3-9 show hardware cpu: Showing CPU information
Command Reference
Rel VC4.1 v. 03
E5310
@ 1.60GHz
Vyatta
68
fpu_exception
: yes
cpuid level
: 10
wp
: yes
flags
: fpu vme de pse tsc msr pae mce cx8 apic sep
mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2
ss nx constant_tsc up arch_perfmon pebs bts pni ds_cpl ssse3 dca
bogomips
: 3213.51
clflush size
: 64
vyatta@R1:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
69
Syntax
show hardware dmi
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to view information about the systems desktop management interface
(DMI). The DMI provides a standard framework for managing resources in the device.
Examples
Example 3-10 shows DMI information on R1.
Example 3-10 show hardware dmi: Showing DMI information
Command Reference
Rel VC4.1 v. 03
Vyatta
70
Command Reference
Rel VC4.1 v. 03
Vyatta
71
Syntax
show hardware mem
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to view information about the system memory.
Examples
Example 3-11 shows memory information on R1.
Example 3-11 show hardware mem: Showing memory information
Command Reference
Rel VC4.1 v. 03
Vyatta
72
Writeback:
AnonPages:
Mapped:
Slab:
SReclaimable:
SUnreclaim:
PageTables:
NFS_Unstable:
Bounce:
CommitLimit:
Committed_AS:
VmallocTotal:
VmallocUsed:
VmallocChunk:
vyatta@R1:~$
Command Reference
0
7700
4048
14644
9440
5204
288
0
0
257984
21636
507896
3896
503932
kB
kB
kB
kB
kB
kB
kB
kB
kB
kB
kB
kB
kB
kB
Rel VC4.1 v. 03
Vyatta
73
Syntax
show hardware pci [detailed]
Command Mode
Operational mode.
Parameters
detailed
Default
None.
Usage Guidelines
Use this command to view information about the peripheral component interconnect
(PCI) bus. The PCI provides communication among the systems peripheral components
and the processor.
Examples
Example 3-12 shows PCI information on R1.
Example 3-12 show hardware pci: Showing PCI bus information
Command Reference
Rel VC4.1 v. 03
Vyatta
74
Command Reference
Rel VC4.1 v. 03
Vyatta
75
show host
show host
Displays host information for hosts reachable by the system.
Syntax
show host {lookup hostname | lookup ipv4} | name | date | os}
Command Mode
Operational mode.
Parameters
lookup hostname
Shows the name server canonical name of and IP address for the
host with the specified name, plus any configured aliases.
lookup ipv4
Shows the name server canonical name of and IP address for the
host at the specified address, plus any configured aliases.
date
name
os
Default
None.
Usage Guidelines
Use this command to view information configured for the host.
Examples
Example 3-13 shows host information for router R2.
Example 3-13 show host: Looking up network hosts
Command Reference
Rel VC4.1 v. 03
Vyatta
76
show host
Example 3-15 shows the date and time according to the system clock.
Example 3-15 show host name: Showing the system date and time
Command Reference
Rel VC4.1 v. 03
Vyatta
77
show interfaces
show interfaces
Displays information about system interfaces.
Syntax
show interfaces [detailed | system [enabled]]
Command Mode
Operational mode.
Parameters
detailed
system
enabled
Default
Displays information for all interfaces configured on the system.
Usage Guidelines
Use this command to view configuration information and operational status for interfaces
and vifs.
When used with no option, this statement displays information for all interfaces configured
on the system. You can see specific information by using other versions of this command:
To see all the physical interfaces known to the operating system kernel, use the system
option. This option differs from the other versions of this command: the other versions
show interfaces that have been configured on the system, while the system option shows
all the physical interfaces available on your system (that is, the physical interfaces known
to the operating system kernel).
The physical interfaces available to you determine which interfaces you will be able to
configure and view, because you cannot configure or view an interface that does not
physically exist on the system.
Command Reference
Rel VC4.1 v. 03
Vyatta
78
show interfaces
Examples
Example 3-17 shows the first screen of output for show interfaces system enabled.
Example 3-17 show interfaces: Displaying interface information
packets
4144
packets
1594
errors
0
errors
0
dropped
0
dropped
0
overrun
mcast
0
0
carrier collisions
0
0
packets
11
packets
18
errors
0
errors
0
dropped
0
dropped
0
overrun
mcast
0
0
carrier collisions
0
0
Command Reference
Rel VC4.1 v. 03
Vyatta
79
show license
show license
Displays Vyatta license information.
Syntax
show license
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to view Vyatta license informaiton.
Command Reference
Rel VC4.1 v. 03
Vyatta
80
show license
Examples
Example 3-18 shows the first screen of output for show license.
Example 3-18 show license: Displaying license information
Command Reference
Rel VC4.1 v. 03
Vyatta
81
show license
if you
distribute copies of the software, or if you modify it.
Command Reference
Rel VC4.1 v. 03
Vyatta
82
show ntp
show ntp
Shows the status of configured NTP servers.
Syntax
show ntp {host | ipv4 | ip6-allhosts | ip6-localnet | ntp.vyatta.com | 69.59.150.135 |
ip6-allnodes | ip6-loopback | localhost | localhost-fqdn | ip6-allrouters | ip6-mcastprefix
| ip6-localhost | localhost}
Command Mode
Operational mode.
Parameters
host
Shows the status of the connection to the NTP server with the
specified host name.
ipv4
69.59.150.135
ntp.vyatta.com
localhost
localhost-fqdn
localhost
Default
None.
Usage Guidelines
Use this command to view the status of connections to configured NTP servers.
Command Reference
Rel VC4.1 v. 03
Vyatta
83
show ntp
A line entry is given for each configured NTP server, showing the servers IP address and
how often the router is polling and updating to the NTP clock. An asterisk (*) next to the
NTP server's IP address indicates successful synchronization with the NTP server.
NTP server connections are configured using the system ntp-server <name> command
(see page 108).
Examples
Example 3-19 shows the NTP server at IP address 69.59.150.135.
Example 3-19 show ntp: Showing configured NTP servers
vyatta@R1:~$ show ntp 69.59.150.135
server 69.59.150.135, stratum 3, offset 46.614524, delay 0.03207
22 Jan 12:20:36 ntpdate[10192]: step time server 69.59.150.135
offset 46.614524 sec
vyatta@R1:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
84
Syntax
show system boot-messages [all]
Command Mode
Operational mode.
Parameters
all
Default
A subset of the full list of kernel boot messages is displayed.
Usage Guidelines
Use this command to see startup messages that have been generated by the kernel.
Examples
Example 3-20 shows the first screen of output for show system boot-messages.
Example 3-20 show system boot-messages: Displaying startup messages
Command Reference
Rel VC4.1 v. 03
Vyatta
85
Command Reference
Rel VC4.1 v. 03
Vyatta
86
Syntax
show system connections
Command Mode
Operational mode.
Parameters
None.
Default
None:
Usage Guidelines
Use this command to see what network connections are currently active on the network.
Examples
Example 3-21 shows the first screen of output for show system connections.
Example 3-21 show system connections: Displaying active connections
Command Reference
Rel VC4.1 v. 03
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
Vyatta
87
tcp
0
tcp
0
tcp
0
tcp
0
tcp
0
tcp
0
tcp
0
tcp
0
tcp
0
tcp
0
tcp
0
lines 1-23
Command Reference
0 localhost:4015
0 localhost:1327
0 *:www
0 localhost:3312
0 localhost:3153
0 localhost:2514
0 localhost:2227
0 localhost:4883
0 localhost:1973
0 localhost:4597
0 localhost:2103
Rel VC4.1 v. 03
*:*
*:*
*:*
*:*
*:*
*:*
*:*
*:*
*:*
*:*
*:*
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
Vyatta
88
Syntax
show system kernel-messages
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to see messages currently residing in the kernel ring buffer.
Examples
Example 3-22 shows the first screen of output for show system kernel-messages.
Example 3-22 show system kernel-messages: Displaying messages from the kernel
Command Reference
Rel VC4.1 v. 03
Vyatta
89
Command Reference
Rel VC4.1 v. 03
Vyatta
90
Syntax
show system memory [quagga]
Command Mode
Operational mode.
Parameters
quagga
Default
None.
Usage Guidelines
Use this command to see how much memory is currently being used by the system, and
how much is free.
Examples
Example 3-23 shows information about memory usage on router R1.
Example 3-23 show system memory: Displaying information about memory usage
Command Reference
Rel VC4.1 v. 03
shared
0
buffers cached
19540
65772
Vyatta
91
Syntax
show system processes [summary]
Command Mode
Operational mode.
Parameters
summary
Default
Lists all processes currently running on the system.
Usage Guidelines
Use this command to see information about processes currently running on the system.
Examples
Example 3-24 shows the first screen of output for show system processes.
Example 3-24 show system processes: Displaying process information
Command Reference
Rel VC4.1 v. 03
Vyatta
92
70 ?
656 ?
1481 ?
1484 ?
1486 ?
1723 ?
1877 ?
2548 ?
3141 ?
3147 ?
3190 ?
[lines 1-23]
Command Reference
S
S<
S<
S<
S<
S
S<s
S<
Rs
Ss
Ss
0:00
0:00
0:00
0:00
0:00
0:05
0:00
0:00
0:00
0:00
0:00
[kswapd0]
[kseriod]
[ata/0]
[scsi_eh_0]
[scsi_eh_1]
[kjournald]
udevd --daemon
[kpsmoused]
/sbin/syslogd
/sbin/klogd -x
/usr/sbin/cron
Rel VC4.1 v. 03
Vyatta
93
Syntax
show system storage
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to see how much storage space is currently being used by the system,
and how much is free.
Examples
Example 3-25 shows file system usage information for router R1.
Example 3-25 show system storage: Displaying file system and storage information
Command Reference
Rel VC4.1 v. 03
Vyatta
94
Syntax
show system uptime
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to see how long the system has been running, the number of users
currently logged in, and the average system load.
Examples
Example 3-26 shows file system usage information for router R1.
Example 3-26 show system storage: Displaying file system and storage information
Command Reference
Rel VC4.1 v. 03
Vyatta
95
show tech-support
show tech-support
Provides a consolidated report of system information.
Syntax
show tech-support [save [filename]]
Command Mode
Operational mode.
Parameters
save
filename
Default
Information is sent to the console.
Usage Guidelines
Use this command to list a technical report providing consolidated information about
system components and configuration.
This information is valuable for debugging and diagnosing system issues. You should
provide the technical report whenever you open a case with Vyatta technical support.
Command Reference
Rel VC4.1 v. 03
Vyatta
96
show tech-support
Examples
Example 3-27 shows the first screen of a technical report.
Example 3-27 show tech-support Displaying consolidated system information
Command Reference
Rel VC4.1 v. 03
Vyatta
97
show version
show version
Displays information about the version of router software.
Syntax
show version [all | added | deleted | downgraded | quagga | upgraded]
Command Mode
Operational mode.
Parameters
all
added
Show all packages that have been upgraded since the last
baseline version upgrade.
deleted
Show all packages that have been deleted since the last baseline
version upgrade.
downgraded
Show all packages that have been downgraded since the last
baseline version upgrade.
quagga
upgraded
Show all packages that have been upgraded since the last
baseline version upgrade.
Default
A brief summary of version information is shown. Detailed information about constituent
packages is not shown.
Usage Guidelines
Use this command to see what package changes have occurred since the last time a full
version upgrade was performed.
Command Reference
Rel VC4.1 v. 03
Vyatta
98
show version
The information shown is always with respect to the last full version upgrade. Therefore,
for example:
Immediately following a full version upgrade, issuing a show version all command
will show no changes.
If a package is added after upgrading, issuing a show version all will show the added
package.
However, if the added package is then deleted again, issuing a show version all will
show no change, since the system is now in the same state as immediately after the full
version upgrade.
Keep in mind that if you delete a package, and packages depending on the deleted package
are also removed.
Example 3-28 shows sample output for the show version command used with no option.
Example 3-28 show version: Displaying a summary of version information
vyatta@vyatta:~$ show version
Version :
3.0
Built by:
autobuild@vyatta.com
Built on:
Tue Jan 15 10:31:21 UTC 2008
Build ID:
0801151031f209cb6
Booted From: livecd
vyatta@vyatta:~$
Example 3-29 shows the first page of sample output for the show version all command.
Example 3-29 show version all: Displaying software package version information
Command Reference
Rel VC4.1 v. 03
Vyatta
99
show version
Example 3-30 shows sample output for the show version added command.
Example 3-30 show version added: Displaying information about added software
packages
Command Reference
Rel VC4.1 v. 03
Vyatta
100
show version
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Syntax
set system domain-name domain
delete system domain-name
set system domain-name
Command Mode
Configuration mode.
Configuration Statement
system {
domain-name: text
}
Parameters
domain
Default
None.
Usage Guidelines
Use this command to set the systems domain.
Note that both domain-name and domain-search cannot be configured simultaneously they are mutually exclusive.
Use the set form of this command to specify the domain name to be used by the system.
Use the delete form of this command to remove the domain name.
Use the show form of this command to view domain name configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Syntax
set system domain-search domain domain
delete system domain-search domain domain
show system domain-search domain
Command Mode
Configuration mode.
Configuration Statement
system {
domain-search {
domain: text
}
}
Parameters
domain
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Usage Guidelines
Use this command to list up to 6 domains to be searched in DNS lookup requests.
When the system receives an unqualified host name, it attempts to form a Fully Qualified
Domain Name (FQDN) by appending the domains in this list to the host name. The system
tries each domain name in turn, in the order in which they were configured. If none of the
resulting FQDNs succeeds, the name is not resolved and an error is reported.
Note that both domain-name and domain-search cannot be configured simultaneously they are mutually exclusive.
Use the set form of this command to add a domain to the search list. Note that you cannot
use set to change a domain name in the list. To replace an incorrect domain, delete it and
replace it with a new one.
Use the delete form of this command to remove a domain name from the list.
Use the show form of this command to view the list of domain names.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Syntax
set system gateway-address ipv4
delete system gateway-address
show system gateway-address
Command Mode
Configuration mode.
Configuration Statement
system {
gateway-address: ipv4
}
Parameters
address
Default
None.
Usage Guidelines
Use this command to set the location of the default router.
The default router is the location where packets are routed when the destination does not
match any specific routing entries. Only one default router can be set per system.
Use the set form of this command to specify the address of default gateway.
Use the delete form of this command to remove the default gateway. Note that, in most
cases, traffic cannot be routed correctly if a default gateway is not specified.
Use the show form of this command to view the address of the default gateway.
Command Reference
Rel VC4.1 v. 03
Vyatta
105
Syntax
set system host-name name
delete system host-name
show system host-name
Command Mode
Configuration mode.
Configuration Statement
system {
host-name: text
}
Parameters
name
Default
By default, the host name is preconfigured to vyatta. If you delete the host name, or if
you delete the system node, the default values are restored.
Usage Guidelines
Use the set form of this command to specify a host name for the router. When you set this
value, the command prompt changes to reflect the new host name. To see the change in the
prompt, you must log out of the router shell and log back in again.
Use the delete form of this command to remove the host name. The host name vyatta will
be used by default.
Use the show form of this command to view the host name.
Command Reference
Rel VC4.1 v. 03
Vyatta
106
Syntax
set system name-server address
delete system name-server address
show system name-server
Command Mode
Configuration mode.
Configuration Statement
system {
name-server: ipv4 {}
}
Parameters
ipv4
Multi-node. The IPv4 address of a DNS name server to use for local
name query requests.
You can specify multiple DNS name servers by creating multiple
instances of the name-server configuration node.
Default
None.
Usage Guidelines
Use this command to specify domain name servers (DNS) for the router.
Use the set form of this command to specify a name server for the router. Note that you
cannot modify a DNS name server entry using the set command. To replace a name server
entry, delete the entry and create a new one.
Use the delete form of this command to remove a name server.
Use the show form of this command to view the name servers that have been defined.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
Syntax
set system ntp-server server
delete system ntp-server server
show system ntp-server
Command Mode
Configuration mode.
Configuration Statement
system {
ntp-server: [ipv4|text] {}
}
Parameters
server
Default
By default, the system uses the NTP server at ntp.vyatta.com.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Usage Guidelines
Use this command to specify NTP servers for the router.
Use the set form of this command to specify an NTP server for the router. Note that you
cannot modify an NTP server entry using the set command. To replace an NTP server entry,
delete the entry and create a new one.
Use the delete form of this command to remove an NTP server.
Use the show form of this command to view the NTP servers that have been defined.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Syntax
set system options reboot-on-panic value
delete system options reboot-on-panic
show system options reboot-on-panic
Command Mode
Configuration mode.
Configuration Statement
system {
options {
reboot-on-panic: [true|false]
}
}
Parameters
value
Default
The default is true.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Usage Guidelines
Configuring the system not to reboot on kernel panic allows you to examine information
that might help you determine the cause of the panic.
Use the set form of this command to specify whether or not to reboot on kernel panic.
Use the delete form of this command to restore this option to its default value.
Use the show form of this command to view configuration for this option.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Syntax
set system static-host-mapping host-name name [inet address | alias alias]
delete system static-host-mapping host-name name [inet | alias]
show system static-host-mapping host-name name [inet | alias]
Command Mode
Configuration mode.
Configuration Statement
system {
static-host-mapping {
host-name: text {
inet: ipv4
alias: text {}
}
}
}
Parameters
name
address
alias
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Default
None.
Usage Guidelines
Use this command to statically map a host name to an IP address and one or more aliases.
Use the set form of this command to create a new static mapping between a host name and
an IP address, assign an address, or specify an alias. Note that you cannot use set to change
the host name. To change the host name, delete the mapping entry and create a new one
with the correct host name.
Use the delete form of this command to remove a static mapping, an address, or an alias.
Use the show form of this command to view a static mapping, an address, or an alias.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Syntax
set system time-zone zone
delete system time-zone
show system time-zone
Command Mode
Configuration mode.
Configuration Statement
system {
time-zone: text
}
Parameters
zone
Default
The default is GMT (Greenwich Mean Time).
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Usage Guidelines
Use this command to set the time zone for the local system clock. To do this, you specify
the amount by which your time zone is offset from UTC (coordinated universal time). The
offset you specify is added to UTC to produce the local time.
Note that the router uses POSIX-style offsets. The POSIX specification uses positive signs
west of Greenwichnot positive signs east of Greenwich, which many other systems use.
For example, an offset of GMT +4 corresponds to 4 hours behind UTC (that is, west of
Greenwich).
Use the set form of this command to set the time zone for the first time, or to change the
time zone setting.
Use the delete form of this command to remove the time zone setting. This restores the time
zone to the default (GMT).
Use the show form of this command to view the time zone setting.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
terminal
terminal
Controls behaviors of the system terminal.
Syntax
terminal {key query-help {enable|disable} | length length | pager [pager] | width width}
Command Mode
Operational mode.
Parameters
key query-help
Set whether or not you can get help using a question mark. The
options are enable and disable.The default is enable.
length
pager
width
Default
None.
Usage Guidelines
Use this command to set the terminal behavior.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
117
This chapter lists the commands available for setting up user accounts and user
authentication.
This chapter contains the following commands.
Command
Description
system login
system login
Creates the configuration node for user management and authentication.
Syntax
set system login
delete system login
show system login
Command Mode
Configuration mode.
Configuration Statement
system {
login {}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command, and its sub-commands, to manage user accounts and authentication.
The Vyatta system supports both role-based user account management through a local user
database (login authentication) and authentication using a Remote Authentication Dial
In User Service (RADIUS) authentication server.
NOTE You can change user account information using operating system commands, but
the changes will not persist across reboots. For persistent changes to user account
information, use the Vyatta CLI.
The login configuration node is a mandatory node. It is created automatically with default
information when the system is first started. If this node is subsequently deleted, the system
recreates it with default information.
If no RADIUS server has been set, the system authenticates users using the password
configured in the system login user <user> authentication command (see page 125).
Command Reference
Rel VC4.1 v. 03
Vyatta
118
system login
If you are using RADIUS authentication, the users must still be configured in the Vyatta
login database, using the the system login user <user> authentication command (see
page 125); otherwise, the user will not even be able to query the RADIUS server because
he will not be to access the Vyatta system.
The specific authentication behavior is as follows:
If a user only has a system login password P2 configured, she can use P2 to log on.
If a user has both a RADIUS password P1 and a local password P2 configured, she can
use either P1 or P2 to log on.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Syntax
set system login radius-server address [port port | secret secret | timeout timeout]
delete system login radius-server address [port | secret| timeout]
show system login radius-server address [port | secret| timeout]
Command Mode
Configuration mode.
Configuration Statement
system {
login {
radius-server ipv4 {
port: 165534
secret: text
timeout: 14294967296
}
}
}
Parameters
address
port
Optional. The port to be used for RADIUS traffic. The default is 1812.
secret
Mandatory. The password for the RADIUS server. This must be the
same as that recorded on the RADIUS server.
Supported characters are alphanumeric, space, and special characters.
Strings containing spaces must be enclosed in double quotes.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
timeout
Default
None.
Usage Guidelines
Use this command to define a Remote Authentication Dial In User Service (RADIUS)
server and specify the information necessary to log on to it.
If you are using the RADIUS server, all users must be configured in both the RADIUS
server and the Vyatta login database.
If one or more RADIUS servers has been configured, the configured RADIUS servers are
used to authenticate the user passwords. Note that users being authenticated by RADIUS
must still have login credentials for the Vyatta system recorded using the the system login
user <user> authentication command (see page 125); otherwise, the user will not even be
able to query the RADIUS server because he will not be to access the Vyatta system.
The specific authentication behavior is as follows:
If a user only has a system login password P2 configured, she can use P2 to log on.
If a user has both a RADIUS password P1 and a local password P2 configured, she can
use either P1 or P2 to log on.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
set system login user user
delete system login user user
show system login user user
Command Mode
Configuration mode.
Configuration Statement
system {
login {
user text {}
}
}
Parameters
user
Default
None.
Usage Guidelines
Use this command to define a user that will be authenticated using the systems internal
mechanism: login authentication.
The system first attempts to authenticate users in the local user database (login
authentication). If this fails, the system proceeds to RADIUS authentication.
The system automatically creates two user accounts on startup:
Command Reference
Rel VC4.1 v. 03
Vyatta
123
User root. User root is a user with admin-level privileges plus a full view of the
system: command completion and CLI help show all commands and files, including
bash commands and files.
User vyatta. User vyatta is a user with admin-level privileges but a streamlined view
of the system: command completion and CLI help show only Vyatta-specific
commands.
Note that, although user account and authentication information can be changed using the
operating system shell, the system will overwrite these changes the next time you commit
configuration in the Vyatta shell. For persistent changes to user or authentication
information, use Vyatta CLI commands.
Use the set form of this command to create a user configuration node.
Use the delete form of this command to remove a user configuration node. Note that you
can delete the vyatta user account, but the root user account cannot be deleted.
Use the show form of this command to view user configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
set system login user user authentication {encrypted-password epwd |
plaintext-password ppwd}
delete system login user user authentication [encrypted-password |
plaintext-password]
show system login user user authentication [encrypted-password |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
system {
login {
user text {
authentication {
encrypted-password: text
plaintext-password: text
}
}
}
}
Parameters
user
epwd
ppwd
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Usage Guidelines
Use this command to set a password to authenticate a user.
For encrypted passwords, the password, which is specified in plain text, is encrypted using
Message Digest 5 (MD5) and the encrypted version is stored internally and used. When
displayed the encrypted value is shown. For plain-text passwords, the password is
specified, stored, and used in plain text.
Use the set form of this command to set a users password.
Use the delete form of this command to remove a users password. This disables password
authentication.
Use the show form of this command to view user password configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
set system login user user full-name name
delete system login user user full-name
show system login user user full-name
Command Mode
Configuration mode.
Configuration Statement
system {
login {
user text {
full-name: text
}
}
}
Parameters
user
name
Default
None.
Usage Guidelines
Use this command to record a users full name.
Use the set form of this command to specify the users name.
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Use the delete form of this command to remove the users name.
Use the show form of this command to view a users name.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Syntax
set system login user user level {admin | operator}
delete system login user user level
show system login user user level
Command Mode
Configuration mode.
Configuration Statement
system {
login {
user text {
level {
admin
operator
}
}
}
}
Parameters
Command Reference
user
admin
Assigns the user administrative privileges. The user can execute any
command in the Vyatta CLI or the underlying operating system.
operator
Assigns the user restricted privileges. The user can execute operational
commands in the Vyatta cli, plus a restricted form of ping and
traceroute. The user cannot enter configuration mode or execute
configuration commands.
Rel VC4.1 v. 03
Vyatta
129
Default
Users are assigned administrative privileges by default.
Usage Guidelines
Use this command to assign role-based system access to a user.
The system supports three system roles:
Root user. The root user role has full access to all Vyatta commands plus all operating
system shell commands. Access to operating system shell commands is direct: the root
user need not exit another shell or mode before executing these commands. Command
completion and CLI help show all commands and files, including operating system
shell commands and files. Currently, there is exactly one user with a root user role: user
root. User root cannot be deleted, and you cannot create another user with root
privileges. You cannot change the level of access for user root.
Admin user. Users assigned a role of admin have full access to all Vyatta-specific
commands plus all operating system shell commands. Access to operating system shell
commands is direct: the user need not exit another shell of mode before executing these
commands. A user with a role of admin has a more streamlined view of the system than
the root user does: although admin users can execute any command implemented in
the system, command completion and CLI help show only Vyatta commands.
Operator user. Users assigned a role of operator have access to the Vyatta operational
command set, but no access to configuration commands. They also have limited access
to operating system commands. At this time, command completion and CLI help show
all Vyatta commands for users with the operator role.
Use the set form of this command to set a users privilege level.
Use the delete form of this command to restore a users privilege level to the default.
Use the show form of this command to view user privilege configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
show users
show users
Shows which users are currently logged on to the system.
Syntax
show users
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to see which users are currently logged on to the system.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
132
This chapter describes commands required to deploy basic protocol services such
as DHCP, SSH, and Telnet, and an HTTP service for accessing the web GUI.
This chapter contains the following commands.
Command
Description
service dhcp-server
133
Command
Description
Specifies the port the system will use for the SSH
service.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Command
Description
telnet <address>
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear dhcp client process
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to restart the DHCP client process.
DHCP is configured using the service dhcp-server command (see page 146).
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
clear dhcp lease ip ipv4
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to remove a DHCP lease.
DHCP is configured using the service dhcp-server command (see page 146).
Command Reference
Rel VC4.1 v. 03
Vyatta
136
Syntax
clear dhcp leases
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to remove all DHCP leases.
DHCP is configured using the service dhcp-server command (see page 146).
Command Reference
Rel VC4.1 v. 03
Vyatta
137
service dhcp-relay
service dhcp-relay
Configures the system to relay DHCP client messages to an off-net DHCP server.
Syntax
set service dhcp-relay
delete service dhcp-relay
show service dhcp-relay
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-relay {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to configure the system as a DHCP relay agent.
A DHCP relay agent receives DHCP packets from DHCP clients and forwards them to a
DHCP server. This allows you to place DHCP clients and DHCP servers on different
networks; that is, across router interfaces.
The relay agent is configured with addresses of DHCP servers to which they should relay
client DHCP message. The relay agent intercepts the broadcast, sets the gateway address
(the giaddr field of the DHCP packet) and, if configured, inserts the Relay Agent
Information option (option 82) in the packet and forwards it to the DHCP server.
The DHCP server echoes the option back verbatim to the relay agent in server-to-client
replies, and the relay agent strips the option before forwarding the reply to the client.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
service dhcp-relay
Use the set form of this command to define DHCP relay configuration.
Use the delete form of this command to remove DHCP relay configuration.
Use the show form of this command to view DHCP relay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Syntax
set dhcp-relay interface interface
delete dhcp-relay interface interface
show dhcp-relay interface
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-relay {
interface text {
}
}
}
Parameters
interface
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Usage Guidelines
Use this command to specify the interface to use to accept DHCP requests or relay DHCP
client messages.
Use the set form of this command to specify the interface to use to accept DHCP requests
or relay DHCP client messages.
Use the delete form of this command to remove the specified value.
Use the show form of this command to view the specified value.
Command Reference
Rel VC4.1 v. 03
Vyatta
141
Syntax
set service dhcp-relay relay-options [hop-count count | max-size size | port port |
relay-agents-packets policy]
delete service dhcp-relay relay-options [hop-count | max-size | port |
relay-agents-packets]
show service dhcp-relay relay-options [hop-count | max-size | port |
relay-agents-packets]
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-relay {
relay-options {
hop-count: 1-255
max-size: 64-1400
port: 1-65535
relay-agents-packets: [discard|forward]
}
}
}
Parameters
hop-count count
Command Reference
Rel VC4.1 v. 03
Vyatta
142
max-size size
port port
relay-agents-packet policy Optional. Sets the reforwarding policy for a DHCP relay
agent. This is the action the router will take if the DHCP
message already contains relay information. Supported
values are as follows:
discard: If the packet already contains relay information, it
will be discarded.
forward: The packet will be forwarded regardless of
whether it contains relay information.
The default is forward.
Default
Usage Guidelines
Use this command to configure the Relay Agent Information option (option 82) in the
client-to-server packet, as specified by RFC 3046, and configure DHCP relay options.
Use the set form of this command to set DHCP relay options.
Use the delete form of this command to restore default DHCP relay option values.
Use the show form of this command to view DHCP relay option configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Syntax
set dhcp-relay server ipv4
delete dhcp-relay server ipv4
show dhcp-relay server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-relay {
server ipv4 {
}
}
}
Parameters
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
Usage Guidelines
Use this command to specify the IP address of the DHCP server.
Use the set form of this command to specify the IP address of the DHCP server in a DHCP
relay configuration.
Use the delete form of this command to remove DHCP server configuration in a DHCP
relay configuration.
Use the show form of this command to view DHCP server configuration in a DHCP relay
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
145
service dhcp-server
service dhcp-server
Enables DHCP server functionality.
Syntax
set service dhcp-server
delete service dhcp-server
show service dhcp-server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to configure a pool of addresses the system can use for Dynamic Host
Configuration Protocol (DHCP).
At least one address pool must be configured for DHCP to be available as a service.
Each subnet specified contains a distinct address pool. A given interface can support more
than one address pool (that is, more than one subnet).
Use the set form of this command to enable DHCP server functionality.
Use the delete form of this command to remove the DHCP server functionality.
Use the show form of this command to view DHCP server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Syntax
set dhcp-server disabled state
delete dhcp-server disabled
show dhcp-server disabled
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
disabled: [true|false]
}
}
Parameters
state
Default
DHCP server functionality is disabled.
Usage Guidelines
Use this command to disable the DHCP server without discarding configuration.
Use the set form of this command to specify whether the DHCP server should be disabled
or not.
Use the delete form of this command to restore the default state.
Use the show form of this command to view DHCP server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
147
Syntax
set service dhcp-server shared-network-name name
delete service dhcp-server shared-network-name name
show service dhcp-server shared-network-name name
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
}
}
}
Parameters
name
Default
None.
Usage Guidelines
Use this command to create a DHCP server address pool with the specified name.
Use the set form of this command to create a DHCP address pool.
Use the delete form of this command to remove a DHCP address pool.
Use the show form of this command to view DHCP address pool configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Syntax
set service dhcp-server shared-network-name name subnet ipv4net
delete service dhcp-server shared-network-name name subnet ipv4net
show service dhcp-server shared-network-name name subnet ipv4net
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
}
}
}
}
Parameters
name
ipv4net
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
Usage Guidelines
Use this command to specify the IPv4 network to be served with the addresses that are
defined in this named rule. DHCP requests from devices on this subnet are served static
address assignments or an address from the defined range.
Use the set form of this command to specify the DHCP address pool subnet.
Use the delete form of this command to remove DHCP address pool subnet configuration.
Use the show form of this command to view tDHCP address pool subnet configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> authoritative <state>
Syntax
set service dhcp-server shared-network-name name subnet ipv4net authoritative state
delete service dhcp-server shared-network-name name subnet ipv4net authoritative
show service dhcp-server shared-network-name name subnet ipv4net authoritative
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
authoritative: [enable|disable]
}
}
}
}
Parameters
name
ipv4net
authoritative
Command Reference
Rel VC4.1 v. 03
Vyatta
151
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> authoritative <state>
Default
The DHCP server is not authoritative.
Usage Guidelines
Use this command to set the server as the authoritative DHCP server.
Setting the server as authoritative sets the server as a master server and allows it to protect
itself from rogue DHCP servers or misconfigured DHCP clients. If the server is
authoritative, it sends a DHCPNAK to a misconfigured client; otherwise, the client cannot
update its IP address until after the old lease expires.
Use the set form of this command to enable or disable the authoritative state for a DHCP
server.
Use the delete form of this command to restore the default authoritative state.
Use the show form of this command to view the authoritative DHCP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> bootfile-name <boot-
Syntax
set service dhcp-server shared-network-name name subnet ipv4net bootfile-name
bootfile
delete service dhcp-server shared-network-name name subnet ipv4net bootfile-name
show service dhcp-server shared-network-name name subnet ipv4net bootfile-name
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
bootfile-name: text
}
}
}
}
Parameters
name
ipv4net
bootfile
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
153
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> bootfile-name <boot-
Usage Guidelines
Use this command to specify a bootstrap file from which diskless PCs may boot.
Use the set form of this command to specify the bootstrap file.
Use the delete form of this command to remove boot file configuration.
Use the show form of this command to view boot file configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
154
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> client-prefix-length
Syntax
set service dhcp-server shared-network-name name subnet ipv4net
client-prefix-length prefix
delete service dhcp-server shared-network-name name subnet ipv4net
client-prefix-length
show service dhcp-server shared-network-name name subnet ipv4net
client-prefix-length
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
client-prefix-length: 0-32
}
}
}
}
Parameters
Command Reference
name
ipv4net
prefix
Rel VC4.1 v. 03
Vyatta
155
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> client-prefix-length
Default
None.
Usage Guidelines
Use this command to specify the subnet prefix length that will be assigned to each client.
Use the set form of this command to specify the subnet prefix length that will be assigned
to each client.
Use the delete form of this command to remove the client-prefix-length configuration.
Use the show form of this command to view the client-prefix-length configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
156
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> default-router <ipv4>
Syntax
set service dhcp-server shared-network-name name subnet ipv4net default-router ipv4
delete service dhcp-server shared-network-name name subnet ipv4net default-router
show service dhcp-server shared-network-name name subnet ipv4net default-router
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
default-router: ipv4
}
}
}
}
Parameters
name
ipv4net
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
157
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> default-router <ipv4>
Usage Guidelines
Use this command to specify the address of the default router for DHCP clients on this
subnet.
Use the set form of this command to specify the address of the default router for DHCP
clients on this subnet.
Use the delete form of this command to remove the default-router configuration.
Use the show form of this command to view the default-router configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
158
Syntax
set service dhcp-server shared-network-name name subnet ipv4net dns-server ipv4
delete service dhcp-server shared-network-name name subnet ipv4net dns-server ipv4
show service dhcp-server shared-network-name name subnet ipv4net dns-server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
dns-server: ipv4
}
}
}
}
Parameters
name
ipv4net
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
159
Usage Guidelines
Use this command to specify the address of a DNS server that is available to DHCP clients.
Use the set form of this command to specify the address of a DNS server that is available
to DHCP clients.
Use the delete form of this command to remove DNS server configuration.
Use the show form of this command to view DNS server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
160
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> domain-name <do-
Syntax
set service dhcp-server shared-network-name name subnet ipv4net domain-name
domain-name
delete service dhcp-server shared-network-name name subnet ipv4net domain-name
show service dhcp-server shared-network-name name subnet ipv4net domain-name
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
domain-name: text
}
}
}
}
Parameters
name
ipv4net
domain-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
161
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> domain-name <do-
Usage Guidelines
Use this command to specify the domain name to be used by DHCP clients on this subnet.
Use the set form of this command to specify the client domain name.
Use the delete form of this command to remove client domain name configuration.
Use the show form of this command to view client domain name configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
162
Syntax
set service dhcp-server shared-network-name name subnet ipv4net exclude ipv4
delete service dhcp-server shared-network-name name subnet ipv4net exclude ipv4
show service dhcp-server shared-network-name name subnet ipv4net exclude
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
exclude: ipv4
}
}
}
}
Parameters
name
ipv4net
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
163
Usage Guidelines
Use this command to exclude IP address from a DHCP address pool. Excluded addresses
are never leased to DHCP clients.
Use the set form of this command to exclude an IP address from the lease range.
Use the delete form of this command to remove an IP address from the exclusion list.
Use the show form of this command to view excluded addresses.
Command Reference
Rel VC4.1 v. 03
Vyatta
164
Syntax
set service dhcp-server shared-network-name name subnet ipv4net failover
delete service dhcp-server shared-network-name name subnet ipv4net failover
show service dhcp-server shared-network-name name subnet ipv4net failover
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
failover {
local-address: ipv4
}
}
}
}
}
Parameters
name
ipv4net
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
165
Usage Guidelines
Use this command to enable DHCP failover for an address pool on a given network.
In a failover configuration, two DHCP servers act as failover peers, with one of the peers
designated as the primary and the other as the secondary. For DHCP failover to work:
Both peers must be Vyatta systems, and must be running the same version of Vyatta
software.
Each server must be configured to point to the other as the failover peer.
The system times should be synchronized before configuring DHCP failover. Use of NTP
time synchronization is highly recommended. However, if difficulties arise due to incorrect
system times, disable NTP, reset the times correctly, and then re-enable NTP.
Note that DHCP leases are only assigned in failover configurations if proper
communication is established between the two failover peers. If the configuration is
incorrect (if, for example, one failover peer is configured but the other is not), DHCP leases
will not be dispersed.
Use the set form of this command to define DHCP failover configuration
Use the delete form of this command to remove DHCP failover configuration.
Use the show form of this command to view DCHP failover configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
166
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> failover local-address
Syntax
set service dhcp-server shared-network-name name subnet ipv4net failover
local-address ipv4
delete service dhcp-server shared-network-name name subnet ipv4net failover
local-address
show service dhcp-server shared-network-name name subnet ipv4net failover
local-address
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
failover {
local-address: ipv4
name: text
peer-address: ipv4
status: [primary|secondary]
}
}
}
}
}
Parameters
Command Reference
name
ipv4net
ipv4
Rel VC4.1 v. 03
Vyatta
167
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> failover local-address
Default
None.
Usage Guidelines
Use this command to specify the DHCP failover IP address for the local failover peer.
Use the set form of this command to set the DHCP failover IP address.
Use the delete form of this command to remove local failover IP address configuration.
Use the show form of this command to view local failover IP address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
168
Syntax
set service dhcp-server shared-network-name name subnet ipv4net failover name
peer-name
delete service dhcp-server shared-network-name name subnet ipv4net failover name
show service dhcp-server shared-network-name name subnet ipv4net failover name
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
failover {
name: text
}
}
}
}
}
Parameters
name
ipv4net
peer-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
169
Usage Guidelines
Use this command to specify a name for the local peer in a DHCP failover pair.
Use the set form of this command to specify the DHCP failover peer name.
Use the delete form of this command to remove the local peer name configuration.
Use the show form of this command to view local peer name configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
170
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> failover peer-address
Syntax
set service dhcp-server shared-network-name name subnet ipv4net failover
peer-address ipv4
delete service dhcp-server shared-network-name name subnet ipv4net failover
peer-address
show service dhcp-server shared-network-name name subnet ipv4net failover
peer-address
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
failover {
peer-address: ipv4
}
}
}
}
}
Parameters
Command Reference
name
ipv4net
ipv4
Rel VC4.1 v. 03
Vyatta
171
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> failover peer-address
Default
None.
Usage Guidelines
Use this command to specify the DHCP failover IP address for the local peer.
Use the set form of this command to specify the DHCP failover IP address for the local
peer.
Use the delete form of this command to remove the IP address configuration.
Use the show form of this command to view the IP address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
172
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> failover status <sta-
Syntax
set service dhcp-server shared-network-name name subnet ipv4net failover status
status
delete service dhcp-server shared-network-name name subnet ipv4net failover status
show service dhcp-server shared-network-name name subnet ipv4net failover status
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
failover {
status: [primary|secondary]
}
}
}
}
}
Parameters
name
ipv4net
status
Command Reference
Rel VC4.1 v. 03
Vyatta
173
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> failover status <sta-
Default
None.
Usage Guidelines
Use this command to specify the DHCP failover status of this system.
Use the set form of this command to specify whether this system is primary or secondary.
Use the delete form of this command to remove failover status configuration.
Use the show form of this command to view failover status configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
174
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> ip-forwarding enable
Syntax
set service dhcp-server shared-network-name name subnet ipv4net ip-forwarding
enable state
delete service dhcp-server shared-network-name name subnet ipv4net ip-forwarding
enable
show service dhcp-server shared-network-name name subnet ipv4net ip-forwarding
enable
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
ip-forwarding {
enable: [true|false]
}
}
}
}
}
Parameters
Command Reference
name
ipv4net
Rel VC4.1 v. 03
Vyatta
175
Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> ip-forwarding enable
state
Default
The DHCP server does not direct clients to configure for packet forwarding.
Usage Guidelines
Use this command to specify whether the DHCP server directs clients to configure the IP
layer for packet forwarding.
Use the set form of this command to specify whether the client should configure its IP layer
for packet forwarding.
Use the delete form of this command to restore the default configuration.
Use the show form of this command to view IP forwarding configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
176
Syntax
set service dhcp-server shared-network-name name subnet ipv4net lease seconds
delete service dhcp-server shared-network-name name subnet ipv4net lease
show service dhcp-server shared-network-name name subnet ipv4net lease
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
lease: u32
}
}
}
}
Parameters
name
ipv4net
seconds
Default
The default is 86400 (24 hours).
Command Reference
Rel VC4.1 v. 03
Vyatta
177
Usage Guidelines
Use this command to specify how long the address assigned by the DHCP server will be
valid.
Use the set form of this command to specify how long the address assigned by the DHCP
server will be valid.
Use the delete form of this command to remove the lease configuration.
Use the show form of this command to view the lease configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
178
Syntax
set service dhcp-server shared-network-name name subnet ipv4net ntp-server ipv4
delete service dhcp-server shared-network-name name subnet ipv4net ntp-server ipv4
show service dhcp-server shared-network-name name subnet ipv4net ntp-server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
ntp-server: ipv4
}
}
}
}
Parameters
name
ipv4net
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
179
Usage Guidelines
Use this command to specify the address of an NTP (Network Time Protocol) server
available to clients.
Use the set form of this command to specify the address of an NTP server available to
clients.
Use the delete form of this command to remove the NTP server configuration.
Use the show form of this command to view the NTP server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
180
Syntax
set service dhcp-server shared-network-name name subnet ipv4net pop-server ipv4
delete service dhcp-server shared-network-name name subnet ipv4net pop-server ipv4
show service dhcp-server shared-network-name name subnet ipv4net pop-server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
pop-server: ipv4
}
}
}
}
Parameters
name
ipv4net
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
181
Usage Guidelines
Use this command to specify the address of an POP3 (Post Office Protocol 3) server
available to clients.
Use the set form of this command to specify the address of an POP3 server available to
clients.
Use the delete form of this command to remove the POP3 server configuration.
Use the show form of this command to view the POP3 server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
182
Syntax
set service dhcp-server shared-network-name name subnet ipv4net server-identifier
ipv4
delete service dhcp-server shared-network-name name subnet ipv4net
server-identifier
show service dhcp-server shared-network-name name subnet ipv4net server-identifier
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
server-identifier ipv4
}
}
}
}
Parameters
name
ipv4net
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
183
Usage Guidelines
Use this command to specify the address for the DHCP server identifier.
The server identifier option is a field in a DHCP message that identifies the DHCP server
as the destination address from clients to servers. When the DHCP server includes this field
in a DHCPOffer, the client can use it to distinguish between multiple lease offers. The
server identifier must be an address that is reachable from the client.
Use the set form of this command to specify the address for the DHCP server identifier.
Use the delete form of this command to remove the address for the DHCP server identifier.
Use the show form of this command to view the DHCP server identifier configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
184
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> smtp-server <ipv4>
Syntax
set service dhcp-server shared-network-name name subnet ipv4net smtp-server ipv4
delete service dhcp-server shared-network-name name subnet ipv4net smtp-server
ipv4
show service dhcp-server shared-network-name name subnet ipv4net smtp-server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
smtp-server: ipv4
}
}
}
}
Parameters
Command Reference
name
ipv4net
ipv4
Rel VC4.1 v. 03
Vyatta
185
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> smtp-server <ipv4>
Default
None.
Usage Guidelines
Use this command to specify the address of an SMTP (Simple Mail Transfer Protocol)
server available to clients.
Use the set form of this command to specify the address of an SMTP server available to
clients.
Use the delete form of this command to remove the SMTP server configuration.
Use the show form of this command to view the SMTP server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
186
Syntax
set service dhcp-server shared-network-name name subnet ipv4net start ipv4 stop ipv4
delete service dhcp-server shared-network-name name subnet ipv4net start [ipv4
[stop]]
show service dhcp-server shared-network-name name subnet ipv4net start [ipv4]
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
start ipv4 {
stop: ipv4
}
}
}
}
}
Parameters
name
ipv4net
start
Command Reference
Rel VC4.1 v. 03
Vyatta
187
stop
Default
None.
Usage Guidelines
Use this command to specify the range of addresses that will be assigned to DHCP clients.
Use the set form of this command to specify the range of addresses that will be assigned to
DHCP clients.
Use the delete form of this command to remove the address range configuration.
Use the show form of this command to view the address range configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
188
Syntax
set service dhcp-server shared-network-name name subnet ipv4net static-mapping
mapname {ip-address ipv4| mac-address mac}
delete service dhcp-server shared-network-name name subnet ipv4net static-mapping
mapname [ip-address|mac-address]
show service dhcp-server shared-network-name name subnet ipv4net static-mapping
mapname [ip-address|mac-address]
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
static-mapping text {
ip-address: ipv4
mac-address: text
}
}
}
}
}
Parameters
Command Reference
name
ipv4net
Rel VC4.1 v. 03
Vyatta
189
mapname
ipv4
mac
Default
None.
Usage Guidelines
Use this command to specify a static IP address for a specific DHCP client based on its
MAC address.
Use the set form of this command to specify a static IP address for a specific DHCP client
based on its MAC address.
Use the delete form of this command to remove the static mapping configuration.
Use the show form of this command to view the static mapping configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
190
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> static-route destina-
Syntax
set service dhcp-server shared-network-name name subnet ipv4net static-route
destination-subnet ipv4net2
delete service dhcp-server shared-network-name name subnet ipv4net static-route
destination-subnet
show service dhcp-server shared-network-name name subnet ipv4net static-route
destination-subnet
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
static-route {
destination-subnet: ipv4net
}
}
}
}
Parameters
Command Reference
name
ipv4net
ipv4net2
Rel VC4.1 v. 03
Vyatta
191
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> static-route destina-
Default
None.
Usage Guidelines
Use this command to specify the destination subnet of a static route for clients to store in
their routing cache. The other part of the static route is defined by the the service
dhcp-server shared-network-name <name> subnet <ipv4net> static-route router
<ipv4> command (see page 193). Only one static route can be defined for a given subnet.
Use the set form of this command to specify the destination subnet of a static route for
clients to store in their routing cache.
Use the delete form of this command to remove the destination subnet configuration.
Use the show form of this command to view the destination subnet configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
192
Syntax
set service dhcp-server shared-network-name name subnet ipv4net static-route router
ipv4
delete service dhcp-server shared-network-name name subnet ipv4net static-route
router
show service dhcp-server shared-network-name name subnet ipv4net static-route
router
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
static-route {
router: ipv4
}
}
}
}
Parameters
Command Reference
name
ipv4net
ipv4
Rel VC4.1 v. 03
Vyatta
193
Default
None.
Usage Guidelines
Use this command to specify the router for the destination of a static route for clients to
store in their routing cache. The other part of the static route is defined by the the service
dhcp-server shared-network-name <name> subnet <ipv4net> static-route
destination-subnet <ipv4net> command (see page 191).
Use the set form of this command to specify the router for the destination of a static route
for clients to store in their routing cache.
Use the delete form of this command to remove the router configuration.
Use the show form of this command to view the router configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
194
Syntax
set service dhcp-server shared-network-name name subnet ipv4net tftp-server-name
servername
delete service dhcp-server shared-network-name name subnet ipv4net
tftp-server-name
show service dhcp-server shared-network-name name subnet ipv4net
tftp-server-name
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
tftp-server-name: ipv4
}
}
}
}
Parameters
name
ipv4net
servername
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
195
Usage Guidelines
Use this command to specify the name of a TFTP (Trivial File Transfer Protocol) server
available to clients.
Use the set form of this command to specify the name of a TFTP (Trivial File Transfer
Protocol) server available to clients.
Use the delete form of this command to remove the TFTP server configuration.
Use the show form of this command to view the TFTP server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
196
Syntax
set service dhcp-server shared-network-name name subnet ipv4net time-offset seconds
delete service dhcp-server shared-network-name name subnet ipv4net time-offset
show service dhcp-server shared-network-name name subnet ipv4net time-offset
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
time-offset: u32
}
}
}
}
Parameters
name
ipv4net
seconds
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
197
Usage Guidelines
Use this command to specify the offset of the clients subnet in seconds from UTC
(Coordinated Universal Time).
Use the set form of this command to specify the offset of the clients subnet in seconds from
UTC (Coordinated Universal Time).
Use the delete form of this command to remove the time offset configuration.
Use the show form of this command to view the time offset configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
198
Syntax
set service dhcp-server shared-network-name name subnet ipv4net time-server ipv4
delete service dhcp-server shared-network-name name subnet ipv4net time-server
ipv4
show service dhcp-server shared-network-name name subnet ipv4net time-server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
time-server: ipv4
}
}
}
}
Parameters
Command Reference
name
ipv4net
ipv4
Rel VC4.1 v. 03
Vyatta
199
Default
None.
Usage Guidelines
Use this command to specify the address of an RFC 868 time server available to clients.
Use the set form of this command to specify the address of a time server available to clients.
Use the delete form of this command to remove the time server configuration.
Use the show form of this command to view the time server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
200
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> wins-server <ipv4>
Syntax
set service dhcp-server shared-network-name name subnet ipv4net wins-server ipv4
delete service dhcp-server shared-network-name name subnet ipv4net wins-server
ipv4
show service dhcp-server shared-network-name name subnet ipv4net wins-server
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
wins-server: ipv4
}
}
}
}
Parameters
name
ipv4net
ipv4
Command Reference
Rel VC4.1 v. 03
Vyatta
201
Chapter 5: Basic Services service dhcp-server shared-network-name <name> subnet <ipv4net> wins-server <ipv4>
Default
None.
Usage Guidelines
Use this command to specify the address of a WINS server that is available to DHCP
clients.
Use the set form of this command to specify the address of a WINS server that is available
to DHCP clients.
Use the delete form of this command to remove the wins-server configuration.
Use the show form of this command to view the wins-server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
202
Syntax
set service dhcp-server shared-network-name name subnet ipv4net wpad-url url
delete service dhcp-server shared-network-name name subnet ipv4net wpad-url
show service dhcp-server shared-network-name name subnet ipv4net wpad-url
Command Mode
Configuration mode.
Configuration Statement
service {
dhcp-server {
shared-network-name text {
subnet ipv4net {
wpad-url: text
}
}
}
}
Parameters
name
ipv4net
url
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
203
Usage Guidelines
Use this command to specify the Web Proxy Autodiscovery (WPAD) URL
Use the set form of this command to specify the Web Proxy Autodiscovery (WPAD) URL
Use the delete form of this command to remove the WPAD URL configuration.
Use the show form of this command to view the WPAD URL configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
204
service ssh
service ssh
Configures SSH as an access protocol on the system.
Syntax
set service ssh
delete service ssh
show service ssh
Command Mode
Configuration mode.
Configuration Statement
service {
ssh {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to configure the system to allow SSH requests from remote systems to
the local system.
Creating the SSH configuration node enables SSH as an access protocol. By default, the
router uses port 22 for the SSH service, and SSH version 2 alone is used.
Use the set form of this command to create the SSH configuration.
Use the delete form of this command to remove the SSH configuration. If you delete the
SSH configuration node you will disable SSH access to the system.
Use the show form of this command to view the SSH configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
205
Syntax
set service ssh allow-root state
delete service ssh allow-root
show service ssh allow-root
Command Mode
Configuration mode.
Configuration Statement
service {
ssh {
allow-root: [true|false]
}
}
Parameters
state
Default
Root logins are not allowed on SSH connections.
Usage Guidelines
Use this command to specify whether or not root logins are allowed on SSH connections.
Use the set form of this command to specify whether or not root logins are allowed on SSH
connections.
Use the delete form of this command to restore the default allow-root configuration.
Use the show form of this command to view the allow-root configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
206
Syntax
set service ssh port port
delete service ssh port
show service ssh port
Command Mode
Configuration mode.
Configuration Statement
service {
ssh {
port: 1-65534
}
}
Parameters
port
The port the system will use for the SSH service. The range is
1 to 65534.
Default
The default is port 22.
Usage Guidelines
Use this command to specify the port the system will use for the SSH service.
Use the set form of this command to specify the port the system will use for the SSH
service.
Use the delete form of this command to restore the default port configuration.
Use the show form of this command to view the port configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
207
Syntax
set service ssh protocol-version version
delete service ssh protocol-version
show service ssh protocol-version
Command Mode
Configuration mode.
Configuration Statement
service {
ssh {
protocol-version: [v1|v2|all]
}
}
Parameters
version
Default
The default is v2.
Usage Guidelines
Use this command to specify which versions of SSH are enabled.
Use the set form of this command to specify which versions of SSH are enabled.
Use the delete form of this command to restore the default protocol-version configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
208
Use the show form of this command to view the protocol-version configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
209
service telnet
service telnet
Configures Telnet as an access protocol on the system.
Syntax
set service telnet
delete service telnet
show service telnet
Command Mode
Configuration mode.
Configuration Statement
service {
telnet {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to configure the system to accept Telnet as an access service to the
system.
Creating the Telnet configuration node enables Telnet as an access protocol. By default, the
system uses port 23 for the Telnet service.
Use the set form of this command to create the Telnet configuration.
Use the delete form of this command to remove the Telnet configuration. If you delete the
Telnet configuration node you will disable Telnet access to the system.
Use the show form of this command to view the Telnet configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
210
Syntax
set service telnet allow-root state
delete service telnet allow-root
show service telnet allow-root
Command Mode
Configuration mode.
Configuration Statement
service {
telnet {
allow-root: [true|false]
}
}
Parameters
state
Default
Root logins are not allowed on Telnet connections.
Usage Guidelines
Use this command to specify whether or not root logins are allowed on Telnet connections.
Use the set form of this command to specify whether or not root logins are allowed on
Telnet connections.
Use the delete form of this command to restore the default allow-root configuration.
Use the show form of this command to view the allow-root configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
211
Syntax
set service telnet port port
delete service telnet port
show service telnet port
Command Mode
Configuration mode.
Configuration Statement
service {
telnet {
port: 1-65534
}
}
Parameters
port
The port the system will use for the Telnet service. The range is
1 to 65534.
Default
The default is port 23.
Usage Guidelines
Use this command to specify the port the system will use for the Telnet service.
Use the set form of this command to specify the port the system will use for the Telnet
service.
Use the delete form of this command to restore the default port configuration.
Use the show form of this command to view the port configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
212
Syntax
show dhcp client leases [interface ethx]
Command Mode
Operational mode.
Parameters
ethx
Usage Guidelines
Use this command to see current DHCP client information.
When used with no option, this command displays all client information. When an interface
is provided, this command displays client information for the specified interface.
DHCP is configured using the the service dhcp-server command (see page 146).
Command Reference
Rel VC4.1 v. 03
Vyatta
213
Syntax
show dhcp leases [pool pool-name]
Command Mode
Operational mode.
Parameters
pool-name
Usage Guidelines
Use this command to see current lease information for DHCP subscribers.
When used with no option, this command displays all current lease information. When
address pool is provided, this command displays lease information for the specified address
pool.
DHCP is configured using the the service dhcp-server command (see page 146).
Examples
Example 5-1 shows sample output of show dhcp leases with no option.
Example 5-1 show dhcp leases
vyatta@R1> show dhcp leases
IP address
---------192.168.11.101
Hardware Address
---------------00:12:3f:e3:af:67
Lease expiration
---------------2007/06/23 16:28:26
Pool
---POOL1
Client Name
----------Laptop 9
vyatta@R1>
Command Reference
Rel VC4.1 v. 03
Vyatta
214
Syntax
show dhcp statistics [pool pool-name]
Command Mode
Operational mode.
Parameters
pool-name
Usage Guidelines
Use this command to see current lease information for DHCP subscribers.
When used with no option, this command displays all current lease information. When
address pool is provided, this command displays lease information for the specified address
pool.
DHCP is configured using the the service dhcp-server command (see page 146).
Examples
Example 5-2 shows sample output of show dhcp statistics with no option.
Example 5-2 show dhcp statistics
vyatta@R1> show dhcp statistics
Total DHCP requests for all pools:
Total DHCP responses for all pools:
pool
---POOL1
2
0
pool size
--------100
# leased
-------1
# avail
------99
vyatta@R1>
Command Reference
Rel VC4.1 v. 03
Vyatta
215
telnet <address>
telnet <address>
Creates a terminal session to a Telnet server.
Syntax
telnet address [service]
Command Mode
Operational mode.
Parameters
address
service
Optional. The port number or service name you wish to connect to. The
range for ports is 65535. Any service name in the file /etc/services is
permitted. The default is port 23.
Default
If no port is specified, the system connects through port 23 (the well-known port for the
Telnet service).
Usage Guidelines
Use this command to create a terminal session to a remote machine running a Telnet
service.
Examples
Example 5-3 shows a telnet session being established to 192.168.1.77.
Example 5-3 telnet 192.168.1.77: Displaying the Telnet session being established
Command Reference
Rel VC4.1 v. 03
Vyatta
216
telnet <address>
Welcome to Vyatta
vyatta login:
Command Reference
Rel VC4.1 v. 03
Vyatta
217
218
This chapter lists the commands for configuring Ethernet interfaces, the loopback
interface, and VLAN interfaces.
This chapter contains the following commands.
Command
Description
Command
Description
219
Command Reference
Rel VC4.1 v. 03
Vyatta
Command
Description
220
Command Reference
Rel VC4.1 v. 03
Vyatta
221
Command
Description
show arp
show interfaces
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear interfaces ethernet [ethx] counters
Command Mode
Operational mode.
Parameters
ethx
Optional. Clears statistics for the specified Ethernet interface. The range
is eth0 to eth23, depending on what Ethernet interfaces that are actually
available on the system.
Default
Clears counters for all Ethernet interfaces.
Usage Guidelines
Use this command to clear counters on Ethernet interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
222
Syntax
clear interfaces loopback [lo] counters
Command Mode
Operational mode.
Parameters
lo
Default
Clears counters for all loopback interfaces.
Usage Guidelines
Use this command to clear counters on loopback interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
223
Syntax
set interfaces ethernet ethx
delete interfaces ethernet ethx
show interfaces ethernet ethx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
}
}
Parameters
ethx
Mandatory. Multi-node. The identifier for the Ethernet interface you are
defining. This may be eth0 to eth23, depending on what Ethernet
interfaces that are actually available on the system.
There will be as many Ethernet interface configuration nodes created as
there are physical Ethernet interfaces on your system.
Default
Configuration nodes are created for all available physical Ethernet interfaces on startup.
Usage Guidelines
Use this command to configure an Ethernet interface.
You can use the set form of this command to create an Ethernet interface, provided the
interface physically exists on your system. However, the system automatically creates a
configuration node for each system interface, so you should not need to use the set form of
this command to create an Ethernet interface unless you have deleted it.
Command Reference
Rel VC4.1 v. 03
Vyatta
224
To see the interfaces available to the system kernel, use the system option of the show
interfaces command (see page 78).
Use the delete form of this command to remove all configuration for an Ethernet interface.
The system will create an empty configuration node for the interface the next time the
system starts.
Use the show form of this command to view Ethernet interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
225
Syntax
set interfaces ethernet ethx address {ipv4net | dhcp}
delete interfaces ethernet ethx address {ipv4net | dhcp}
show interfaces ethernet ethx address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
address: [ipv4net|dhcp]
}
}
Parameters
ethx
ipv4net
dhcp
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
226
Usage Guidelines
Use this command to set the IP address and network prefix for an Ethernet interface.
Use the set form of this command to set the IP address and network prefix. You can set
more than one IP address for the interface by creating multiple address configuration
nodes.
Use the delete form of this command to remove IP address configuration.
Use the show form of this command to view IP address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
227
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> description
Syntax
set interfaces ethernet ethx description descr
delete interfaces ethernet ethx description
show interfaces ethernet ethx description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
description: text
}
}
Parameters
ethx
descr
Default
None.
Usage Guidelines
Use this command to set a description for an Ethernet interface.
Use the set form of this command to specify the description.
Use the delete form of this command to remove the description.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
228
Syntax
set interfaces ethernet ethx disable
delete interfaces ethernet ethx disable
show interfaces ethernet ethx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
disable
}
}
Parameters
ethx
Default
None.
Usage Guidelines
Use this command to disable an Ethernet Interface without discarding configuration.
Use the set form of this command to disable the interface.
Use the delete form of this command to enable the interface.
Use the show form of this command to view Ethernet interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
229
Syntax
set interfaces ethernet ethx disable-link-detect
delete interfaces ethernet ethx disable-link-detect
show interfaces ethernet ethx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
disable-link-detect
}
}
Parameters
ethx
Default
The interface detects physical link state changes.
Usage Guidelines
Use this command to direct an Ethernet interface to not detect physical state change to the
Ethernet link (for example, when the cable is unplugged).
Use the set form of this command to disable detection of physical state changes.
Use the delete form of this command to enable detection of physical state changes.
Use the show form of this command to view Ethernet interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
230
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> duplex <du-
Syntax
set interfaces ethernet ethx duplex duplexity
delete interfaces ethernet ethx duplex
show interfaces ethernet ethx duplex
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
duplex [auto|half|full]
}
}
Parameters
ethx
duplexity
Default
The router autonegotiates duplexity.
Command Reference
Rel VC4.1 v. 03
Vyatta
231
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> duplex <du-
Usage Guidelines
Use this command to set the duplexity characteristics of an Ethernet interface.
Use the set form of this command to set the duplexity of the interface.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view duplexity configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
232
Syntax
set interfaces ethernet ethx hw-id mac-addr
delete interfaces ethernet ethx hw-id
show interfaces ethernet ethx hw-id
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
hw-id: mac-addr
}
}
Parameters
ethx
mac-addr
The Media Access Control (MAC) address to be used for the interface.
The format should be appropriate for the interface type. For an Ethernet
interface, this is 6 colon-separated 8-bit numbers in hexadecimal; for
example, 00:0a:59:9a:f2:ba.
Default
The factory-assigned MAC address of the network interface card with which this Ethernet
interface is associated..
Command Reference
Rel VC4.1 v. 03
Vyatta
233
Usage Guidelines
Use this command to set the hardware ID of an Ethernet interface. This is the media access
control (MAC) address that is to be used for the interface.
When the system is started for the first time it determines which physical Ethernet
interfaces are available, reads the MAC addresses for each interface from the hardware, and
uses this value to automatically set the hardware ID of the interface. You can change the
hardware ID advertised for an interface by explicitly setting the hw-id attribute, thus
changing the assignment of interface name to physical interface.
Use the set form of this command to set the hardware ID of the interface.
Use the delete form of this command to remove hardware ID configuration, restoring the
factory-assigned MAC address as the hardware ID of the interface.
Use the show form of this command to view hardware ID configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
234
Syntax
set interfaces ethernet ethx mac mac-addr
delete interfaces ethernet ethx mac
show interfaces ethernet ethx mac
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
mac: mac-addr
}
}
Parameters
ethx
mac-addr
The Media Access Control (MAC) address to be set for the Ethernet
interface.
The format should be appropriate for the interface type. For an Ethernet
interface, this is 6 colon-separated 8-bit numbers in hexadecimal; for
example, 00:0a:59:9a:f2:ba.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
235
Usage Guidelines
Use this command to set the media access control (MAC) address of the interface.
Some Ethernet interfaces provide the ability to change their MAC address. This command
allows you to change the MAC address of these interfaces.
Use the set form of this command to set the MAC address of the physical interface.
Use the delete form of this command to remove a configured MAC address for the
interface, restoring the factory-assigned MAC address.
Use the show form of this command to view MAC address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
236
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> mtu <mtu>
Syntax
set interfaces ethernet ethx mtu mtu
delete interfaces ethernet ethx mtu
show interfaces ethernet ethx mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
mtu: u32
}
}
Parameters
ethx
mtu
Sets the MTU, in octets, for the interface as a whole, including any
logical interfaces configured for it. The range is 1 to 1500.
Default
If this value is not set, fragmentation is never performed.
Usage Guidelines
Use this command to set the maximum transmission unit (MTU) for an Ethernet interface.
This value is also applied to all vifs defined for the interface.
When forwarding, IPv4 packets larger than the MTU will be fragmented unless the DF bit
is set. In that case, the packets will be dropped and an ICMP Packet too big message is
returned to the sender.
Command Reference
Rel VC4.1 v. 03
Vyatta
237
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> mtu <mtu>
Command Reference
Rel VC4.1 v. 03
Vyatta
238
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> smp_affinity
Syntax
set interfaces ethernet ethx smp_affinity mask
delete interfaces ethernet ethx smp_affinity mask
show interfaces ethernet ethx smp_affinity
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
smp_affinity: hex-mask
}
}
Parameters
ethx
mask
Multi-node. Up to four hex digits that identify the processor(s) that this
interface will interrupt; for example, 0x0001 represents CPU 0 and
0x0080 represents CPU 7.
You can distribute the interrupts from an interface among multiple
processors by creating multiple smp_affinity configuration nodes.
Default
Interrupts are serviced by any available CPU.
Usage Guidelines
Use this command to configure and display the SMP affinity mask for an Ethernet
interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
239
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> smp_affinity
Whenever a piece of hardware, such as disk controller or ethernet card, needs processing
resources, it generates an interrupt request (IRQ). The IRQ tells the processor that resources
are required and the processor should attend to the task.
In a multi-core computer using symmetric multiprocessing (SMP), any processor can be
recruited to process any task. By default, hardware interrupts are processed by whichever
processor is available. Setting SMP affinity for an interface allows you to control how the
system responds to hardware interrupts by assigning interrupts from a given Ethernet
interface to a specific processor.
Optimal performance generally achieved when each interface interrupts only one processor
interrupts from the most heavily loaded interfaces are evenly distributed among available
CPUs.
Use the set form of this command to specify the SMP affinity for an Ethernet interface.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view SMP affinity configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
240
Syntax
set interfaces ethernet ethx speed speed
delete interfaces ethernet ethx speed
show interfaces ethernet ethx speed
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
speed [auto|10|100|1000]
}
}
Parameters
ethx
speed
Default
Ethernet link speed is autonegotiated.
Command Reference
Rel VC4.1 v. 03
Vyatta
241
Usage Guidelines
Use this command to set the link speed for an Ethernet interface.
Use the set form of this command to set the speed.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view Ethernet speed configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
242
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Syntax
set interfaces ethernet ethx vif vlan-id
delete interfaces ethernet ethx vif [vlan-id]
show interfaces ethernet ethx vif [vlan-id]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
}
}
}
Parameters
ethx
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1Q
VLAN tagging. The range is 0 to 4095.
Note that only 802.1Q tagged packets are accepted on Ethernet vifs.
You can define more than one vif for an interface by creating multiple
vif configuration nodes.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
243
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Usage Guidelines
Use this command to create a virtual interface (vif) on an Ethernet interface.
On Ethernet interfaces, vifs function as Virtual LAN (VLAN) interfaces, and only 802.1Q
tagged packets are accepted.
Use the set form of this command to define a vif.
Use the delete form of this command to remove an Ethernet vif and all its configuration.
Use the show form of this command to view Ethernet vif configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
244
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Syntax
set interfaces ethernet ethx vif vlan-id address {ipv4net | dhcp}
delete interfaces ethernet ethx vif vlan-id address {ipv4net | dhcp}
show interfaces ethernet ethx vif vlan-id address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
address: [ipv4net|dhcp]
}
}
}
Parameters
ethx
vlan-id
ipv4net
The IPv4 address and network prefix for this vif. The format is
ip-address/prefix (for example, 192.168.1.77/24).
You can define multiple IP addresses for a vif by creating multiple
address configuration nodes.
dhcp
Command Reference
Rel VC4.1 v. 03
Vyatta
245
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Default
None.
Usage Guidelines
Use the set form of this command to specify an address for this vif.
Use the delete form of this command to remove the address for this vif.
Use the show form of this command to view the address for this vif.
Command Reference
Rel VC4.1 v. 03
Vyatta
246
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Syntax
set interfaces ethernet ethx vif vlan-id description descr
delete interfaces ethernet ethx vif vlan-id description
show interfaces ethernet ethx vif vlan-id description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
description: text
}
}
}
Parameters
ethx
vlan-id
descr
Default
None.
Usage Guidelines
Use this command to set a description for a vif on an Ethernet interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
247
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Command Reference
Rel VC4.1 v. 03
Vyatta
248
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Syntax
set interfaces ethernet ethx vif vlan-id disable
delete interfaces ethernet ethx vif vlan-id disable
show interfaces ethernet ethx vif vlan-id
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
disable
}
}
}
Parameters
ethx
vlan-id
Default
The vif is enabled.
Usage Guidelines
Use this command to disable a vif on an Ethernet interface without discarding
configuration.
Use the set form of this command to disable the interface.
Use the delete form of this command to enable the interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
249
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Use the show form of this command to view Ethernet vif configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
250
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Syntax
set interfaces ethernet ethx vif vlan-id disable-link-detect
delete interfaces ethernet ethx vif vlan-id disable-link-detect
show interfaces ethernet ethx vif vlan-id
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
disable-link-detect
}
}
}
Parameters
ethx
vlan-id
Default
By default disable-link-detect is not set.
Usage Guidelines
Use this command to direct an Ethernet interface to not detect physical state change to the
Ethernet link (for example, when the cable is unplugged).
Use the set form of this command to disable detection of physical state changes.
Command Reference
Rel VC4.1 v. 03
Vyatta
251
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>
Use the delete form of this command to enable detection of physical state changes.
Use the show form of this command to view Ethernet interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
252
interfaces loopback lo
interfaces loopback lo
Defines the loopback interface.
Syntax
set interfaces loopback lo
delete interfaces loopback lo
show interfaces loopback
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo
}
Parameters
None.
Default
A configuration node is automatically created for the loopback interface on startup.
Usage Guidelines
Use this command to define the loopback interface.
The loopback interface is a special software-only interface that emulates a physical
interface and allows the router to connect to itself. Packets routed to the loopback
interface are rerouted back to the router and processed locally. Packets routed out the
loopback interface but not destined for the loopback interface are dropped.
The loopback interface provides a number of advantages:
Command Reference
As long as the router is functioning, the loopback interface is always up, and so is very
reliable. As long as there is even one functioning link to the router, the loopback
interface can be accessed. The loopback interface thus eliminates the need to try each
IP address of the router until you find one that is still up.
Because the loopback interface is always up, a routing session (such as a BGP session)
can continue even if the outbound interface fails.
Rel VC4.1 v. 03
Vyatta
253
interfaces loopback lo
The loopback interface can be used as to increase security, by filtering incoming traffic
using access control rules that specify the local interface as the only acceptable
destination.
In OSPF, you can advertise a loopback interface as an interface route into the network,
regardless of whether physical links are up or down. This increases reliability, since the
the routing traffic is more likely to be received and subsequently forwarded.
In BGP, parallel paths can be configured to the loopback interface on a peer device.
This provides improved load sharing.
You can use the set form of this command to create the loopback interface. However, the
system automatically creates a configuration node for the loopback interface on startup, so
you should not need to use the set form of this command to create the loopback interface
unless you have deleted it.
Use the delete form of this command to remove all configuration for the loopback
interface. The system will create an empty configuration node for the interface the next
time the system starts.
Use the show form of this command to view Ethernet interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
254
Syntax
set interfaces loopback lo address {ipv4net | dhcp}
delete interfaces loopback lo address {ipv4net | dhcp}
show interfaces loopback lo address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
address: [ipv4net|dhcp]
}
}
Parameters
ipv4net
The IPv4 address and network prefix for this vif. The format is
ip-address/prefix (for example, 127.0.0.1/8).
You can define multiple IP addresses for the loopback interface by
creating multiple address configuration nodes.
dhcp
Default
None.
Usage Guidelines
The router automatically creates the loopback interface on startup, with an interface name
of lo. You must configure an IP address for the interface. The IP address for the loopback
interface must be unique, and must not be used by any other interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
255
When configuring the router, it is good practice to take advantage of the loopback
interfaces reliability:
The routers hostname should be mapped to the loopback interface address, rather than
a physical interface.
In OSPF and iBGP configurations, the router ID should be set to the loopback address.
The network for the loopback interface can be small, since IP address space is not a
consideration in this case. Often a network prefix of /32 is assigned.
Use the set form of this command to specify the IP address and network mask for the
loopback interface. You can set more than one IP address for the loopback interface by
creating multiple address configuration nodes.
Use the delete form of this command to remove the loopback interface address.
Use the show form of this command to view loopback interface address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
256
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces loopback lo description <de-
Syntax
set interfaces loopback lo description descr
delete interfaces loopback lo description
show interfaces loopback lo description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
description: text
}
}
Parameters
descr
Default
None.
Usage Guidelines
Use this command to set a description for the loopback interface.
Use the set form of this command to specify the description.
Use the delete form of this command to remove the description.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
257
Syntax
show interfaces ethernet [ethx]
Command Mode
Operational mode.
Parameters
ethx
Default
Information is displayed for all Ethernet interfaces.
Usage Guidelines
Use this command to view operational status of Ethernet interfaces.
Examples
Example 6-1 shows information for all Ethernet interfaces.
Example 6-1 show interfaces ethernet: Displaying Ethernet interface
Command Reference
Rel VC4.1 v. 03
Link
down
up
up
down
Description
Vyatta
258
Command Reference
packets
3572
packets
541
errors
0
errors
0
Rel VC4.1 v. 03
dropped
0
dropped
0
overrun
mcast
0
0
carrier collisions
0
0
Vyatta
259
Syntax
show interfaces ethernet detail
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to view detailed statistics and configuration information about Ethernet
interfaces.
Examples
Example 6-3 shows the first screen of output for show interfaces ethernet detail.
Example 6-3 show interfaces ethernet detail: Displaying detailed information about Ethernet interfaces
vyatta@vyatta:~$ show interfaces ethernet detail
eth0: <BROADCAST,MULTICAST> mtu 1500 qdisc noop qlen 1000
link/ether 00:40:63:e2:e4:00 brd ff:ff:ff:ff:ff:ff
RX:
TX:
bytes
0
bytes
0
packets
0
packets
0
errors
0
errors
0
dropped
0
dropped
0
overrun
mcast
0
0
carrier collisions
0
0
bytes
Command Reference
packets
errors
dropped
Rel VC4.1 v. 03
overrun
mcast
Vyatta
260
TX:
0
bytes
468
0
packets
6
0
errors
0
0
dropped
0
0
0
carrier collisions
0
0
Command Reference
Rel VC4.1 v. 03
Vyatta
261
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface show interfaces ethernet <ethx> brief
Syntax
show interfaces ethernet ethx brief
Command Mode
Operational mode.
Parameters
ethx
Default
None.
Usage Guidelines
Use this command to view the status of an Ethernet interface.
Examples
Example 6-4 shows brief status for interface eth2.
Example 6-4 show interfaces ethernet <ethx> brief: Displaying brief status for an Ethernet
interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
262
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceshow interfaces ethernet <ethx> identi-
Syntax
show interfaces ethernet ethx identify
Command Mode
Operational mode.
Parameters
ethx
Default
None.
Usage Guidelines
Use this command to help you identify a physical Ethernet port in order to map it to the ethx
identifier within the Vyatta system.
Examples
Example 6-5 shows the output for show interfaces ethernet ethx identify.
Example 6-5 show interfaces ethernet ethX identify: Blinks LEDs on an Ethernet
interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
263
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface show interfaces ethernet <ethx> physi-
Syntax
show interfaces ethernet ethx physical
Command Mode
Operational mode.
Parameters
ethx
Default
None.
Usage Guidelines
Use this command to view physical layer command and operational status of Ethernet
interfaces.
Examples
Example 6-6 shows output for show interfaces ethernet ethx physical.
Example 6-6 show interfaces ethernet ethX physical: Displaying physical line
characteristics for an Ethernet interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
264
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface show interfaces ethernet <ethx> physi-
Duplex: Full
Port: MII
PHYAD: 1
Transceiver: internal
Auto-negotiation: on
Supports Wake-on: pumbg
Wake-on: d
Current message level: 0x00000001 (1)
Link detected: yes
vyatta@vyatta:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
265
Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface show interfaces ethernet <ethx> queue
Syntax
show interfaces ethernet ethx queue [class | filter]
Command Mode
Operational mode.
Parameters
ethx
class
filter
Default
None.
Usage Guidelines
Use this command to view Ethernet queue information.
Examples
Example 6-7 shows queue information for interface eth0.
Example 6-7 show interfaces ethernet ethX queue: Displaying Ethernet queue information
vyatta@vyatta:~$ show interfaces ethernet eth0 queue
qdisc pfifo_fast 0: root bands 3 priomap 1 2 2 2 1 2 0 0 1 1 1 1 1 1 1 1
Sent 810323 bytes 6016 pkt (dropped 0, overlimits 0 requeues 0)
rate 0bit 0pps backlog 0b 0p requeues 0
Command Reference
Rel VC4.1 v. 03
Vyatta
266
Syntax
show interfaces ethernet ethx vif vlan-id
Command Mode
Operational mode.
Parameters
ethx
The Ethernet interface you are defining. The range is eth0 to eth23.
vlan-id
Default
None.
Usage Guidelines
Use this command to view command and operational status of Ethernet vifs.
Examples
Example 6-8 shows information for vif 11 on interface eth0
Example 6-8 show interfaces ethernet <ethX> vif <vlan-id>: Displaying Ethernet vif information
vyatta@vyatta:~$ show interfaces ethernet eth0 vif 11
eth0.11@eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue
link/ether 00:0c:29:da:3a:3d brd ff:ff:ff:ff:ff:ff
inet6 fe80::20c:29ff:feda:3a3d/64 scope link
valid_lft forever preferred_lft forever
RX:
bytes
0
Command Reference
packets
0
errors
0
dropped
0
Rel VC4.1 v. 03
overrun
0
mcast
0
Vyatta
267
TX:
bytes
2914
vyatta@vyatta:~$
Command Reference
packets
13
errors
0
dropped
0
Rel VC4.1 v. 03
carrier collisions
0
0
Vyatta
268
Syntax
show interfaces ethernet ethx vif vlan-id brief
Command Mode
Operational mode.
Parameters
ethx
vlan-id
Default
None.
Usage Guidelines
Use this command to view the status of a vif.
Examples
Example 6-9 shows brief status for interface eth2.6.
Example 6-9 show interfaces ethernet <ethx> vif <vlan-id> brief: Displaying brief status
for a vif.
Command Reference
Rel VC4.1 v. 03
Vyatta
269
Syntax
show interfaces ethernet ethx vif vlan-id queue [class | filter]
Command Mode
Operational mode.
Parameters
ethx
vlan-id
class
filter
Default
None.
Usage Guidelines
Use this command to view vif queue information.
Examples
Example 6-10 shows queue information for interface eth0.6.
Example 6-10 show interfaces ethernet <ethx> vif <vlan-id> queue: Displaying vif queue information
vyatta@vyatta:~$ show interfaces ethernet eth0 vif 6 queue
qdisc pfifo_fast 0: root bands 3 priomap 1 2 2 2 1 2 0 0 1 1 1 1 1 1 1 1
Sent 380009 bytes 5177 pkt (dropped 0, overlimits 0 requeues 0)
rate 0bit 0pps backlog 0b 0p requeues 0
Command Reference
Rel VC4.1 v. 03
Vyatta
270
Syntax
show interfaces loopback [lo]
Command Mode
Operational mode.
Parameters
lo
Default
Displays brief status information for the loopback interface.
Usage Guidelines
Use this command to view status of the loopback interface.
Examples
Example 6-11 shows brief status information for the loopback interface.
Example 6-11 show interfaces loopback: Displaying loopback interface status
information.
Command Reference
Rel VC4.1 v. 03
Link
up
Description
Vyatta
271
Command Reference
packets
0
packets
0
errors
0
errors
0
Rel VC4.1 v. 03
dropped
0
dropped
0
overrun
mcast
0
0
carrier collisions
0
0
Vyatta
272
Syntax
show interfaces loopback detail
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to view detailed information and statistics for the loopback interface.
Examples
Example 6-14 shows detailed information for the loopback interface.
Example 6-13 show interfaces loopback detail: Displaying detailed loopback interface
statistics and information.
Command Reference
packets
0
packets
0
errors
0
errors
0
Rel VC4.1 v. 03
dropped
0
dropped
0
overrun
mcast
0
0
carrier collisions
0
0
Vyatta
273
Syntax
show interfaces loopback lo brief
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to view status information for the loopback interface.
Examples
Example 6-14 shows brief status information for the loopback interface.
Example 6-14 show interfaces loopback lo brief: Displaying loopback interface status.
Command Reference
Rel VC4.1 v. 03
Vyatta
274
275
Description
276
Command
Description
interfaces serial <wanx> cisco-hdlc vif 1 address local-address Assign an IP address to a Cisco HDLC virtual
<ipv4>
interface.
interfaces serial <wanx> cisco-hdlc vif 1 address prefix-length Specifies the prefix defining the network served by a
<prefix>
virtual interface on a Cisco HDLC serial interface.
interfaces serial <wanx> cisco-hdlc vif 1 address
remote-address <ipv4>
Command Reference
Rel VC4.1 v. 03
Vyatta
277
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
278
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
279
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear interfaces serial [wanx counters {all | physical | cisco-hdlc | frame-relay | ppp}]
Command Mode
Operational mode.
Parameters
wanx
all
physical
Clears counters related to the physical line settings for the specified
interface.
cisco-hdlc
frame-relay
ppp
Usage Guidelines
Use this command to clear statistics for a specified serial interface.
When used with no option, this command clears all counters on all serial interfaces. When
a protocol or interface is specified, this command clears the counters for the specified
protocol on the specified interface.
Examples
Example 7-1 shows the result of the clear interfaces serial command used with no options.
Example 7-1 clear interfaces serial
Command Reference
Rel VC4.1 v. 03
Vyatta
280
Example 7-2 shows the result of the clear interfaces serial command use with the wan0
counters cisco-hdlc options.
Example 7-2 clear interfaces serial wan0 counters cisco-hdlc: Displaying the result of the
clear command.
Command Reference
Rel VC4.1 v. 03
Vyatta
281
Syntax
set interfaces serial wanx
delete interfaces serial wanx
show interfaces serial wanx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
None.
Usage Guidelines
Use this command to configure a serial interface. You can define multiple serial interfaces
by creating multiple serial configuration nodes.
Note that you cannot use set to change the name of the serial interface. To change the name
of a serial interface, you must delete the old serial configuration node and create a new one.
Command Reference
Rel VC4.1 v. 03
Vyatta
282
Use the set form of this command to create a serial interface, provided the interface
physically exists on your system. To see the interfaces available to the system kernel, use
the system option of the show interfaces command (see page 78).
Use the delete form of this command to remove all configuration for a serial interface.
Use the show form of this command to view a serial interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
283
Syntax
set interfaces serial wanx cisco-hdlc
delete interfaces serial wanx cisco-hdlc
show interfaces serial wanx cisco-hdlc
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
}
}
}
Parameters
wanx
Mandatory. The identifier for the serial interface you are defining. This
may be wan0 to wan23, depending on what serial interfaces that are
actually available on the system.
Default
None.
Usage Guidelines
Use this command to define the Cisco High-Level Data Link Control characteristics of the
line.
Note that on Cisco HDLC interfaces, IP addresses are assigned to virtual interfaces, not
directly to the interface. Currently, only one vif is supported, but multiple addresses may
be defined for the vif.
Command Reference
Rel VC4.1 v. 03
Vyatta
284
The full identifier of an HDLC interface is int cisco-hdlc vif vif. For example, the full
identifier of the HDLC vif on wan1 is wan1 cisco-hdlc vif 1. Note that subsequent to initial
definition, the notation for referring to this is int.vifthat is, wan1.1.
Use the set form of this command to create a cisco-hdlc serial interface, provided the
interface physically exists on your system.
To see the interfaces available to the system kernel, use the system option of the show
interfaces command (see page 78).
Note that you cannot use set to change the identifier of configuration nodes. To change the
identifier of a configuration node, you must delete the old configuration node and create a
new one with the correct identifier.
Use the delete form of this command to remove all configuration for a Cisco HDLC serial
interface.
Use the show form of this command to view Cisco HDLC serial interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
285
Syntax
set interfaces serial wanx cisco-hdlc keepalives [require-rx {enable | disable} | timer
interval]
delete interfaces serial wanx cisco-hdlc keepalives require-rx
show interfaces serial wanx cisco-hdlc keepalives require-rx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
keepalives {
require-rx: [enable|disable]
timer: 10-60000
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
require-rx
timer interval
Command Reference
Rel VC4.1 v. 03
Vyatta
286
Default
None.
Usage Guidelines
Use this command to set the characteristics of keep-alive messages on a Cisco HDLC
interface.
Use the set form of this command to specify keep-alive information.
Use the delete form of this command to restore the default keep-alive configuration.
Use the show form of this command to view keep-alive configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
287
Syntax
set interfaces serial wanx cisco-hdlc mru mru
delete interfaces serial wanx cisco-hdlc mru
show interfaces serial wanx cisco-hdlc mru
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
mru: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mru
The maximum packet size that the interface is willing to receive. The
range is 8 to 8188. The default is 1500.
Default
The MRU is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
288
Usage Guidelines
Use this command to specify the Maximum Receive Unit (MRU). This is the maximum
packet size the interface is willing to receive.
Use the set form of this command to specify the MRU
Use the delete form of this command to restore the default MRU.
Use the show form of this command to view MRU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
289
Syntax
set interfaces serial wanx cisco-hdlc mtu mtu
delete interfaces serial wanx cisco-hdlc mtu
show interfaces serial wanx cisco-hdlc mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
mtu: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mtu
The maximum packet size that the interface will send. The range is 8 to
8188. The default is 1500.
Default
The MTU is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
290
Usage Guidelines
Use this command to specify the Maximum Transmit Unit. This is the maximum packet
size the interface will send.
Use the set form of this command to specify the MTU.
Use the delete form of this command to restore the default MTU.
Use the show form of this command to view MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
291
Syntax
set interfaces serial wanx cisco-hdlc vif 1 address local-address ipv4
delete interfaces serial wanx cisco-hdlc vif 1 address local-address
show interfaces serial wanx cisco-hdlc vif 1 address local-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
address {
local-address: ipv4
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
ipv4
Mandatory. The IPv4 address for this vif. Each serial vif can support
exactly one IP address.
Rel VC4.1 v. 03
Vyatta
292
Default
None.
Usage Guidelines
Use this command to specify an IP address for a Cisco HDLC virtual interface.
Use the set form of this command to set the IP address.
Use the delete form of this command to remove IP address configuration.
Use the show form of this command to view IP address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
293
Syntax
set interfaces serial wanx cisco-hdlc vif 1 address prefix-length prefix
delete interfaces serial wanx cisco-hdlc vif 1 address prefix-length
show interfaces serial wanx cisco-hdlc vif 1 address prefix-length
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
address {
prefix-length: 0-32
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
prefix
Rel VC4.1 v. 03
Vyatta
294
Default
None.
Usage Guidelines
Use this command to specify the prefix defining the network served by this virtual
interface.
Use the set form of this command to specify the network prefix.
Use the delete form of this command to remove network prefix configuration.
Use the show form of this command to view network prefix configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
295
Syntax
set interfaces serial wanx cisco-hdlc vif 1 address remote-address ipv4
delete interfaces serial wanx cisco-hdlc vif 1 address remote-address
show interfaces serial wanx cisco-hdlc vif 1 address remote-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
address {
remote-address: ipv4
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
ipv4
Rel VC4.1 v. 03
Vyatta
296
Default
None.
Usage Guidelines
Use this command to specify the IP address representing the remote endpoint.
Use the set form of this command to set the remote endpoints IP address.
Use the delete form of this command to remove remote address configuration.
Use the show form of this command to view remote address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
297
Syntax
set interfaces serial wanx cisco-hdlc vif 1description desc
delete interfaces serial wanx cisco-hdlc vif 1 description
show interfaces serial wanx cisco-hdlc vif 1 description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
description: text
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
298
Usage Guidelines
Use this command to specify a description for the virtual interface.
Use the set form of this command to set the description for the virtual interface.
Use the delete form of this command to remove description configuration.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
299
Syntax
set interfaces serial wanx description desc
delete interfaces serial wanx description
show interfaces serial wanx description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
description: text
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
300
Usage Guidelines
Use this command to specify a description for the serial interface.
Use the set form of this command to set the description for the serial interface.
Use the delete form of this command to remove description configuration.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
301
Syntax
set interfaces serial wanx e1-options
delete interfaces serial wanx e1-options
show interfaces serial wanx e1-options
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e1-options
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
None.
Usage Guidelines
Use this command to specify the physical line characteristics of traffic that will pass
through this E1 serial interface.
Configuring this option designates this interface as an E1 interface for transmitting signals
in European digital transmission (E1) format. The E1 signal format carries information at
a rate of 2.048 Mbps and can carry 32 channels of 64 Kbps each.
Currently, only high-density bipolar of order 3 (hdb3) line encoding is supported.
Command Reference
Rel VC4.1 v. 03
Vyatta
302
Use the set form of this command to specify the physical line characteristics for E1 serial
interfaces.
Use the delete form of this command to remove E1 configuration.
Use the show form of this command to view E1 configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
303
Syntax
set interfaces serial wanx e1-options clock type
delete interfaces serial wanx e1-options clock
show interfaces serial wanx e1-options clock
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e1-options {
clock: [internal|external]
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Optional. Sets the timing source for the circuit. Supported values are as
follows:
internal: The interface will use the internal clock.
external: The interface will use the external DTE Tx and Rx clock.
The default is external.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
304
Usage Guidelines
Use this command to specify the clock source for an E1 circuit.
Use the set form of this command to set the E1 clock source.
Use the delete form of this command to restore the default E1 clock source.
Use the show form of this command to view E1 clock source configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
305
Syntax
set interfaces serial wanx e1-options framing type
delete interfaces serial wanx e1-options framing
show interfaces serial wanx e1-options framing
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e1-options {
framing: [g704|g704-no-crc4|unframed]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Sets the frame type for the interface. Supported values are as follows:
g704: Uses the G.704 framing specification and sets the E1 frame type
to use CRC4.
g704-no-crc: Uses the G.704 framing specification and sets the E1
frame type not to use CRC4.
unframed: Configures full-rate (2048 kbps) unchannelized E1
bandwidth for the line. E1 unframed signaling options are available only
on the Sangoma A104 line card.
The default is g704.
Command Reference
Rel VC4.1 v. 03
Vyatta
306
Default
The framing is according to the G.704 specification with CRC.
Usage Guidelines
Use this command to specify the framing for an E1 circuit.
Use the set form of this command to set the framing.
Use the delete form of this command to restore the default framing.
Use the show form of this command to view framing configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
307
Syntax
set interfaces serial wanx e1-options mru mru
delete interfaces serial wanx e1-options mru
show interfaces serial wanx e1-options mru
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e1-options {
mru: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mru
Default
The MRU is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
308
Usage Guidelines
Use this command to specify the Maximum Receive Unit. This is the maximum packet size
the interface is willing to receive.
Use the set form of this command to set the MRU.
Use the delete form of this command to restore the default MRU.
Use the show form of this command to view MRU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
309
Syntax
set interfaces serial wanx e1-options mtu mtu
delete interfaces serial wanx e1-options mtu
show interfaces serial wanx e1-options mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e1-options {
mtu: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mtu
Optional. Sets the Maximum Transfer Unit (MTU), in octets, for the
interface as a whole. This will apply to all vifs defined for the interface.
When forwarding, IPv4 packets larger than the MTU will be fragmented
unless the DF bit is set. In that case, the packets will be dropped and an
ICMP Packet too big message is returned to the sender.
The range is 8 to 8188. If not set, fragmentation will never be performed.
Default
Fragmentation is not performed
Command Reference
Rel VC4.1 v. 03
Vyatta
310
Usage Guidelines
Use this command to specify the Maximum Transfer Unit (MTU). This is the maximum
packet size the interface will send.
Use the set form of this command to set the MTU.
Use the delete form of this command to restore the default MTU behavior.
Use the show form of this command to view MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
311
Syntax
set interfaces serial wanx e1-options timeslots {start start | stop stop}
delete interfaces serial wanx e1-options timeslots [start | stop]
show interfaces serial wanx e1-options timeslots [start | stop]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e1-options {
timeslots {
start: 1-32
stop: 1-32
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
start start
The first timeslot in the range. The range of values is 1 to 32, where the
value of start must be less than the value of stop. The default is 1.
stop stop
The last timeslot in the range. The range of values is 1 to 32, where the
value of start must be less than the value of stop. The default is 32.
Default
The line is not channelized.
Command Reference
Rel VC4.1 v. 03
Vyatta
312
Usage Guidelines
Use this command to configure a fraction of a 32-channel channelized E1 line. To do this,
you assign a range of timeslots to the line.
Use the set form of this command to define timeslots for the line.
Use the delete form of this command to remove channelization configuration.
Use the show form of this command to view channelization configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
313
Syntax
set interfaces serial wanx e3-options
delete interfaces serial wanx e3-options
show interfaces serial wanx e3-options
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e3-options {
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
None.
Usage Guidelines
Use this command to specify the physical line characteristics for E3 serial interfaces.
Use the set form of this command to set the physical line characteristics.
Use the delete form of this command to remove physical line configuration.
Use the show form of this command to view physical line configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
314
Syntax
set interfaces serial wanx e3-options clock {internal | external}
delete interfaces serial wanx e3-options clock
show interfaces serial wanx e3-options clock
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e3-options {
clock: [internal|external]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Optional. Sets the timing source for the circuit. Supported values are as
follows:
internal: The interface will use the internal clock.
external: The interface will use the external DTE Tx and Rx clock.
The default is external.
Default
The interface uses the external DTE Tx and Rx clock.
Command Reference
Rel VC4.1 v. 03
Vyatta
315
Usage Guidelines
Use this command to specify the timing source for the circuit.
Use the set form of this command to set the timing source.
Use the delete form of this command to restore the default timing source.
Use the show form of this command to view timing source configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
316
Syntax
set interfaces serial wanx e3-options framing {g751 | g832 | unframed}
delete interfaces serial wanx e3-options framing
show interfaces serial wanx e3-options framing
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e3-options {
framing: [g751|g832|unframed]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Optional. Sets the frame type for the interface. Supported values are as
follows:
g751: Sets the E3 frame type to be G.751-compliant.
g832: Sets the E3 frame type to be G.832-compliant.
unframed: Configures full-rate (34368 kbps) unchannelized E3
bandwidth for the line.
Default
The frame type is G.751-compliant.
Command Reference
Rel VC4.1 v. 03
Vyatta
317
Usage Guidelines
Use this command to specify the framing type for an E3 interface.
Use the set form of this command to set the framing type.
Use the delete form of this command to restore the default E3 framing.
Use the show form of this command to view E3 framing configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
318
Syntax
set interfaces serial wanx e3-options line-coding {hdb3 | ami}
delete interfaces serial wanx e3-options line-coding
show interfaces serial wanx e3-options line-coding
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
e3-options {
line-coding: [hdb3|ami]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Optional. Sets the line coding for the interface. Supported values are as
follows:
hdb3: Sets the E3 line coding to be HDB3 (High Density Bipolar of
order 3) compliant.
ami: Sets the E3 line coding to be AMI (Alternate Mask Inversion)
compliant.
Default
HDB3 line coding is used.
Command Reference
Rel VC4.1 v. 03
Vyatta
319
Usage Guidelines
Use this command to specify the line coding type for the interface.
Use the set form of this command to set the line coding.
Use the delete form of this command to restore the default line coding.
Use the show form of this command to view line coding configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
320
Syntax
set interfaces serial wanx encapsulation type
delete interfaces serial wanx encapsulation
show interfaces serial wanx encapsulation
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
encapsulation: [ppp|cisco-hdlc|frame-relay]
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
321
Usage Guidelines
Use this command to specify the encapsulation type for a serial interface.
Use the set form of this command to set the encapsulation type.
Use the delete form of this command to remove encapsulation type configuration.
Use the show form of this command to view encapsulation type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
322
Syntax
set interfaces serial wanx frame-relay
delete interfaces serial wanx frame-relay
show interfaces serial wanx frame-relay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
None.
Usage Guidelines
Use this command to define Frame Relay settings on an interface. This consists primarily
of defining the signaling variant, the PVC characteristics, and the keep-alive (health
checking) characteristics of the line.
The full identifier of an Frame Relay interface is int frame-relay vif vif. For example, the
full identifier of the Frame Relay vif 16 on wan0 is wan0 frame-relay vif 16. Note that
subsequent to initial definition, the notation for referring to this is int.vifthat is, wan0.16.
Use the set form of this command to set Frame Relay characteristics.
Command Reference
Rel VC4.1 v. 03
Vyatta
323
Use the delete form of this command to remove all configuration for a Frame Relay serial
interface.
Use the show form of this command to view a Frame Relay serial interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
324
Syntax
set interfaces serial wanx frame-relay mru mru
delete interfaces serial wanx frame-relay mru
show interfaces serial wanx frame-relay mru
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
mru: 808188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mru
The maximum packet size that the interface is willing to receive. The
range is 8 to 8188. The default is 1500.
Default
The MRU is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
325
Usage Guidelines
Use this command to specify the Maximum Receive Unit on a Frame Relay serial interface.
This is the maximum packet size the interface is willing to receive.
Use the set form of this command to set the MRU.
Use the delete form of this command to restore the default MRU.
Use the show form of this command to view MRU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
326
Syntax
set interfaces serial wanx frame-relay mtu mtu
delete interfaces serial wanx frame-relay mtu
show interfaces serial wanx frame-relay mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
mtu: u32
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mtu
The maximum packet size that the interface will send. The range is 8 to
8188. The default is 1500.
Default
The MTU is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
327
Usage Guidelines
Use this command to specify the Maximum Transfer Unit (MTU) for a Frame Relay serial
interface. This is the maximum packet size the interface will send.
Use the set form of this command to set the MTU.
Use the delete form of this command to restore the default MTU configuration.
Use the show form of this command to view MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
328
Syntax
set interfaces serial wanx frame-relay signaling value
delete interfaces serial wanx frame-relay signaling
show interfaces serial wanx frame-relay signaling
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
signaling: [auto | ansi | q933 | lmi]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system. Sets the full status
message polling interval.
value
Command Reference
Rel VC4.1 v. 03
Vyatta
329
Default
LMI type is automatically negotiated.
Usage Guidelines
Use this command to specify the signaling variant (LMI type) for a Frame Relay serial
interface.
Use the set form of this command to set the signaling variant.
Use the delete form of this command to restore the default signaling variant.
Use the show form of this command to view signaling variant configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
330
Syntax
set interfaces serial wanx frame-relay signaling-options [n391dte value | n392dte value
| n393dte value | t391dte value | t392 value]
delete interfaces serial wanx frame-relay signaling-options
show interfaces serial wanx frame-relay signaling-options
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
signaling-options {
n391dte: 1-255
n392dte: 1-100
n393dte: 1-10
t391dte: 5-30
t392: 5-30
}
}
}
}
Parameters
wanx
Command Reference
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
331
n391dte value
Optional. Sets the frequency at which the DTE expects a full status
message in response to keep-alive messages. The DTE sends a
keep-alive request to the DCE at the interval specified by the t391dte
parameter. This parameter, n391dte, specifies the frequency at which
the DTE expects the response. For example, if n391dte is set to 6 it
means that the DTE expects a full status message to be sent in response
to every 6th status enquiry.
The range is 1 to 255. The default is 6.
n392dte value
Optional. Sets the DTE error threshold, which is the number of errors
which, if they occur within the event count specified by the n393dte
parameter, the link will be declared down.
The range is 1 to 100. The default is 6.
n393dte value
Optional. Sets the DTE monitored event count. This parameter is used
in conjunction with the number of errors specified in the n392dte
parameter to determine whether a link should be declared down. If
n392dte errors occur within n393dte events, the link is considered
down.
The range is 1 to 10. The default is 4.
t391dte value
Optional. Sets the DTE keep-alive timer. This is the interval, in seconds,
at which the interface sends out a keep-alive request to the DCE
interface, which should respond with a keep-alive message.
At the interval defined by the n391dte option, the DCE will send a full
status report instead of just a keep-alive message.
The range is 5 to 30. The default is 10.
t392 value
Default
The default value for each parameter is used.
Command Reference
Rel VC4.1 v. 03
Vyatta
332
Usage Guidelines
Use this command to specify the Frame Relay signaling options. These options control how
often the keepalive and full status enquiries are sent and expected.
Use the set form of this command to specify the signaling option for the interface.
Use the delete form of this command to remove the configuration.
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
333
Syntax
set interfaces serial wanx frame-relay vif dlci address local-address ipv4
delete interfaces serial wanx frame-relay vif dlci address local-address
show interfaces serial wanx frame-relay vif dlci address local-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
address {
local-address: ipv4
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
ipv4
Mandatory. The IPv4 address for this vif. Each serial vif can support
exactly one IP address.
Rel VC4.1 v. 03
Vyatta
334
Default
None.
Usage Guidelines
Use this command to specify the IP address for a Frame Relay virtual interface.
Use the set form of this command to set the IP address.
Use the delete form of this command to remove IP address configuration.
Use the show form of this command to view IP address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
335
Syntax
set interfaces serial wanx frame-relay vif dlci address prefix-length prefix
delete interfaces serial wanx frame-relay vif dlci address prefix-length
show interfaces serial wanx frame-relay vif dlci address prefix-length
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
address {
prefix-length: 0-32
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
prefix
Rel VC4.1 v. 03
Vyatta
336
Default
None.
Usage Guidelines
Use this command to specify the prefix defining the network served by this virtual
interface.
Use the set form of this command to set the network prefix.
Use the delete form of this command to remove network prefix configuration.
Use the show form of this command to view network prefix configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
337
Syntax
set interfaces serial wanx frame-relay vif dlci address remote-address ipv4
delete interfaces serial wanx frame-relay vif dlci address remote-address
show interfaces serial wanx frame-relay vif dlci address remote-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
address {
remote-address: ipv4
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
ipv4
Rel VC4.1 v. 03
Vyatta
338
Default
None.
Usage Guidelines
Use this command to specify the IP address of the remote endpoint of a Frame Relay
connection.
Use the set form of this command to set the remote address.
Use the delete form of this command to remove remote address configuration.
Use the show form of this command to view remote address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
339
Syntax
set interfaces serial wanx frame-relay vif dlci description desc
delete interfaces serial wanx frame-relay vif dlci description
show interfaces serial wanx frame-relay vif dlci description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
description: text
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
340
Usage Guidelines
Use this command to specify a description for a Frame Relay virtual interface.
Use the set form of this command to specify the description.
Use the delete form of this command to remove description configuration.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
341
Syntax
set interfaces serial wanx frame-relay vif dlci pvc rx-inverse-arp state
delete interfaces serial wanx frame-relay vif dlci pvc rx-inverse-arp
show interfaces serial wanx frame-relay vif dlci pvc rx-inverse-arp
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
pvc {
rx-inverse-arp: [enable|disable]
}
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
vlan-id
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
state
Command Reference
Rel VC4.1 v. 03
Vyatta
342
Default
Receiving of inverse ARP messages is disabled.
Usage Guidelines
Use this command to enable or disable inverse Address Resolution Protocol (inverse ARP)
on this virtual interface. Inverse ARP allows you to determine a hosts hardware address
from its network address.
Use the set form of this command to enable or disable receiving inverse ARP on the virtual
interface.
Use the delete form of this command to restore the default inverse ARP reception behavior.
Use the show form of this command to view inverse ARP reception configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
343
Syntax
set interfaces serial wanx frame-relay vif dlci pvc tx-inverse-arp value
delete interfaces serial wanx frame-relay vif dlci pvc tx-inverse-arp
show interfaces serial wanx frame-relay vif dlci pvc tx-inverse-arp
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
pvc {
tx-inverse-arp: 0-84600
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
vlan-id
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
value
Sets a limit on the number of inverse ARP messages that will be sent by
the system for use in dynamic address-to-DLCI mapping. The range is 0
to 86400, where 0 means there is no limit.
Rel VC4.1 v. 03
Vyatta
344
Default
There is no limit to the number of inverse ARP messages that can be sent from the interface.
Usage Guidelines
Use this command to set the maximum number of inverse Address Resolution Protocol
(inverse ARP) messages that can be sent from a Frame Relay virtual interface. Inverse ARP
allows you to determine a hosts hardware address from its network address.
Use the set form of this command to set the inverse ARP transmission limit.
Use the delete form of this command to restore the default inverse ARP transmission limit
behavior.
Use the show form of this command to view inverse ARP transmission limit configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
345
Syntax
set interfaces serial wanx ppp
delete interfaces serial wanx ppp
show interfaces serial wanx ppp
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
None.
Usage Guidelines
Use this command to define Point-to-Point Protocol (PPP) settings on an interface.
The full identifier of a Point-to-Point Protocol interface is int ppp vif vif. For example, the
full identifier of the point-to-point vif on wan1 is wan1 ppp vif 1. Note that subsequent to
initial definition, the notation for referring to this is int.vifthat is, wan1.1.
Command Reference
Rel VC4.1 v. 03
Vyatta
346
PPP connections can be bundled to form a multilink PPP connection. To do this, use the
multilink option to specify the identifier of the multilink bundle to which the connection
will belong.
When PPP connections are bundled into a multilink, the settings on the multilink override
the settings on the individual PPP link. The exceptions is authentication (authentication
settings specified for individual PPP links override authentication settings for the multilink)
and MTU/MRU/MRRU.
A transmitted packet may not be larger than the remote device is willing to receive. The
actual MTU is the smaller of the configured MTU of the local device and the configured
MRU of the remote device; this value is determined by MRU negotiation when the link is
established.
The interaction between MTU/MRU in PPP links and MTU/MRRU in a multilink bundle
is as follows:
If MTU is unconfigured in both the member PPP link and the multilink bundle, the
default for member links is used.
If MTU is set in member links but not in the multilink bundle, the configured value for
member links is used. These must match for every PPP link in the bundle.
If MTU is set in the multilink bundle, it overrides any value (default or configured) for
member links.
MRRU (for the multilink bundle) and MRU (for member links) are configured
independently and used separately during MRU negotiation. If neither is set, the MRU
default value is used for MRU and the MRRU default value is used for MRRU.
LCP echo is a heartbeat-like mechanism for determining the operational status of a peer.
This feature can be used to terminate a connection after the physical connection has been
broken (for example, if the modem has hung up) in situations where no hardware modem
control lines are available.
Use the set form of this command to define Point-to-Point Protocol (PPP) settings on an
interface.
Use the delete form of this command to remove all configuration for a PPP serial interface.
Use the show form of this command to view a PPP serial interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
347
Syntax
set interfaces serial wanx ppp authentication [password password | peer-password
password | peer-system-name name | peer-user-id user-id | refuse-type type |
system-name name | type type | user-id user-id]
delete interfaces serial wanx ppp authentication
show interfaces serial wanx ppp authentication
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
authentication {
password: text
peer-password: text
peer-system-name: text
peer-user-id: text
refuse-type: [none|chap|pap|papchap|mschap|mschap-v2|
eap]
system-name: text
type: [none|chap|pap|papchap|mschap|mschap-v2|eap|
any]
user-id: text
}
}
}
}
Parameters
wanx
Command Reference
Rel VC4.1 v. 03
Vyatta
348
password password
peer-password password
peer-system-name name
peer-user-id user-id
refuse-type type
system-name name
Command Reference
Rel VC4.1 v. 03
Vyatta
349
type type
user-id user-id
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
350
Usage Guidelines
Use this command to set the authentication parameters for a Point-to-Point protocol (PPP)
serial interface. These authentication requirements must be satisfied before network
packets are sent or received.
Use the set form of this command to set the authentication parameters.
Use the delete form of this command to remove authentication configuration or restore
default information.
Use the show form of this command to view authentication configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
351
Syntax
set interfaces serial wanx ppp lcp-echo-failure value
delete interfaces serial wanx ppp lcp-echo-failure
show interfaces serial wanx ppp lcp-echo-failure
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
lcp-echo-failure: u32
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
value
Optional. Sets the LCP echo failure threshold. The failure threshold is
the maximum number of LCP echo-requests that can be sent without
receiving a valid LCP echo-reply. If this threshold is met, the peer is
considered to be dead and the connection is terminated. The default is 3.
If this parameter is set, the lcp-echo-interval parameter must also be set.
Default
A maximum of 3 LCP echo-requests can be sent without receiving a valid LCP echo-reply.
Command Reference
Rel VC4.1 v. 03
Vyatta
352
Usage Guidelines
Use this command to specify the LCP echo failure threshold for a Point-to-Point Protocol
(PPP) serial interface.
Use the set form of this command to set the LCP echo failure threshold.
Use the delete form of this command to restore the default LCP echo failure threshold
configuration.
Use the show form of this command to view LCP echo failure threshold configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
353
Syntax
set interfaces serial wanx ppp lcp-echo-interval value
delete interfaces serial wanx ppp lcp-echo-interval
show interfaces serial wanx ppp lcp-echo-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
lcp-echo-interval: u32
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
interval
Optional. Sets the LCP echo interval, in seconds. This is the number of
seconds between LCP echo-requests. LCP echoes are used to determine
whether the connection is still operational. The default is 3.
Specifying a low value for this parameter allows fast detection of failed
links. The value set for this parameter must match the value set on the
peer.
Default
LCP echo-requests are sent at 3-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
354
Usage Guidelines
Use this command to specify the LCP echo interval for a Point-to-Point Protocol (PPP
serial interface.
Use the set form of this command to set the LCP echo interval.
Use the delete form of this command to remove LCP echo interval configuration.
Use the show form of this command to view LCP echo interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
355
Syntax
set interfaces serial wanx ppp logging state
delete interfaces serial wanx ppp logging
show interfaces serial wanx ppp logging
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
authentication {
logging: [on | off]
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
state
Command Reference
Rel VC4.1 v. 03
Vyatta
356
Default
Logging of debugging messages is disabled.
Usage Guidelines
Use this command to enable or disable logging of debugging messages for the
Point-to-Point protocol (PPP) process.
Use the set form of this command to specify whether to enable or disable debugging on a
PPP serial interface.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view PPP logging configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
357
Syntax
set interfaces serial wanx ppp mru mru
delete interfaces serial wanx ppp mru
show interfaces serial wanx ppp mru
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
mru: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mru
The maximum packet size that the interface is willing to receive. The
range is 8 to 8188. The default is 1500.
Default
The default is 1500.
Usage Guidelines
Use this command to specify the Maximum Receive Unit (MRU) for a Point-to-Point
Protocol (PPP) serial interface. This is the maximum packet size the interface is willing to
receive.
Command Reference
Rel VC4.1 v. 03
Vyatta
358
Command Reference
Rel VC4.1 v. 03
Vyatta
359
Syntax
set interfaces serial wanx ppp mtu mtu
delete interfaces serial wanx ppp mtu
show interfaces serial wanx ppp mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
mtu: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mtu
The maximum packet size that the interface will send. The range is 8 to
8188. The default is 1500.
Default
The default is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
360
Usage Guidelines
Use this command to specify the Maximum Transmit Unit (MTU) for a Point-to-Point
Protocol (PPP) serial interface. This is the maximum packet size the interface will send.
Use the set form of this command to set the MTU.
Use the delete form of this command to restore the default MTU value.
Use the show form of this command to view MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
361
Syntax
set interfaces serial wanx ppp multilink bundle
delete interfaces serial wanx ppp multilink
show interfaces serial wanx ppp multilink
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
multilink: ml0..ml23
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
bundle
The multilink bundle to which to assign this PPP link. The multilink
interface must already be defined.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
362
Usage Guidelines
Use this command to assign a Point-to-Point Protocol (PPP) link to a multilink PPP
(MLPPP) bundle. For information about defining MLPPP interfaces, see Chapter 8:
Multilink Interfaces.
All options defined on the multilink interface override those specified for an individual
link, except for authentication.
Use the set form of this command to assign this PPP link to the specified multilink bundle.
Use the delete form of this command to remove MLPPP configuration.
Use the show form of this command to view MLPPP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
363
Syntax
set interfaces serial wanx ppp vif 1 address local-address ipv4
delete interfaces serial wanx ppp vif 1 address local-address
show interfaces serial wanx ppp vif 1 address local-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
address {
local-address: ipv4
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
ipv4
Mandatory. The IPv4 address for this vif. Each serial vif can support
exactly one IP address.
Rel VC4.1 v. 03
Vyatta
364
Default
None.
Usage Guidelines
Use this command to specify an IP address for a virtual interface on a Point-to-Point
Protocol (PPP) serial interface.
Use the set form of this command to set the IP address.
Use the delete form of this command to remove IP address configuration.
Use the show form of this command to view IP address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
365
Syntax
set interfaces serial wanx ppp vif 1 address prefix-length prefix
delete interfaces serial wanx ppp vif 1 address prefix-length
show interfaces serial wanx ppp vif 1 address prefix-length
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
address {
prefix-length: u32
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
prefix
Rel VC4.1 v. 03
Vyatta
366
Default
None.
Usage Guidelines
Use this command to specify the prefix defining the network served by a virtual interface
on a Point-to-Point Protocol (PPP) serial interface.
Use the set form of this command to specify the network prefix.
Use the delete form of this command to remove network prefix configuration.
Use the show form of this command to view network prefix configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
367
Syntax
set interfaces serial wanx ppp vif 1 address remote-address ipv4
delete interfaces serial wanx ppp vif 1 address remote-address
show interfaces serial wanx ppp vif 1 address remote-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
address {
remote-address: ipv4
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
ipv4
Rel VC4.1 v. 03
Vyatta
368
Default
None.
Usage Guidelines
Use this command to specify the IP address of the remote endpoint in a Point-to-Point
Protocol link.
Use the set form of this command to set the remote address.
Use the delete form of this command to remove remote address configuration.
Use the show form of this command to view remote address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
369
Syntax
set interfaces serial wanx ppp vif 1 description desc
delete interfaces serial wanx ppp vif 1 description
show interfaces serial wanx ppp vif 1 description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
description: text
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
370
Usage Guidelines
Use this command to specify a description for a virtual interface on a Point-to-Point
Protocol (PPP) serial interface.
Use the set form of this command to set the description.
Use the delete form of this command to remove description configuration.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
371
Syntax
set interfaces serial wanx qos-policy out policy
delete interfaces serial wanx qos-policy out
show interfaces serial wanx qos-policy out
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
qos-policy {
out {
policy: text
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
policy
A defined QoS policy. For information about defining QoS policies, see
Chapter 18: Quality of Service Policies.
Default
No policy is assigned.
Command Reference
Rel VC4.1 v. 03
Vyatta
372
Usage Guidelines
Use this command to apply a Quality of Service (QoS) policy to outbound traffic on a serial
interface.
Use the set form of this command to specify the outbound QoS policy.
Use the delete form of this command to remove outbound QoS policy configuration.
Use the show form of this command to view outbound QoS policy configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
373
Syntax
set interfaces serial wanx t1-options
delete interfaces serial wanx t1-options
show interfaces serial wanx t1-options
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t1-options
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
None.
Usage Guidelines
Use this command to specify the physical line characteristics of traffic that will pass
through a T1 serial interface.
Configuring this option designates this interface as a T1 interface for transmitting digital
signals in the T-carrier system used in the United States, Japan, and Canada. The T1 signal
format carries 24 pulse code modulation (PCM) signals using time-division multiplexing
(TDM) at an overall rate of 1.544 Mbps.
Command Reference
Rel VC4.1 v. 03
Vyatta
374
Command Reference
Rel VC4.1 v. 03
Vyatta
375
Syntax
set interfaces serial wanx t1-options clock type
delete interfaces serial wanx t1-options clock
show interfaces serial wanx t1-options clock
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t1-options {
clock: [internal|external]
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Optional. Sets the timing source for the circuit. Supported values are as
follows:
internal: The interface will use the internal clock.
external: The interface will use the external DTE Tx and Rx clock.
The default is external.
Default
The interface uses the external DTE Tx and Rx clock.
Command Reference
Rel VC4.1 v. 03
Vyatta
376
Usage Guidelines
Use this command to specify the clock source for a T1 serial interface.
Use the set form of this command to set the T1 clock source.
Use the delete form of this command to restore the default T1 clock source.
Use the show form of this command to view T1 clock source configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
377
Syntax
set interfaces serial wanx t1-options lbo range
delete interfaces serial wanx t1-options lbo
show interfaces serial wanx t1-options lbo
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t1-options {
lbo: [0-110ft|110-220ft|220-330ft|330-440ft|440-550ft]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
range
Command Reference
Rel VC4.1 v. 03
Vyatta
378
Default
The line build-out length is 0 to 110 feet.
Usage Guidelines
Use this command to specify the line build-out (LBO) range for the T1 line.
Use the set form of this command to set the LBO.
Use the delete form of this command to restore the default LBO.
Use the show form of this command to view LBO configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
379
Syntax
set interfaces serial wanx t1-options mru mru
delete interfaces serial wanx t1-options mru
show interfaces serial wanx t1-options mru
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t1-options {
mru: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mru
Default
The default is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
380
Usage Guidelines
Use this command to specify the MRU for a T1 serial interface. This is the maximum
packet size the interface is willing to receive.
Use the set form of this command to set the MRU.
Use the delete form of this command to remove MRU configuration.
Use the show form of this command to view MRU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
381
Syntax
set interfaces serial wanx t1-options mtu mtu
delete interfaces serial wanx t1-options mtu
show interfaces serial wanx t1-options mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t1-options {
mtu: 8-8188
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
mtu
Optional. Sets the Maximum Transfer Unit (MTU), in octets, for the
interface as a whole. This will apply to all vifs defined for the interface.
When forwarding, IPv4 packets larger than the MTU will be fragmented
unless the DF bit is set. In that case, the packets will be dropped and an
ICMP Packet too big message is returned to the sender.
The range is 8 to 8188. If not set, fragmentation is never performed.
Default
Fragmentation is never performed.
Command Reference
Rel VC4.1 v. 03
Vyatta
382
Usage Guidelines
Use this command to specify the Maximum Transmit Unit (MTU) for a T1 serial interface.
This is the maximum packet size the interface will send.
Use the set form of this command to set the MTU.
Use the delete form of this command to remove MTU configuration.
Use the show form of this command to view MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
383
Syntax
set interfaces serial wanx t1-options timeslots {start start | stop stop}
delete interfaces serial wanx t1-options timeslots [start | stop]
show interfaces serial wanx t1-options timeslots [start | stop]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t1-options {
timeslots {
start: u32
stop: u32
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
start start
The first timeslot in the range. The range of values is 1 to 32, where the
value of start must be less than the value of stop. The default is 1.
stop stop
The last timeslot in the range. The range of values is 1 to 32, where the
value of start must be less than the value of stop. The default is 32.
Default
T1 lines are not channelized.
Command Reference
Rel VC4.1 v. 03
Vyatta
384
Usage Guidelines
Use this command to configure channelization on a 24-channel T1 line. To do this, you
assign a range of timeslots to the line.
Use the set form of this command to define timeslots for the line.
Use the delete form of this command to remove channelization configuration.
Use the show form of this command to view channelization configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
385
Syntax
set interfaces serial wanx t3-options
delete interfaces serial wanx t3-options
show interfaces serial wanx t3-options
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t3-options {
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
None.
Usage Guidelines
Use this command to specify the physical line characteristics of traffic that will pass
through this T3 serial interface.
Configuring this option designates this interface as a T3 interface for transmitting digital
signals in the T-carrier system used in the United States, Japan, and Canada. The T3 signal
format carries multiple T1 channels multiplexed, resulting in transmission rates of up to
44.736 Mbit/s.
Command Reference
Rel VC4.1 v. 03
Vyatta
386
Use the set form of this command to specify the physical line characteristics for the T3
interface.
Use the delete form of this command to remove T1 physical line configuration.
Use the show form of this command to view T1 physical line configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
387
Syntax
set interfaces serial wanx t3-options clock type
delete interfaces serial wanx t3-options clock
show interfaces serial wanx t3-options clock
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t3-options {
clock: [internal | external]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Optional. Sets the timing source for the circuit. Supported values are as
follows:
internal: The interface will use the internal clock.
external: The interface will use the external DTE Tx and Rx clock.
The default is external.
Default
The interface uses the external DTE Tx and Rx clock.
Command Reference
Rel VC4.1 v. 03
Vyatta
388
Usage Guidelines
Use this command to specify the timing source for a T3 serial interface.
Use the set form of this command to set the clock source.
Use the delete form of this command to remove clock source configuration.
Use the show form of this command to view clock source configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
389
Syntax
set interfaces serial wanx t3-options framing type
delete interfaces serial wanx t3-options framing
show interfaces serial wanx t3-options framing
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t3-options {
framing: [c-bit|ml3]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Optional. Sets the frame type for the interface. Supported values are as
follows:
c-bit: Sets the T3 frame type to C-bit parity
m13: Sets the T3 frame type to M13.
The default is c-bit.
Default
T3 interfaces use C-bit parity framing.
Command Reference
Rel VC4.1 v. 03
Vyatta
390
Usage Guidelines
Use this command to specify the framing type for a T3 serial interface.
Use the set form of this command to set the framing type.
Use the delete form of this command to remove framing type configuration.
Use the show form of this command to view framing type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
391
Syntax
set interfaces serial wanx t3-options line-coding type
delete interfaces serial wanx t3-options line-coding
show interfaces serial wanx t3-options line-coding
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
t3-options {
line-coding: [ami|b3zs]
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
type
Default
T3 serial lines use bipolar 3-zero substitution line coding.
Command Reference
Rel VC4.1 v. 03
Vyatta
392
Usage Guidelines
Use this command to specify the line coding type for a T3 serial interface.
Use the set form of this command to set the line coding type.
Use the delete form of this command to remove line coding type configuration.
Use the show form of this command to view line coding type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
393
Syntax
show interfaces serial [wanx {cisco-hdlc | frame-relay [pvc | pvc-list [active]] | physical
| ppp | trace}]
Command Mode
Operational mode.
Parameters
wanx
cisco-hdlc
frame-relay
pvc
pvc-list
Lists of Frame Relay permanent virtual circuits (PVCs). When used with
no option, displays all configured PVCs.
active
physical
ppp
trace
Outputs a trace of the raw frames incoming from, and outgoing to, the
specified interface. This trace continues until <Ctrl>-c is pressed.
Default
Information is shown for all available serial interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
394
Usage Guidelines
Use this command to view the operational status of a serial interface.
Examples
Example 7-3 shows the first screen of output for show interfaces serial.
Example 7-3 show interfaces serial: Displaying serial interface information
Command Reference
Rel VC4.1 v. 03
Vyatta
395
Example 7-4 shows the output for show interfaces serial wanx ppp.
Example 7-4 show interfaces serial wanx ppp
0
0
0
0
0
0
0
0
0
0
Example 7-5 shows the output for show interfaces serial wanx trace.
NOTE
OUTGOING
[1/100s]
Raw (HEX)
FR decode
OUTGOING
[1/100s]
Command Reference
TimeStamp=56407
FC F1 03 09 00 75 01 01 01 03 02 A7 00
DLCI=1023 C/R=0 EA=0 FECN=0 BECN=0 DE=0 EA=1
Signalling ANSI
Link Verification Req
Sx=0x00 Rx=0x01
Len=13
TimeStamp=56408
Rel VC4.1 v. 03
Vyatta
396
Raw (HEX)
00 01 03 08 00 75 51 01 01 53 02 A7 00
FR decode
INCOMING
[1/100s]
Raw (HEX)
FR decode
INCOMING
[1/100s]
FR decode
INCOMING
[1/100s]
Raw (HEX)
FR decode
Command Reference
Len=14
TimeStamp=56560
00 01 03 08 00 75 95 01 01 01 03 02 A7 00
DLCI=0 C/R=0 EA=0 FECN=0 BECN=0 DE=0 EA=1
Signalling ANSI
Link Verification Req
Sx=0xA7 Rx=0x00
Len=13
TimeStamp=56561
TimeStamp=56561
00 01 03 08 00 75 51 01 01 53 02 A7 00
DLCI=0 C/R=0 EA=0 FECN=0 BECN=0 DE=0 EA=1
Signalling ANSI
Link Verification Req
Sx=0x00 Rx=0x00
Rel VC4.1 v. 03
Vyatta
397
398
Description
399
Command
Description
interfaces multilink <mlx> vif 1 address local-address <ipv4> Sets the IP address for a virtual interface on a
multilink interface.
interfaces multilink <mlx> vif 1 address prefix-length
<prefix>
Operational Commands
clear interfaces multilink
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear interfaces multilink [ml0..ml23]
Command Mode
Operational mode.
Parameters
ml0..ml23
Usage Guidelines
Use this command to clear statistics for a specified multilink interface.
If no multilink interface is specified then statistics are cleared on all multilink interfaces.
Examples
Example 8-1 clears statistics on all multilink interfaces.
Example 8-1 clear interfaces multilink: Clearing multilink statistics
Command Reference
Rel VC4.1 v. 03
Vyatta
400
Command Reference
Rel VC4.1 v. 03
Vyatta
401
Syntax
set interfaces multilink mlx
delete interfaces multilink mlx
show interfaces multilink mlx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
}
}
Parameters
mlx
Default
None.
Usage Guidelines
Use this command to define a multilink bundle. A multilink bundle allows the bandwidth
of individual links to be combined into a single virtual link.
Multilink bundling is currently supported only for point-to-point protocol (PPP) links. You
can create up to two multilink bundles and each bundle can include eight individual PPP
links.
To combine multiple serial interfaces into a single multilink bundle you create both the
multilink interface and the individual serial interfaces. Individual links are assigned to the
bundle using the multilink parameter of the interfaces serial <wanx> ppp authentication
command (see page 348).
Command Reference
Rel VC4.1 v. 03
Vyatta
402
When PPP connections are bundled into a multilink, the settings on the multilink override
the settings on the individual PPP link. The exceptions is authentication (authentication
settings specified for individual PPP links override authentication settings for the multilink)
and MTU/MRU/MRRU.
A transmitted packet may not be larger than the remote device is willing to receive. The
actual MTU is the smaller of the configured MTU of the local device and the configured
MRU of the remote device; this value is determined by MRU negotiation when the link is
established.
The interaction between MTU/MRU in PPP links and MTU/MRRU in a multilink bundle
is as follows:
If MTU is unconfigured in both the member PPP link and the multilink bundle, the
default for member links is used.
If MTU is set in member links but not in the multilink bundle, the configured value for
member links is used. These must match for every PPP link in the bundle.
If MTU is set in the multilink bundle, it overrides any value (default or configured) for
member links.
MRRU (for the multilink bundle) and MRU (for member links) are configured
independently and used separately during MRU negotiation. If neither is set, the MRU
default value is used for MRU and the MRRU default value is used for MRRU.
In multilink bundles, if an individual member link goes down, the multilink bundle remains
up, and if the member link becomes operational again it will become a member of the same
bundle. If all member links fail, the multilink bundle will also fail, but will become
operational again if any of the member links comes back up.
Use the set form of this command to define multilink settings on an interface.
Use the delete form of this command to remove all configuration for a multilink interface.
Use the show form of this command to view a multilink interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
403
Syntax
set interfaces multilink mlx authentication [password password | peer-password
password | peer-system-name name | peer-user-id user-id | refuse-type type |
system-name name | type type | user-id user-id]
delete interfaces multilink mlx authentication
show interfaces multilink mlx authentication
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
authentication {
password: text
peer-password: text
peer-system-name: text
peer-user-id: text
refuse-type: [none|chap|pap|papchap|mschap|mschap-v2|eap]
system-name: text
type: [none|chap|pap|papchap|mschap|mschap-v2|eap|any]
user-id: text
}
}
}
Parameters
Command Reference
mlx
password password
peer-password password
Rel VC4.1 v. 03
Vyatta
404
peer-system-name name
peer-user-id user-id
refuse-type type
system-name name
Command Reference
Rel VC4.1 v. 03
Vyatta
405
type type
user-id user-id
Default
None.
Usage Guidelines
Use this command to set the authentication parameters for a multilink interface. These
authentication requirements must be satisfied before network packets are sent or received.
Use the set form of this command to set the authentication parameters.
Command Reference
Rel VC4.1 v. 03
Vyatta
406
Use the delete form of this command to remove authentication configuration or restore
default information.
Use the show form of this command to view authentication configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
407
Syntax
set interfaces multilink mlx description desc
delete interfaces multilink mlx description
show interfaces multilink mlx description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
description: text
}
}
Parameters
mlx
desc
Default
None.
Usage Guidelines
Use this command to specify a description for a virtual interface on a multilink interface.
Use the set form of this command to set the description.
Use the delete form of this command to remove description configuration.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
408
Syntax
set interfaces multilink mlx lcp-echo-failure value
delete interfaces multilink mlx lcp-echo-failure
show interfaces multilink mlx lcp-echo-failure
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
lcp-echo-failure: u32
}
}
Parameters
mlx
value
Optional. Sets the LCP echo failure threshold. The failure threshold is
the maximum number of LCP echo-requests that can be sent without
receiving a valid LCP echo-reply. If this threshold is exceeded, the peer
is considered to be dead and the connection is terminated.
The value specified must be a non-zero number. The default is 3.
Deleting this value does not disable LCP echoes, but instead restores the
default value.
If this parameter is set, the lcp-echo-interval parameter must also be set.
Default
A maximum of 3 LCP echo-requests can be sent without receiving a valid LCP echo-reply.
Command Reference
Rel VC4.1 v. 03
Vyatta
409
Usage Guidelines
Use this command to specify the LCP echo failure threshold for a multilink interface.
Use the set form of this command to set the LCP echo failure threshold.
Use the delete form of this command to restore the default LCP echo failure threshold
configuration.
Use the show form of this command to view LCP echo failure threshold configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
410
Syntax
set interfaces multilink mlx lcp-echo-interval value
delete interfaces multilink mlx lcp-echo-interval
show interfaces multilink mlx lcp-echo-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
lcp-echo-interval: u32
}
}
Parameters
mlx
interval
Optional. Sets the LCP echo interval, which is the number of seconds
between LCP echoes. LCP echoes are used to determine whether the
connection is still operational.
The value specified must be a non-zero number. The default is 3.
Deleting this value does not disable LCP echoes, but instead restores the
default value.
Specifying a low value for this parameter allows fast detection of failed
links. The value set for this parameter must match the value set on the
peer.
Command Reference
Rel VC4.1 v. 03
Vyatta
411
Default
LCP echo-requests are sent at 3-second intervals.
Usage Guidelines
Use this command to specify the LCP echo interval for a multilink interface.
Use the set form of this command to set the LCP echo interval.
Use the delete form of this command to remove LCP echo interval configuration.
Use the show form of this command to view LCP echo interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
412
Syntax
set interfaces multilink mlx logging state
delete interfaces multilink mlx logging
show interfaces multilink mlx logging
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
authentication {
logging: [on | off]
}
}
}
Parameters
mlx
state
Command Reference
Rel VC4.1 v. 03
Vyatta
413
Default
Logging of debugging messages is disabled.
Usage Guidelines
Use this command to enable or disable logging of debugging messages for the multilink
process.
Use the set form of this command to specify whether to enable or disable debugging on a
multilink interface.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view multilink logging configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
414
Syntax
set interfaces multilink mlx mru mru
delete interfaces multilink mlx mru
show interfaces multilink mlx mru
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
mrru: 8-8188
}
}
Parameters
mlx
mrru
Default
The default is 1600.
Command Reference
Rel VC4.1 v. 03
Vyatta
415
Usage Guidelines
Use this command to specify the Maximum Reconstructed Receive Unit (MRRU) for a
multilink interface. This is the maximum packet size the interface is willing to receive.
Use the set form of this command to set the MRRU.
Use the delete form of this command to restore the default MRRU value.
Use the show form of this command to view MRRU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
416
Syntax
set interfaces multilink mlx mtu mtu
delete interfaces multilink mlx mtu
show interfaces multilink mlx mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
mtu: 8-8188
}
}
Parameters
mlx
mtu
Optional. Sets the Maximum Transmit Unit (MTU). Unless the peer
requests a smaller value (by means of MRU negotiation), packets larger
than this number are fragmented.
The range is 8 to 8188. The default is 1500.
Note that for IPv6 connections, the MTU must be at least 1280.
Default
The default is 1500.
Command Reference
Rel VC4.1 v. 03
Vyatta
417
Usage Guidelines
Use this command to specify the Maximum Transmit Unit (MTU) for a Point-to-Point
Protocol (PPP) serial interface. This is the maximum packet size the interface will send.
Use the set form of this command to set the MTU.
Use the delete form of this command to restore the default MTU value.
Use the show form of this command to view MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
418
Syntax
set interfaces multilink mlx vif 1 address local-address ipv4
delete interfaces multilink mlx vif 1 address local-address
show interfaces multilink mlx vif 1 address local-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
vif 1 {
address {
local-address: ipv4
}
}
}
}
Parameters
Command Reference
mlx
Rel VC4.1 v. 03
Vyatta
419
ipv4
Default
None.
Usage Guidelines
Use this command to specify an IP address for a virtual interface on a multilink interface.
Use the set form of this command to set the IP address.
Use the delete form of this command to remove IP address configuration.
Use the show form of this command to view IP address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
420
Syntax
set interfaces multilink mlx vif 1 address prefix-length prefix
delete interfaces multilink mlx vif 1 address prefix-length
show interfaces multilink mlx vif 1 address prefix-length
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
vif 1 {
address {
prefix-length: u32
}
}
}
}
Parameters
Command Reference
mlx
prefix
Rel VC4.1 v. 03
Vyatta
421
Default
None.
Usage Guidelines
Use this command to specify the prefix defining the network served by a virtual interface
on a multilink interface.
Use the set form of this command to specify the network prefix.
Use the delete form of this command to remove network prefix configuration.
Use the show form of this command to view network prefix configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
422
Syntax
set interfaces multilink mlx vif 1 address remote-address ipv4
delete interfaces multilink mlx vif 1 address remote-address
show interfaces multilink mlx vif 1 address remote-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
vif 1 {
address {
remote-address: ipv4
}
}
}
}
Parameters
Command Reference
mlx
ipv4
Rel VC4.1 v. 03
Vyatta
423
Default
None.
Usage Guidelines
Use this command to specify the IP address of the remote endpoint in a multilink link.
Use the set form of this command to set the remote address.
Use the delete form of this command to remove remote address configuration.
Use the show form of this command to view remote address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
424
Syntax
set interfaces multilink mlx vif 1 description desc
delete interfaces multilink mlx vif 1 description
show interfaces multilink mlx vif 1 description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
vif 1 {
description: text
}
}
}
Parameters
mlx
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
425
Usage Guidelines
Use this command to specify a description for a virtual interface on a multilink interface.
Use the set form of this command to set the description.
Use the delete form of this command to remove description configuration.
Use the show form of this command to view description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
426
Syntax
show interfaces multilink [ml0..ml23]
Command Mode
Operational mode.
Parameters
ml0..ml23
Usage Guidelines
Use this command to view the operational status of a multilink interface.
When used with no option, this command displays summary information for all available
multilink interfaces.
Note that an MLPPP link that is negotiating is considered to be in an active state.
Examples
Example 8-3 shows summary information for all configured multilink bundles.
Example 8-3 show interfaces multilink: Displaying summary multilink information
Command Reference
Rel VC4.1 v. 03
Vyatta
427
Multilink members:
wan0 : active
ml1: <POINTOPOINT,MULTICAST,NOARP,UP,10000> mtu 1540 qdisc
pfifo_fast qlen 3
link/ppp
inet 3.3.3.2 peer 3.3.3.1/32 scope global ml1
mrru 1560
RX: bytes
packets
errors
dropped
overrun
mcast
72
5
0
0
0
0
TX: bytes
packets
errors
dropped
carrier collisions
109
7
0
0
0
0
Multilink members:
wan1 : active
PPP data:
IN.BYTES :
Command Reference
78
Rel VC4.1 v. 03
Vyatta
428
IN.PACK
:
IN.VJCOMP :
IN.VJUNC :
IN.VJERR :
OUT.BYTES :
OUT.PACK :
OUT.VJCOMP:
OUT.VJUNC :
OUT.NON-VJ:
Command Reference
5
0
0
0
72
5
0
0
5
Rel VC4.1 v. 03
Vyatta
429
430
This chapter lists the commands for configuring GRE and IP-in-IP routable tunnel
interfaces.
This chapter contains the following commands.
Command
Description
Command
431
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear interfaces tunnel [tunx] counters
Command Mode
Operational mode.
Parameters
tunx
Default
None.
Usage Guidelines
Use this command to clear statistics for tunnel interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
432
Syntax
set interfaces tunnel tunx
delete interfaces tunnel [tunx]
show interfaces tunnel [tunx]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
}
}
Parameters
tunx
Default
None.
Usage Guidelines
Use this command to create a tunnel interface for encapsulating traffic.
Use the set form of this command to create a tunnel interface.
Use the delete form of this command to remove a tunnel interface and all its configuration.
Use the show form of this command to view tunnel configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
433
Syntax
set interfaces tunnel tunx address ipv4net
delete interfaces tunnel tunx address [ipv4net]
show interfaces tunnel tunx address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
address: ipv4net
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
ipv4net
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
434
Usage Guidelines
Use this command to assign a primary or secondary IP address to a tunnel interface. At least
one address must be configured for the tunnel interface to function.
Use the set form of this command to create an IP address for a tunnel interface. Note that
you cannot use set to change an existing address; you must delete the address to be changed
and create a new one.
Use the delete form of this command to remove an IP network address for a tunnel
interface. At least one address must remain for the tunnel to function.
Use the show form of this command to view address configuration for a tunnel interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
435
Syntax
set interfaces tunnel tunx description descr
delete interfaces tunnel tunx description
show interfaces tunnel tunx description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
description: text
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
descr
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
436
Usage Guidelines
Use this command to record a brief description for a tunnel interface. If the description
contains spaces, it must be enclosed in double quotes.
Use the set form of this command to record a brief description description for the tunnel
interface.
Use the delete form of this command to remove a description for the tunnel interface.
Use the show form of this command to view a description for the tunnel interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
437
Syntax
set interfaces tunnel tunx disable
delete interfaces tunnel tunx disable
show interfaces tunnel tunx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
disable
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
Default
The tunnel interface is enabled.
Usage Guidelines
Use this command to disable a tunnel interface without discarding configuration
Use the set form of this command to disable the tunnel interface.
Use the delete form of this command to enable the tunnel interface.
Use the show form of this command to view the configuration for the tunnel interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
438
Syntax
set interfaces tunnel tunx encapsulation {gre | ipip}
delete interfaces tunnel tunx encapsulation
show interfaces tunnel tunx encapsulation
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
encapsulation [gre|ipip]
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
gre
ipip
Default
GRE is the encapsulation type.
Command Reference
Rel VC4.1 v. 03
Vyatta
439
Usage Guidelines
Use this command to set the encapsulation type for a tunnel.
The Generic Routing Encapsulation (GRE) protocol provides a simple-general purpose
mechanism for encapsulating packets from a wide variety of network protocols to be
forwarded over another protocol. The original packet (the passenger packet) can be one
of many arbitrary network protocolsfor example a multicast packet, an IPv6 packet, or a
non-IP LAN protocol such as AppleTalk, Banyen VINES, or Novell IPX. The delivery
protocol can be one of a number of routable IP protocols.
The IP-in-IP encapsulation protocol is used to tunnel between networks that have different
capabilities or policies. For example, an IP-in-IP tunnel can be used to forward multicast
packets across a section of a network (such as an IPsec tunnel) that does not support
multicast routing. An IP-in-IP tunnel can also be used to influence the routing of the packet,
or to deliver a packet to a mobile device using Mobile IP.
Use the set form of this command to set the encapsulation type for a tunnel interface.
Use the delete form of this command to remove restore the default encapsulation type for
a tunnel interface.
Use the show form of this command to view encapsulation configuration for a tunnel
interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
440
Syntax
set interfaces tunnel tunx key key
delete interfaces tunnel tunx key
show interfaces tunnel tunx key
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
key: 0-999999
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
key
A key for authenticating the local endpoint to the remote endpoint. The
key must match on both ends of the connection for the tunnel to be
established.
Default
No key is configured; authentication is not required.
Command Reference
Rel VC4.1 v. 03
Vyatta
441
Usage Guidelines
Use this command to provide a simple password-like numeric key for authenticating tunnel
endpoints to one another. For the tunnel to be established, keys must be identical at both
ends of the tunnel.
Use the set form of this command to specify a key for the tunnel interface.
Use the delete form of this command to remove the key for the tunnel interface.
Use the show form of this command to view the key for the tunnel interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
442
Syntax
set interfaces tunnel tunx local-ip ipv4
delete interfaces tunnel tunx local-ip
show interfaces tunnel tunx local-ip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
local-ip: ipv4
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
443
Usage Guidelines
Use this command to specify the IP address to use as the local endpoint of the tunnel. The
IP address must be one of those configured using the interfaces tunnel <tunx> address
<ipv4net> command (see page 434).
Use the set form of this command to set address of the local endpoint of the tunnel.
Use the delete form of this command to remove the local endpoint of the tunnel. Note that
the tunnel will not function without both endpoints configured.
Use the show form of this command to view local tunnel endpoint configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
444
Syntax
set interfaces tunnel tunx mtu mtu
delete interfaces tunnel tunx mtu
show interfaces tunnel tunx mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
mtu: mtu
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
mtu
Optional. The MTU, in octets, for the tunnel interface. The range is 0 to
8042, where 0 means fragmentation is never performed. The default is
1476.
Default
Tunnel interface packets have an MTU of 1476.
Command Reference
Rel VC4.1 v. 03
Vyatta
445
Usage Guidelines
Use this command to set the maximum transfer unit (MTU) for encapsulated packets
traversing the tunnel.
This MTU is applied to the packets embedded in the encapsulating protocol; it is not the
MTU of the carrier packets themselves. The MTU of carrier packets is dictated by the
MTU of the physical interface transmitting and receiving the tunnel packets.
Use the set form of this command to set the MTU value for encapsulated packets.
Use the delete form of this command to restore the default MTU value for encapsulated
packets.
Use the show form of this command to view the encapsulated packet MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
446
Syntax
set interfaces tunnel tunx remote-ip ipv4
delete interfaces tunnel tunx remote-ip
show interfaces tunnel tunx remote-ip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
remote-ip: ipv4
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
447
Usage Guidelines
Use this command to specify the IP address to use as the remote endpoint of the tunnel.
Use the set form of this command to set address of the remote endpoint of the tunnel.
Use the delete form of this command to remove the remote endpoint of the tunnel. Note
that the tunnel cannot be established without both endpoints configured.
Use the show form of this command to view remote tunnel endpoint configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
448
Syntax
set interfaces tunnel tunx tos tos
delete interfaces tunnel tunx tos
show interfaces tunnel tunx tos
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
tos: tos
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun23.
tos
Optional. The value to be written into the ToS byte in tunnel packet IP
headers (the carrier packet). The range is 0 to 99, where 0 means tunnel
packets copy the ToS value from the packet being encapsulated (the
passenger packet). The default is 0.
Default
The ToS byte of the encapsulated packet is copied into the ToS byte of the tunnel packets
IP header.
Command Reference
Rel VC4.1 v. 03
Vyatta
449
Usage Guidelines
Use this command to specify the value to be written in the 8-bit Type of Service (ToS) byte
of the IP header for packets traversing a tunnel interface. The ToS byte of a packets IP
header specifies the forwarding behavior to be applied to the packet.
Use the set form of this command to specify the ToS value to write into a tunnel packets
IP header.
Use the delete form of this command to restore the default behavior for the ToS byte.
Use the show form of this command to view ToS byte configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
450
Syntax
set interfaces tunnel tunx ttl ttl
delete interfaces tunnel tunx ttl
show interfaces tunnel tunx ttl
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun23 {
ttl: 0-255
}
}
Parameters
tunx
ttl
Default
The ToS byte of the encapsulated packet is copied into the ToS byte of the tunnel packets
IP header.
Command Reference
Rel VC4.1 v. 03
Vyatta
451
Usage Guidelines
Use this command to specify the value to be written in the TTL field of the IP header for
packets traversing a tunnel interface. The TTL field of a packets IP header used to limit the
lifetime of an IP packet and to prevent indefinite packet looping.
Use the set form of this command to specify the TTL value to write into a tunnel packets
IP header.
Use the delete form of this command to restore the default behavior for the TTL field.
Use the show form of this command to view TTL field configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
452
Syntax
show interfaces tunnel [tunx [brief] | detail]
Command Mode
Operational mode.
Parameters
tunx
brief
detail
Default
Information is displayed for all tunnel interfaces.
Usage Guidelines
Use this command to view the operational status of tunnel interfaces.
Examples
Example 9-1 shows operational status for the GRE tunnel interface tun0.
Example 9-1 show interfaces tunnel: Displaying tunnel configuration
vyatta@vyatta:~$ show interfaces tunnel
tun0@NONE: <POINTOPOINT,NOARP,UP,LOWER_UP> mtu 1476 qdisc noqueue
link/gre 192.168.20.2 peer 192.168.20.3
inet 192.168.20.1/24 brd 192.168.20.255 scope global tun0
RX: bytes
packets errors
dropped overrun mcast
0
0
0
0
0
0
TX: bytes
packets errors
dropped carrier collisions
0
0
0
0
0
0
Command Reference
Rel VC4.1 v. 03
Vyatta
453
Command Reference
Rel VC4.1 v. 03
Vyatta
454
455
This chapter lists the commands for setting up the Point-to-Point Protocol over
Ethernet (PPPoE) protocol on the Vyatta system.
This chapter contains the following commands.
Command
Description
456
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
457
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num
delete interfaces adsl adslx pvc pvc-id pppoe num
show interfaces adsl adslx pvc pvc-id pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
Rel VC4.1 v. 03
Vyatta
458
num
Default
None.
Usage Guidelines
Use this command to configure a Point-to-Point Protocol over Ethernet (PPPoE) unit on a
PVC with PPPoE encapsulation on an ADSL interface.
A PPPoE interface comes into being on the system only when the PPPoE session is
established. So, a PPPoE interface could be defined but not be present on a running
system.
Use the set form of this command to create the PPPoE unit on an interface.
Use the delete form of this command to remove a PPPoE unit from an interface.
Use the show form of this command to display PPPoE configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
459
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num access-concentrator name
delete interfaces adsl adslx pvc pvc-id pppoe num access-concentrator
show interfaces adsl adslx pvc pvc-id pppoe num access-concentrator
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
access-concentrator: text
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
name
The name of the access concentrator for this PPPoE unit to use
exclusively for PPPoE sessions.
Rel VC4.1 v. 03
Vyatta
460
Default
None.
Usage Guidelines
Use this command to restrict the Point-to-Point Protocol over Ethernet (PPPoE) sessions of
a given ADSL PPPoE unit to one access concentrator.
Normally, when a host issues a PPPoE initiation packet to start the PPPoE discovery
process, a number of access concentrators respond with offer packets and the host selects
one of the responding access concentrators to request the PPPoE session. This command
allows you to forego the discovery process and send PPPoE session requests directly to the
specified access concentrator.
Use the set form of this command to specify an access concentrator to use for ADSL PPPoE
sessions.
Use the delete form of this command to remove access concentrator configuration. If no
access concentrator is specified, the PPPoE discover process will proceed as outlined in
RFC 2516.
Use the show form of this command to show access concentrator configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
461
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num connect-on-demand
delete interfaces adsl adslx pvc pvc-id pppoe num connect-on-demand
show interfaces adsl adslx pvc pvc-id pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
connect-on-demand
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and
auto directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
Rel VC4.1 v. 03
Vyatta
462
Default
On-demand PPPoE connection is disabled.
Usage Guidelines
Use this command to direct the system to establish ADSL Point-to-Point Protocol over
Ethernet (PPPoE) connections automatically just when traffic is sent.
When on-demand PPPoE connection is disabled, PPPoE links are created at boot time and
remain up. If the link fails for any reason, the system brings the link back up immediately.
When on-demand PPPoE connection is enabled, the PPPoE link is brought up only when
IP traffic needs to be sent on the link. If the link fails for any reason, it is brought back up
again the next time traffic needs to be sent.
If you configure an on-demand PPPoE connection, you must also configure the idle timeout
period, after which an idle PPPoE link will be disconnected. If a non-zero idle timeout
period is not configured, the on-demand link will never be disconnected after the first time
it is brought up. To configure the idle timeout period, use the interfaces adsl <adslx> pvc
<pvc-id> pppoe <num> idle-timeout <timeout> command (see page 466).
If you configure an on-demand PPPoE connection, you must also configure
remote-address. To configure the remote address, use the interfaces adsl <adslx> pvc
<pvc-id> pppoe <num> remote-address <ipv4> command (see page 478).
Use the set form of this command to enable on-demand PPPoE connections.
Use the delete form of this command to disable on-demand PPPoE connections.
Use the show form of this command to show PPPoE connection configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
463
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num default-route param
delete interfaces adsl adslx pvc pvc-id pppoe num default-route
show interfaces adsl adslx pvc pvc-id pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
default-route: [auto|none]
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
Rel VC4.1 v. 03
Vyatta
464
param
Default
A default route to the remote endpoint is automatically added when the link comes up (i.e.
auto).
Usage Guidelines
Use this command to specify whether to automatically add a default route pointing to the
endpoint of an ADSL Point-to-Point Protocol over Ethernet (PPPoE) link when the link
comes up.
The default route is only added if no other default route already exists in the system.
Use the set form of this command to enable or disable adding the default route.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to show configuration for the PPPoE unit.
Command Reference
Rel VC4.1 v. 03
Vyatta
465
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num idle-timeout timeout
delete interfaces adsl adslx pvc pvc-id pppoe num idle-timeout
show interfaces adsl adslx pvc pvc-id pppoe num idle-timeout
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
idle-timeout: u32
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
Rel VC4.1 v. 03
Vyatta
466
timeout
Default
Idle connections are never disconnected.
Usage Guidelines
Use this command to set the idle timeout interval to be used with on-demand ADSL
Point-to-Point Protocol over Ethernet (PPPoE) connections.
When on-demand PPPoE link connection is enabled, the link is brought up only when
traffic is to be sent and is disabled when the link is idle for the interval specified by this
command. On-demand PPPoE connection is enabled using the interfaces adsl <adslx>
pvc <pvc-id> pppoe <num> connect-on-demand command (see page 462).
If this parameter is not set or is set to 0, an on-demand link will not be taken down when it
is idle and after the initial establishment of the connection will behave like an ordinary
PPPoE link.
Use the set form of this command to specify the idle timeout value.
Use the delete form of this command to restore default behavior for idle timeout.
Use the show form of this command to display idle timeout configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
467
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num local-address ipv4
delete interfaces adsl adslx pvc pvc-id pppoe num local-address
show interfaces adsl adslx pvc pvc-id pppoe num local-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
local-address: ipv4
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
ipv4
Mandatory. The IP address of the local end of the PPPoE link. Only
one local address can be specified.
Rel VC4.1 v. 03
Vyatta
468
Default
None.
Usage Guidelines
Use this command to set the IP address of the local endpoint of an ADSL Point-to-Point
Protocol over Ethernet (PPPoE) connection. If not set it will be negotiated.
Use the set form of this command to specify the local address.
Use the delete form of this command to remove the local address.
Use the show form of this command to display local address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
469
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num mtu mtu
delete interfaces adsl adslx pvc pvc-id pppoe num mtu
show interfaces adsl adslx pvc pvc-id pppoe num mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
mtu: 68-1492
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
mtu
Sets the MTU for the PPPoE interface. Packets larger that this value
are fragmented. The range is 68 to 1492.
Rel VC4.1 v. 03
Vyatta
470
Default
The default MTU is 1492 bytes.
Usage Guidelines
Use this command to set the Maximum Transfer Unit (MTU) of an ADSL Point-to-Point
Protocol over Ethernet (PPPoE) unit. Packets larger than the MTU are fragmented.
Use the set form of this command to specify the MTU value.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to display MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
471
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num name-server param
delete interfaces adsl adslx pvc pvc-id pppoe num name-server
show interfaces adsl adslx pvc pvc-id pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
name-server: [auto|none]
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
Rel VC4.1 v. 03
Vyatta
472
param
Default
The interface obtains name server entries from its peer (i.e. auto).
Usage Guidelines
Use this command to define how a name server is defined when an ADSL Point-to-Point
Protocol over Ethernet (PPPoE) link is brought up.
Use the set form of this command to set the way that name server entries are obtained by
the PPPoE endpoint.
Use the delete form of this command to restore the default behavior for obtaining name
server entries.
Use the show form of this command to show the PPPoE name server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
473
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num password password
delete interfaces adsl adslx pvc pvc-id pppoe num password
show interfaces adsl adslx pvc pvc-id pppoe num password
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
password: text
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
password
Rel VC4.1 v. 03
Vyatta
474
Default
None.
Usage Guidelines
Use this command to set the authentication password for an ADSL Point-to-Point Protocol
over Ethernet (PPPoE) endpoint.
Authentication is optional from the systems point of view; however, most service
providers require it.
The password is used in conjunction with the user ID to authenticate the local system to the
remote endpoint. The user ID is set by using the interfaces adsl <adslx> pvc <pvc-id>
pppoe <num> user-id <user-id> command (see page 482). The authentication protocol is
determined by the remote endpoint. Use the set form of this command to set the password.
Use the delete form of this command to remove the password.
Use the show form of this command to display password configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
475
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> qos-policy out <policy-name>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num qos-policy out policy-name
delete interfaces adsl adslx pvc pvc-id pppoe num qos-policy out
show interfaces adsl adslx pvc pvc-id pppoe num qos-policy out
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
out: text
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
policy-name
Rel VC4.1 v. 03
Vyatta
476
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> qos-policy out <policy-name>
Default
None.
Usage Guidelines
Use this command to apply an outbound QoS policy to an ADSL interface with
Point-to-Point Protocol over Ethernet (PPPoE) encapsulation.
For information about defining QoS policies, see Chapter 18: Quality of Service
Policies.
Use the set form of this command to apply a QoS policy to the interface.
Use the delete form of this command to remove a QoS policy from the interface.
Use the show form of this command to display QoS policy configuration for an interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
477
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num remote-address ipv4
delete interfaces adsl adslx pvc pvc-id pppoe num remote-address
show interfaces adsl adslx pvc pvc-id pppoe num remote-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
remote-address: ipv4
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
ipv4
Rel VC4.1 v. 03
Vyatta
478
Default
None.
Usage Guidelines
Use this command to set the IP address of the remote endpoint of an ADSL Point-to-Point
Protocol over Ethernet (PPPoE) connection. This address will be negotiated if not set.
Use the set form of this command to specify the remote address.
Use the delete form of this command to remove the remote address.
Use the show form of this command to display remote address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
479
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num service-name name
delete interfaces adsl adslx pvc pvc-id pppoe num service-name
show interfaces adsl adslx pvc pvc-id pppoe num service-name
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
service-name: text
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
Rel VC4.1 v. 03
Vyatta
480
name
Default
None.
Usage Guidelines
Use this command to specify a service name by which the local ADSL Point-to-Point
Protocol over Ethernet (PPPoE) interface can select access concentrators to connect with.
It will connect to any access concentrator if not set.
Use the set form of this command to specify a service name.
Use the delete form of this command to remove a service name.
Use the show form of this command to show service name configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
481
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num user-id user-id
delete interfaces adsl adslx pvc pvc-id pppoe num user-id
show interfaces adsl adslx pvc pvc-id pppoe num user-id
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
user-id: text
}
}
}
}
Parameters
Command Reference
adslx
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci
pair or the keyword auto, where vpi is a Virtual Path Index from 0
to 255, vci is a Virtual Circuit Index from from 0 to 65535, and auto
directs the system to detect the Virtual Path Index and Virtual
Circuit Index automatically.
num
user-id
Rel VC4.1 v. 03
Vyatta
482
Default
None.
Usage Guidelines
Use this command to set the user ID for authenticating with a remote ADSL Point-to-Point
Protocol over Ethernet (PPPoE) endpoint.
Authentication is optional from the systems point of view; however, most service
providers require it.
The user ID is used in conjunction with the password to authenticate the local system to the
remote endpoint. The password is set by using the interfaces adsl <adslx> pvc <pvc-id>
pppoe <num> password <password> command (see page 474). The authentication
protocol is determined by the remote endpoint. Use the set form of this command to set the
user ID.
Use the delete form of this command to remove the user ID.
Use the show form of this command to display user ID configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
483
Syntax
set interfaces ethernet ethx pppoe num
delete interfaces ethernet ethx pppoe num
show interfaces ethernet ethx pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
}
}
}
Parameters
ethx
num
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
484
Usage Guidelines
Use this command to configure a Point-to-Point Protocol over Ethernet (PPPoE) unit on an
Ethernet interface.
A PPPoE interface comes into being on the system only when the PPPoE session is
established. So, a PPPoE interface could be defined but not be present on a running
system.
Use the set form of this command to create the PPPoE unit on an interface.
Use the delete form of this command to remove a PPPoE unit from an interface.
Use the show form of this command to display PPPoE configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
485
Syntax
set interfaces ethernet ethx pppoe num access-concentrator name
delete interfaces ethernet ethx pppoe num access-concentrator
show interfaces ethernet ethx pppoe num access-concentrator
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
access-concentrator: text
}
}
}
Parameters
ethx
num
name
The name of the access concentrator for this PPPoE unit to use
exclusively for PPPoE sessions.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
486
Usage Guidelines
Use this command to restrict the Point-to-Point Protocol over Ethernet (PPPoE) sessions of
a given Ethernet PPPoE unit to one access concentrator.
Normally, when a host issues a PPPoE initiation packet to start the PPPoE discovery
process, a number of access concentrators respond with offer packets and the host selects
one of the responding access concentrators to request the PPPoE session. This command
allows you to forego the discovery process and send PPPoE session requests directly to the
specified access concentrator.
Use the set form of this command to specify an access concentrator to use for PPPoE
sessions.
Use the delete form of this command to remove access concentrator configuration. If no
access concentrator is specified, the PPPoE discover process will proceed as outlined in
RFC 2516.
Use the show form of this command to show access concentrator configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
487
Syntax
set interfaces ethernet ethx pppoe num connect-on-demand
delete interfaces ethernet ethx pppoe num connect-on-demand
show interfaces ethernet ethx pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
connect-on-demand
}
}
}
Parameters
ethx
num
Default
On-demand PPPoE connection is disabled.
Command Reference
Rel VC4.1 v. 03
Vyatta
488
Usage Guidelines
Use this command to direct the system to establish Point-to-Point Protocol over Ethernet
(PPPoE) connections automatically just when traffic is sent.
When on-demand PPPoE connection is disabled, PPPoE links are created at boot time and
remain up. If the link fails for any reason, the system brings the link back up immediately.
When on-demand PPPoE connection is enabled, the PPPoE link is brought up only when
IP traffic needs to be sent on the link. If the link fails for any reason, it is brought back up
again the next time traffic needs to be sent.
If you configure an on-demand PPPoE connection, you must also configure the idle timeout
period, after which an idle PPPoE link will be disconnected. If a non-zero idle timeout
period is not configured, the on-demand link will never be disconnected after the first time
it is brought up. To configure the idle timeout period, use the interfaces ethernet <ethx>
pppoe <num> idle-timeout <timeout> command (see page 492).
If you configure an on-demand PPPoE connection, you must also configure
remote-address. To configure the remote address, use the interfaces ethernet <ethx>
pppoe <num> remote-address <ipv4> command (see page 504).
Use the set form of this command to enable on-demand PPPoE connections.
Use the delete form of this command to disable on-demand PPPoE connections.
Use the show form of this command to show PPPoE connection configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
489
Syntax
set interfaces ethernet ethx pppoe num default-route param
delete interfaces ethernet ethx pppoe num default-route
show interfaces ethernet ethx pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
default-route: [auto|none]
}
}
}
Parameters
ethx
num
param
Command Reference
Rel VC4.1 v. 03
Vyatta
490
Default
A default route to the remote endpoint is automatically added when the link comes up (i.e.
auto).
Usage Guidelines
Use this command to specify whether to automatically add a default route pointing to the
endpoint of the when a Point-to-Point Protocol over Ethernet (PPPoE) link comes up.
The default route is only added if no other default route already exists in the system.
Use the set form of this command to enable or disable adding the default route.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to show configuration for the PPPoE unit.
Command Reference
Rel VC4.1 v. 03
Vyatta
491
Syntax
set interfaces ethernet ethx pppoe num idle-timeout timeout
delete interfaces ethernet ethx pppoe num idle-timeout
show interfaces ethernet ethx pppoe num idle-timeout
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
idle-timeout: u32
}
}
}
Parameters
ethx
num
timeout
Default
Idle connections are never disconnected.
Command Reference
Rel VC4.1 v. 03
Vyatta
492
Usage Guidelines
Use this command to set the idle timeout interval to be used with on-demand Point-to-Point
Protocol over Ethernet (PPPoE) connections.
When on-demand PPPoE link connection is enabled, the link is brought up only when
traffic is to be sent and is disabled when the link is idle for the interval specified by this
command. On-demand PPPoE connection is enabled using the interfaces ethernet <ethx>
pppoe <num> connect-on-demand command (see page 488).
If this parameter is not set or is set to 0, an on-demand link will not be taken down when it
is idle and after the initial establishment of the connection will behave like an ordinary
PPPoE link.
Use the set form of this command to specify the idle timeout value.
Use the delete form of this command to restore default behavior for idle timeout.
Use the show form of this command to display idle timeout configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
493
Syntax
set interfaces ethernet ethx pppoe num local-address ipv4
delete interfaces ethernet ethx pppoe num local-address
show interfaces ethernet ethx pppoe num local-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
local-address: ipv4
}
}
}
Parameters
ethx
num
ipv4
Mandatory. The IP address of the local end of the PPPoE link. Only
one local address can be specified.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
494
Usage Guidelines
Use this command to set the IP address of the local endpoint of a Point-to-Point Protocol
over Ethernet (PPPoE) connection. If not set it will be negotiated.
Use the set form of this command to specify the local address.
Use the delete form of this command to remove the local address.
Use the show form of this command to display local address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
495
Syntax
set interfaces ethernet ethx pppoe num mtu mtu
delete interfaces ethernet ethx pppoe num mtu
show interfaces ethernet ethx pppoe num mtu
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
mtu: 68-1492
}
}
}
Parameters
ethx
num
mtu
Sets the MTU for the PPPoE interface. Packets larger that this value
are fragmented. The range is 68 to 1492.
Default
If not set, the MTU for the PPPoE interface will be set to the MTU for the Ethernet interface
minus 8 bytes.
Command Reference
Rel VC4.1 v. 03
Vyatta
496
Usage Guidelines
Use this command to set the Maximum Transfer Unit (MTU) of a Point-to-Point Protocol
over Ethernet (PPPoE) unit. Packets larger than the MTU are fragmented.
Use the set form of this command to specify the MTU value.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to display MTU configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
497
Syntax
set interfaces ethernet ethx pppoe num name-server param
delete interfaces ethernet ethx pppoe num name-server
show interfaces ethernet ethx pppoe num
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
name-server: [auto|none]
}
}
}
Parameters
ethx
num
param
Command Reference
Rel VC4.1 v. 03
Vyatta
498
Default
The interface obtains name server entries from its peer.
Usage Guidelines
Use this command to define how a name server is defined when an Point-to-Point Protocol
over Ethernet (PPPoE) link is brought up.
Use the set form of this command to set the way that name server entries are obtained by
the PPPoE endpoint.
Use the delete form of this command to restore the default behavior for obtaining name
server entries.
Use the show form of this command to show the PPPoE name server configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
499
Syntax
set interfaces ethernet ethx pppoe num password password
delete interfaces ethernet ethx pppoe num password
show interfaces ethernet ethx pppoe num password
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
password: text
}
}
}
Parameters
ethx
num
password
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
500
Usage Guidelines
Use this command to set the authentication password for an Point-to-Point Protocol over
Ethernet (PPPoE) endpoint.
Authentication is optional from the systems point of view; however, most service
providers require it.
The password is used in conjunction with the user ID to authenticate the local system to the
remote endpoint. The user ID is set by using the interfaces ethernet <ethx> pppoe <num>
user-id <user-id> command (see page 508). The authentication protocol is determined by
the remote endpoint. Use the set form of this command to set the password.
Use the delete form of this command to remove the password.
Use the show form of this command to display password configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
501
Syntax
set interfaces ethernet ethx pppoe num qos-policy out policy-name
delete interfaces ethernet ethx pppoe num qos-policy out
show interfaces ethernet ethx pppoe num qos-policy out
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
out: text
}
}
}
Parameters
ethx
num
policy-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
502
Usage Guidelines
Use this command to apply an outbound QoS policy to an Ethernet interface with
Point-to-Point Protocol over Ethernet (PPPoE) encapsulation.
For information about defining QoS policies, see Chapter 18: Quality of Service
Policies.
Use the set form of this command to apply a QoS policy to the interface.
Use the delete form of this command to remove a QoS policy from the interface.
Use the show form of this command to display QoS policy configuration for an interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
503
Syntax
set interfaces ethernet ethx pppoe num remote-address ipv4
delete interfaces ethernet ethx pppoe num remote-address
show interfaces ethernet ethx pppoe num remote-address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
remote-address: ipv4
}
}
}
Parameters
ethx
num
ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
504
Usage Guidelines
Use this command to set the IP address of the remote endpoint of an Point-to-Point Protocol
over Ethernet (PPPoE) connection. This address will be negotiated if not set.
Use the set form of this command to specify the remote address.
Use the delete form of this command to remove the remote address.
Use the show form of this command to display remote address configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
505
Syntax
set interfaces ethernet ethx pppoe num service-name name
delete interfaces ethernet ethx pppoe num service-name
show interfaces ethernet ethx pppoe num service-name
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
service-name: text
}
}
}
Parameters
ethx
num
name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
506
Usage Guidelines
Use this command to specify a service name by which the local Point-to-Point Protocol
over Ethernet (PPPoE) interface can select access concentrators to connect with. It will
connect to any access concentrator if not set.
Use the set form of this command to specify a service name.
Use the delete form of this command to remove a service name.
Use the show form of this command to show service name configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
507
Syntax
set interfaces ethernet ethx pppoe num user-id user-id
delete interfaces ethernet ethx pppoe num user-id
show interfaces ethernet ethx pppoe num user-id
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet [eth0..eth23] {
pppoe 0-15 {
user-id: text
}
}
}
Parameters
ethx
num
user-id
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
508
Usage Guidelines
Use this command to set the user ID for authenticating with a remote Point-to-Point
Protocol over Ethernet (PPPoE) endpoint.
Authentication is optional from the systems point of view; however, most service
providers require it.
The user ID is used in conjunction with the password to authenticate the local system to the
remote endpoint. The password is set by using the interfaces ethernet <ethx> pppoe
<num> password <password> command (see page 500). The authentication protocol is
determined by the remote endpoint. Use the set form of this command to set the user ID.
Use the delete form of this command to remove the user ID.
Use the show form of this command to display user ID configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
509
Syntax
set interface pppoe num down
Command Mode
Operational mode.
Parameters
num
Default
None.
Usage Guidelines
Use this command to bring down a Point-to-Point Protocol over Ethernet (PPPoE) interface
if it is up.
If the connect-on-demand option is set, the interface remains down until traffic arrives to
be sent over the link. If connect-on-demand is not set, the link remains down until manually
brought back up with the set interface pppoe <num> up command.
Command Reference
Rel VC4.1 v. 03
Vyatta
510
Syntax
set interface pppoe num up
Command Mode
Operational mode.
Parameters
num
Default
None.
Usage Guidelines
Use this command to bring up an Point-to-Point Protocol over Ethernet (PPPoE) interface
if it is not up already.
Issuing this command brings up the interface even if the connect-on-demand option is set.
Command Reference
Rel VC4.1 v. 03
Vyatta
511
Syntax
show interfaces pppoe [num]
Command Mode
Operational mode.
Parameters
num
Default
Displays information for all PPPoE interfaces.
Usage Guidelines
Use this command to display Point-to-Point Protocol over Ethernet (PPPoE) interface
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
512
513
This chapter lists commands for enabling and disabling forwarding, and for
displaying general routing information.
This chapter contains the following commands.
Command
Description
show ip forwarding
show ip route
514
Command
Description
show table
Command Reference
Rel VC4.1 v. 03
Vyatta
clear ip prefix-list
clear ip prefix-list
Clears prefix list statistics or status.
Syntax
clear ip prefix-list [list-name [ipv4net]]
Command Mode
Operational mode.
Parameters
list-name
ipv4net
Default
Statistics for all prefix-lists are cleared.
Usage Guidelines
Use this command to clear prefix list statistics or status.
Command Reference
Rel VC4.1 v. 03
Vyatta
515
Syntax
clear ip route cache [ipv4net]
Command Mode
Operational mode.
Parameters
ipv4net
Optional. Flushes the specified route from the kernel route cache.
Default
Flushes the entire route cache.
Usage Guidelines
Use this command to flush the kernel route cache or a flush a specific route from the cache.
Command Reference
Rel VC4.1 v. 03
Vyatta
516
show ip forwarding
show ip forwarding
Displays IP forwarding status.
Syntax
show ip forwarding
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display the current IP forwarding status.
Examples
Example 11-2 shows IP forwarding status
Example 11-1 show ip forwarding: Displaying IP forwarding status
Command Reference
Rel VC4.1 v. 03
Vyatta
517
show ip route
show ip route
Displays routes stored in the RIB and FIB.
Syntax
show ip route [ipv4 | ipv4net]
Command Mode
Operational mode.
Parameters
ipv4
ipv4net
Default
Lists all routes in the RIB and FIB.
Usage Guidelines
Use this command to display active prefixes stored in the Routing Information Base (RIB),
as well as those stored in the Forwarding Information Base (FIB).
The routes shown in the FIB can also be seen using the show ip route forward command
(see page 524).
Examples
Example 11-2 shows routes in the RIB and FIB
Example 11-2 show ip route: Displaying routes in the RIB and FIB
Command Reference
Rel VC4.1 v. 03
Vyatta
518
show ip route
Command Reference
Rel VC4.1 v. 03
Vyatta
519
Syntax
show ip route ipv4net longer-prefixes
Command Mode
Operational mode.
Parameters
ipv4net
Default
None.
Usage Guidelines
Use this command to display all prefixes in the Routing Information Base (RIB) that are
longer than a given IP address or prefix.
Examples
Example 11-4 shows prefixes longer than the prefix 10.192.128.0/24.
Example 11-4 show ip route <ipv4net> longer-prefixes: Displaying routes with longer
prefixes
Command Reference
Rel VC4.1 v. 03
Vyatta
520
Syntax
show ip route cache [ipv4net]
Command Mode
Operational mode.
Parameters
ipv4net
Default
Lists routes in the kernel route cache.
Usage Guidelines
Use this command to display information about routes stored in the kernel route cache. The
route cache contains all paths currently in use by the cache. Multiple equal-cost paths are
necessary before equal-cost-multi-path (ECMP) routing can be performed.
Examples
Example 11-5 shows routes in the kernel route cache.
Example 11-5 show ip route cache: Displaying routes in the kernel route cache
Command Reference
Rel VC4.1 v. 03
Vyatta
521
Example 11-6 displays information about route 10.1.0.62 in the kernel route cache.
Example 11-6 show ip route cache <ipv4net>: Displaying information about a route in the
kernel route cache
Command Reference
Rel VC4.1 v. 03
Vyatta
522
Syntax
show ip route connected
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display routes directly connected to the local system.
Examples
Example 11-7 shows directly connected routes.
Example 11-7 show ip route connected: Displaying connected routes
vyatta@vyatta:~$ show ip route connected
Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
C>* 10.1.0.0/24 is directly connected, eth0
C>* 127.0.0.0/8 is directly connected, lo
C>* 172.16.234.0/25 is directly connected, eth1
vyatta@vyatta:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
523
Syntax
show ip route forward [ipv4net]
Command Mode
Operational mode.
Parameters
ipv4net
Optional. Displays information from the kernel forwarding table for the
specified route.
Default
Lists routes in the FIB.
Usage Guidelines
Use this command to display the FIB.
The FIB contains multiple equal-cost paths if existed. Multiple equal-cost paths are
necessary before equal-cost multi-path (ECMP) routing or WAN load balancing can be
performed.
Examples
Example 11-8 shows routes in the FIB.
Example 11-8 show ip route forward: Displaying routes in the FIB
Command Reference
Rel VC4.1 v. 03
Vyatta
524
Example 11-9 shows information from the FIB about route 10.1.0.0/24.
Example 11-9 show ip route forward <ipv4net>: Displaying information for a route in the
FIB
Command Reference
Rel VC4.1 v. 03
Vyatta
525
Syntax
show ip route kernel
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display kernel routes. Kernel routes are routes that have been added
through means other than by using the Vyatta CLI; for example by using the operating
system route command, as in the following:
route add -net 10.172.24.0 netmask 255.255.255.0 gw 10.1.0.1
Examples
Example 11-10 shows kernel routes.
Example 11-10 show ip route kernel: Displaying kernel routes
Command Reference
Rel VC4.1 v. 03
Vyatta
526
Syntax
show ip route static
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display static routes in the Routing Information Base (RIB).
Examples
Example 11-11 shows static routes.
Example 11-11 show ip route static: Displaying static routes
Command Reference
Rel VC4.1 v. 03
Vyatta
527
Syntax
show ip route supernets-only
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display supernet routes. Supernet routes are routes that have a subnet
mask that less specific than the natural classful mask.
Examples
Example 11-12 shows supernet routes.
Example 11-12 show ip route supernets-only: Displaying supernet routes
Command Reference
Rel VC4.1 v. 03
Vyatta
528
show table
show table
Displays the systems routing table.
Syntax
show table
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display the systems routing table.
Examples
Example 11-13 shows the routing table.
Example 11-13 show table: Displaying the routing table
Command Reference
Rel VC4.1 v. 03
Vyatta
529
530
This chapter lists the commands used for Spanning Tree Protocol and bridging.
This chapter contains the following commands.
Command
Description
531
Command
Description
interfaces ethernet <ethx> vif <vlan-id> bridge-group bridge Specify a bridge group to add a virtual interface to.
<group-id>
interfaces ethernet <ethx> vif <vlan-id> bridge-group cost
<cost>
interfaces ethernet <ethx> vif <vlan-id> bridge-group priority Specify a path priority for a bridge group on a
<priority>
virtual interface.
Bridging Operational Commands
clear arp address <ipv4>
show arp
show bridge
show interfaces
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear interfaces bridge [ethx] counters
Command Mode
Operational mode.
Parameters
ethx
Usage Guidelines
Use this command to clear counters for a specified Ethernet interface.
If no Ethernet interface is specified then statistics are cleared on all bridge interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
532
Syntax
set interfaces bridge brx
delete interfaces bridge brx
show interfaces bridge brx
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
Default
None.
Usage Guidelines
Use this command to define a bridge and configure its bridging and Spanning Tree Protocol
characteristics.
Note that you must create the bridge group (using this command) before you can assign
interfaces to it.
Use the set form of this command to define bridge settings.
Use the delete form of this command to remove all configuration for a bridge interface.
Use the show form of this command to view a bridge interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
533
Syntax
set interfaces bridge brx address address
delete interfaces bridge brx address address
show interfaces bridge brx address
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
address: text
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
address
Multi-node. The IP address for the interface. The address must either be
in the form <ip-address>/<prefix> or dhcp. If it is dhcp then the IP
address and prefix length will be set via DHCP.
Default
None.
Usage Guidelines
Use this command to specify an IP address for the interface. Multiple addresses can be
defined by specifying multiple address configuration nodes.
Use the set form of this command to specify an IP address for the interface.
Use the delete form of this command to remove the IP address.
Command Reference
Rel VC4.1 v. 03
Vyatta
534
Command Reference
Rel VC4.1 v. 03
Vyatta
535
Syntax
set interfaces bridge brx aging age
delete interfaces bridge brx aging
show interfaces bridge brx aging
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
aging: u32
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
age
Optional. Sets the length of time in seconds a MAC address will be kept
in this bridges forwarding database before the entry is aged out of the
table.
The range is 1 to 4294967295.
Default
The default is 300.
Usage Guidelines
Use this command to specify the MAC address aging timeout.
Use the set form of this command to specify the MAC address aging timeout.
Use the delete form of this command to restore the aging configuration to its default.
Command Reference
Rel VC4.1 v. 03
Vyatta
536
Use the show form of this command to view the aging configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
537
Syntax
set interfaces bridge brx description desc
delete interfaces bridge brx description
show interfaces bridge brx description
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
description: text
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
desc
Default
None.
Usage Guidelines
Use this command to specify a description for the bridge group.
Use the set form of this command to specify a description for the bridge group.
Use the delete form of this command to remove the description.
Use the show form of this command to view the description.
Command Reference
Rel VC4.1 v. 03
Vyatta
538
Syntax
set interfaces bridge brx disable state
delete interfaces bridge brx disable
show interfaces bridge brx disable
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
disable: [true|false]
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
state
Default
The default is false.
Command Reference
Rel VC4.1 v. 03
Vyatta
539
Usage Guidelines
Use this command to specify whether or not bridging is enabled on the interface.
Use the set form of this command to specify whether or not bridging is enabled on the
interface.
Use the delete form of this command to restore the default.
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
540
Syntax
set interfaces bridge brx forwarding-delay delay
delete interfaces bridge brx forwarding-delay
show interfaces bridge brx forwarding-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
forwarding-delay: u32
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
delay
Optional. The amount of time in seconds this bridge will keep listening
and learning about the topology of the spanning tree after a topology
change. After the forward delay interval has passed, the bridge
transitions to the Forwarding state.
The range is 1 to 4294967295.
Default
The default is 15.
Command Reference
Rel VC4.1 v. 03
Vyatta
541
Usage Guidelines
Use this command to specify the amount of time the bridge will keep listening after a
topology change.
Use the set form of this command to specify the amount of time the bridge will keep
listening after a topology change.
Use the delete form of this command to restore the forwarding-delay to its default.
Use the show form of this command to view the forwarding-delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
542
Syntax
set interfaces bridge brx hello-time interval
delete interfaces bridge brx hello-time
show interfaces bridge brx hello-time
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
hello-time: u32
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
interval
Default
The default is 2.
Usage Guidelines
Use this command to specify the hello packet interval.
Use the set form of this command to specify the hello packet interval.
Command Reference
Rel VC4.1 v. 03
Vyatta
543
Use the delete form of this command to restore the hello-time interval to its default.
Use the show form of this command to view the hello-time configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
544
Syntax
set interfaces bridge brx max-age interval
delete interfaces bridge brx max-age
show interfaces bridge brx max-age
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
max-age: u32
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
interval
Optional. The interval a bridge will wait to receive a hello packets before
removing a neighboring bridge.
The range is 1 to 4294967295.
Default
The default is 20.
Usage Guidelines
Use this command to specify the interval a bridge will wait to receive a hello packets before
removing a neighboring bridge.
Use the set form of this command to specify the interval a bridge will wait to receive a hello
packets before removing a neighboring bridge.
Command Reference
Rel VC4.1 v. 03
Vyatta
545
Use the delete form of this command to restore the max-age interval to its default.
Use the show form of this command to view the max-age configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
546
Syntax
set interfaces bridge brx priority priority
delete interfaces bridge brx priority
show interfaces bridge brx priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
priority: u32
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
priority
Optional. Sets the forwarding priority of this bridge in the spanning tree.
Default
The default is 0.
Usage Guidelines
Use this command to specify the forwarding priority of this bridge in the spanning tree.
Use the set form of this command to specify the forwarding priority of this bridge in the
spanning tree.
Use the delete form of this command to restore the priority to its default.
Use the show form of this command to view the priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
547
Syntax
set interfaces bridge brx stp state
delete interfaces bridge brx stp
show interfaces bridge brx stp
Command Mode
Configuration mode.
Configuration Statement
interfaces {
bridge br0..br9 {
stp: [true|false]
}
}
Parameters
brx
Mandatory. The identifier for the bridge group. Supported identifiers are
br0 through br09.
stp
Default
The default is false.
Command Reference
Rel VC4.1 v. 03
Vyatta
548
Usage Guidelines
Use this command to specify whether or not the Spanning Tree Protocol is enabled on the
interface.
Use the set form of this command to specify whether or not the Spanning Tree Protocol is
enabled on the interface.
Use the delete form of this command to restore the default.
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
549
Syntax
set interfaces ethernet ethx bridge-group bridge group-id
delete interfaces ethernet ethx bridge-group bridge
show interfaces ethernet ethx bridge-group bridge
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
bridge-group {
bridge: br0..br9
}
}
}
Parameters
ethx
group-id
The bridge group ID to assign the interface to. Supported identifiers are
br0 through br9.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
550
Usage Guidelines
Use this command to specify a bridge group to add an Ethernet interface to.
Use the set form of this command to specify the bridge group id.
Use the delete form of this command to remove the bridge group id.
Use the show form of this command to view the bridge group id.
Command Reference
Rel VC4.1 v. 03
Vyatta
551
Syntax
set interfaces ethernet ethx bridge-group cost cost
delete interfaces ethernet ethx bridge-group cost
show interfaces ethernet ethx bridge-group cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
bridge-group {
cost: [0-2147483647]
}
}
}
Parameters
ethx
cost
The path cost for the bridge group on the Ethernet interface. The range
of supported values is 0-2147483647.
Default
None.
Usage Guidelines
Use this command to specify a path cost for a bridge group on an Ethernet interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
552
Use the set form of this command to specify the path cost.
Use the delete form of this command to remove the path cost.
Use the show form of this command to view the path cost.
Command Reference
Rel VC4.1 v. 03
Vyatta
553
Syntax
set interfaces ethernet ethx bridge-group priority priority
delete interfaces ethernet ethx bridge-group priority
show interfaces ethernet ethx bridge-group priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
bridge-group {
priority: [0-255]
}
}
}
Parameters
ethx
priority
The path priority for the bridge group on the Ethernet interface. The
supported values are 0-255.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
554
Usage Guidelines
Use this command to specify a path priority for a bridge group on an Ethernet interface.
Use the set form of this command to specify the path priority.
Use the delete form of this command to remove the path priority.
Use the show form of this command to view the path priority.
Command Reference
Rel VC4.1 v. 03
Vyatta
555
Syntax
set interfaces ethernet ethx vif vlan-id bridge-group bridge group-id
delete interfaces ethernet ethx vif vlan-id bridge-group bridge
show interfaces ethernet ethx vif vlan-id bridge-group bridge
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
bridge-group {
bridge: br0..br9
}
}
}
}
Parameters
ethx
Command Reference
vlan-id
group-id
The bridge group ID to assign the interface to. Supported identifiers are
br0 through br9.
Rel VC4.1 v. 03
Vyatta
556
Default
None.
Usage Guidelines
Use this command to specify a bridge group to add a virtual interface to.
Use the set form of this command to specify the bridge group id.
Use the delete form of this command to remove the bridge group id.
Use the show form of this command to view the bridge group id.
Command Reference
Rel VC4.1 v. 03
Vyatta
557
Syntax
set interfaces ethernet ethx vif vlan-id bridge-group cost cost
delete interfaces ethernet ethx vif vlan-id bridge-group cost
show interfaces ethernet ethx vif vlan-id bridge-group cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
bridge-group {
cost: [0-2147483647]
}
}
}
}
Parameters
ethx
Command Reference
vlan-id
cost
The path cost for the bridge group on the Ethernet interface. The range
of supported values is 0-2147483647.
Rel VC4.1 v. 03
Vyatta
558
Default
None.
Usage Guidelines
Use this command to specify a path cost for a bridge group on a virtual interface.
Use the set form of this command to specify the path cost.
Use the delete form of this command to remove the path cost.
Use the show form of this command to view the path cost.
Command Reference
Rel VC4.1 v. 03
Vyatta
559
Syntax
set interfaces ethernet ethx vif vlan-id bridge-group priority priority
delete interfaces ethernet ethx vif vlan-id bridge-group priority
show interfaces ethernet ethx vif vlan-id bridge-group priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
bridge-group {
priority: [0-255]
}
}
}
}
Parameters
ethx
Command Reference
vlan-id
priority
The path priority for the bridge group on the Ethernet interface. The
supported values are 0-255.
Rel VC4.1 v. 03
Vyatta
560
Default
None.
Usage Guidelines
Use this command to specify a path priority for a bridge group on a virtual interface.
Use the set form of this command to specify the path priority.
Use the delete form of this command to remove the path priority.
Use the show form of this command to view the path priority.
Command Reference
Rel VC4.1 v. 03
Vyatta
561
show bridge
show bridge
Displays the information for active bridge groups.
Syntax
show bridge [bridge-group [macs | spanning-tree]]
Command Mode
Operational mode.
Parameters
bridge-group
macs
spanning-tree
Usage Guidelines
Use this command to display information about configured bridge groups.
When used with no option, this command displays information about all active bridge
groups. When the identifier of a bridge group is provided, this command displays
information for the specified bridge group. You can display the MAC table and Spanning
Tree Protocol information for a bridge group.
Command Reference
Rel VC4.1 v. 03
Vyatta
562
Syntax
show interfaces bridge [bridge-group [brief] | detail]
Command Mode
Operational mode.
Parameters
bridge-group
brief
detail
Usage Guidelines
Use this command to display information about configured bridge interfaces.
When used with no option, this command displays information about all active bridge
interfaces. When the identifier of a bridge group is provided, this command displays
information for the specified bridge group.
Command Reference
Rel VC4.1 v. 03
Vyatta
563
564
This chapter lists the commands for configuring static routes on the Vyatta system.
This chapter contains the following commands.
Command
Description
protocols static route <subnet> next-hop <address> Allows you to configure the next hop for a static route.
Syntax
set protocols static interface-route subnet next-hop-interface ethx [distance distance]
delete protocols static interface-route subnet next-hop-interface ethx [distance]
show protocols static interface-route subnet next-hop-interface ethx [distance]
Command Mode
Configuration mode.
Configuration Statement
protocols {
static {
interface-route ipv4net {
next-hop-interface eth0..eth23 {
distance: 1-255
}
}
}
}
Parameters
subnet
Command Reference
ethx
distance
Optional. Defines the next hop distance for this route. Routes
with a smaller distance will be selected before those with a
larger distance.
Rel VC4.1 v. 03
Vyatta
565
Default
None.
Usage Guidelines
Use this command to configure interface-based static routes on the router.
Use the set form of this command to specify the next hop interface for the route.
Use the delete form of this command to remove the next hop interface.
Use the show form of this command to view the next hop interface for the route.
Command Reference
Rel VC4.1 v. 03
Vyatta
566
Syntax
set protocols static route subnet blackhole [distance distance]
delete protocols static route subnet blackhole [distance]
show protocols static route subnet blackhole [distance]
Command Mode
Configuration mode.
Configuration Statement
protocols {
static {
route ipv4net {
blackhole {
distance: 1-255
}
}
}
}
Parameters
subnet
distance
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
567
Usage Guidelines
Use this command to configure a blackhole static route. A blackhole route silently discards
packets that are matched.
Use the set form of this command to specify a blackhole static route.
Use the delete form of this command to remove a blackhole static route.
Use the show form of this command to view blackhole static route configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
568
Syntax
set protocols static route subnet next-hop address [distance distance]
delete protocols static route subnet next-hop address [distance]
show protocols static route subnet next-hop address [distance]
Command Mode
Configuration mode.
Configuration Statement
protocols {
static {
route ipv4net {
next-hop ipv4 {
distance: 1-255
}
}
}
}
Parameters
subnet
address
distance
Optional. Defines the next hop distance for this route. Routes
with a smaller distance will be selected before those with a
larger distance.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
569
Usage Guidelines
Use this command to configure static routes on the router.
Use the set form of this command to specify the next hop for the route.
Use the delete form of this command to remove the static route next hop.
Use the show form of this command to view static route next hop configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
570
571
This chapter lists the commands for setting up the Routing Information Protocol
(RIP) on the Vyatta system.
This chapter contains the following commands.
Command
Description
572
Command
Description
Allows you to set the timer for RIP routing table updates.
RIP Configuration Commands for ADSL Interfaces with Classical IPOA Encapsulation
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip
RIP Configuration Commands for ADSL Interfaces with Classical PPPoA Encapsulation
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip
rip
Command Reference
Rel VC4.1 v. 03
Vyatta
573
Command
Description
interfaces loopback lo ip rip split-horizon poison-reverse Enables or disables split-horizon poison-reverse in RIP
updates coming from this interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
574
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
575
Command
Description
show ip rip
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
debug rip events
no debug rip events
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enable generation of trace-level messages related to Routing
Information Protocol (RIP) events.
Use the no form of this command to disable debugging of RIP events.
Command Reference
Rel VC4.1 v. 03
Vyatta
576
Syntax
debug rip packet [recv [detail] | send [detail]]
no debug rip packet [recv | send ]
Command Mode
Operational mode.
Parameters
recv
recv detail
send
send detail
Default
None.
Usage Guidelines
Use this command to enable generation of trace-level messages related to all Routing
Information Protocol (RIP) packet types.
Use the no form of this command to disable debugging of all RIP packet types.
Command Reference
Rel VC4.1 v. 03
Vyatta
577
Syntax
debug rip zebra
no debug rip zebra
Command Mode
Operational mode.
Parameters
None.
Default
Debug messages are generated for actions related to the Zebra RIP process.
Usage Guidelines
Use this command to enable generation of trace-level messages related to the Zebra
Routing Information Protocol (RIP) process.
Use the no form of this command to disable debugging for the Zebra RIP process.
Command Reference
Rel VC4.1 v. 03
Vyatta
578
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip rip
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip rip
show interfaces adsl adslx pvc pvc-id classical-ipoa ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
rip
}
}
}
}
}
Parameters
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
579
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on a PVC with Classical
IP over Asynchronous Transfer Mode (IPOA) encapsulation on an ADSL interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
580
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip rip authentication [md5 md5-key
password md5-password | plaintext-password password]
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip rip authentication [md5
md5-key password | plaintext-password]
show interfaces adsl adslx pvc pvc-id classical-ipoa ip rip authentication [md5 md5-key
password | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
581
Parameters
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical
ADSL ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255,
vci is a Virtual Circuit Index from from 0 to 65535, and auto directs
the system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a PVC with
Classical IP over Asynchronous Transfer Mode (IPOA) encapsulation on an ADSL
interface. This authentication is independent of the authentication configured for the RIP
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a PVC with Classical IPOA
encapsulation on an ADSL interface.
Use the delete form of this command to remove RIP authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
582
Use the show form of this command to display RIP authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
583
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip rip split-horizon poison-reverse
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip rip split-horizon
show interfaces adsl adslx pvc pvc-id classical-ipoa ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
}
Parameters
adslx
Command Reference
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical
ADSL ports are actually available on the system.
Rel VC4.1 v. 03
Vyatta
584
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255,
vci is a Virtual Circuit Index from from 0 to 65535, and auto directs
the system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
585
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip rip
delete interfaces adsl adslx pvc pvc-id pppoa num ip rip
show interfaces adsl adslx pvc pvc-id pppoa num ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
rip
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
Rel VC4.1 v. 03
Vyatta
586
Default
None.
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on a PVC with
Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA) encapsulation on an
ADSL interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
587
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip rip authentication [md5 md5-key
password md5-password | plaintext-password password]
delete interfaces adsl adslx pvc pvc-id pppoa num ip rip authentication [md5 md5-key
password | plaintext-password]
show interfaces adsl adslx pvc pvc-id pppoa num ip rip authentication [md5 md5-key
password | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
588
Parameters
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical
ADSL ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255,
vci is a Virtual Circuit Index from from 0 to 65535, and auto directs
the system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a PVC with
Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA) encapsulation on an
ADSL interface. This authentication is independent of the authentication configured for the
RIP area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Command Reference
Rel VC4.1 v. 03
Vyatta
589
Use the set form of this command to set RIP authentication for a PVC with PPPoA
encapsulation on an ADSL interface.
Use the delete form of this command to remove RIP authentication configuration
information.
Use the show form of this command to display RIP authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
590
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip split-horizon poison-reverse
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip rip split-horizon poison-reverse
delete interfaces adsl adslx pvc pvc-id pppoa num ip rip split-horizon
show interfaces adsl adslx pvc pvc-id pppoa num ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
}
Parameters
adslx
Command Reference
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical
ADSL ports are actually available on the system.
Rel VC4.1 v. 03
Vyatta
591
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip split-horizon poison-reverse
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255,
vci is a Virtual Circuit Index from from 0 to 65535, and auto directs
the system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on an ADSL interface
with Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA) encapsulation
running RIP.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
592
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip rip
delete interfaces adsl adslx pvc pvc-id pppoe num ip rip
show interfaces adsl adslx pvc pvc-id pppoe num ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
rip
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
Rel VC4.1 v. 03
Vyatta
593
Default
None.
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on a PVC with
Point-to-Point Protocol over Ethernet (PPPoE) encapsulation on an ADSL interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
594
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip rip authentication [md5 md5-key
password md5-password | plaintext-password password]
delete interfaces adsl adslx pvc pvc-id pppoe num ip rip authentication [md5 md5-key
password | plaintext-password]
show interfaces adsl adslx pvc pvc-id pppoe num ip rip authentication [md5 md5-key
password | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
595
Parameters
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical
ADSL ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255,
vci is a Virtual Circuit Index from from 0 to 65535, and auto directs
the system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a PVC with
Point-to-Point Protocol over Ethernet (PPPoE) encapsulation on an ADSL interface. This
authentication is independent of the authentication configured for the RIP area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a PVC with PPPoE
encapsulation on an ADSL interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
596
Use the delete form of this command to remove RIP authentication configuration
information.
Use the show form of this command to display RIP authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
597
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip split-horizon poison-reverse
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip rip split-horizon poison-reverse
delete interfaces adsl adslx pvc pvc-id pppoe num ip rip split-horizon
show interfaces adsl adslx pvc pvc-id pppoe num ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
}
Parameters
adslx
Command Reference
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical
ADSL ports are actually available on the system.
Rel VC4.1 v. 03
Vyatta
598
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip split-horizon poison-reverse
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255,
vci is a Virtual Circuit Index from from 0 to 65535, and auto directs
the system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
599
Syntax
set interfaces ethernet ethx ip rip
delete interfaces ethernet ethx ip rip
show interfaces ethernet ethx ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
rip
}
}
}
Parameters
ethx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
Default
None.
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on an Ethernet interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
600
Syntax
set interfaces ethernet ethx ip rip authentication [md5 md5-key password
md5-password | plaintext-password password]
delete interfaces ethernet ethx ip rip authentication [md5 md5-key password |
plaintext-password]
show interfaces ethernet ethx ip rip authentication [md5 md5-key password |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
601
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on an Ethernet
interface. This authentication is independent of the authentication configured for the RIP
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for an Ethernet interface.
Use the delete form of this command to remove RIP Ethernet interface authentication
configuration information.
Use the show form of this command to display RIP Ethernet interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
602
Syntax
set interfaces ethernet ethx ip rip split-horizon poison-reverse
delete interfaces ethernet ethx ip rip split-horizon
show interfaces ethernet ethx ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
Parameters
ethx
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
603
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a ADSL interface
with Point-to-Point Protocol over Ethernet (PPPoE) encapsulation running RIP.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
604
Syntax
set interfaces ethernet ethx pppoe num ip rip
delete interfaces ethernet ethx pppoe num ip rip
show interfaces ethernet ethx pppoe num ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
rip
}
}
}
}
Parameters
ethx
num
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
605
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on a Point-to-Point over
Ethernet (PPPoE) interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
606
Syntax
set interfaces ethernet ethx pppoe num ip rip authentication [md5 md5-key password
md5-password | plaintext-password password]
delete interfaces ethernet ethx pppoe num ip rip authentication [md5 md5-key
password | plaintext-password]
show interfaces ethernet ethx pppoe num ip rip authentication [md5 md5-key password
| plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
pppoe 0-15 {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
607
Parameters
ethx
num
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a
Point-to-Point over Ethernet (PPPoE) interface. This authentication is independent of the
authentication configured for the RIP area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a PPPoE interface.
Use the delete form of this command to remove RIP PPPoE interface authentication
configuration information.
Use the show form of this command to display RIP PPPoE interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
608
Syntax
set interfaces ethernet ethx pppoe num ip rip split-horizon poison-reverse
delete interfaces ethernet ethx pppoe num ip rip split-horizon
show interfaces ethernet ethx pppoe num ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
Parameters
ethx
num
Command Reference
Rel VC4.1 v. 03
Vyatta
609
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
610
Syntax
set interfaces ethernet ethx vif vlan-id ip rip
delete interfaces ethernet ethx vif vlan-id ip rip
show interfaces ethernet ethx vif vlan-id ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
rip
}
}
}
}
Parameters
ethx
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
Command Reference
Rel VC4.1 v. 03
Vyatta
611
Default
None.
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on a virtual interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
612
Syntax
set interfaces ethernet ethx vif vlan-id ip rip authentication [md5 md5-key password
md5-password | plaintext-password password]
delete interfaces ethernet ethx vif vlan-id ip rip authentication [md5 md5-key password
| plaintext-password]
show interfaces ethernet ethx vif vlan-id ip rip authentication [md5 md5-key password
| plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
vif 0-4095 {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
613
Parameters
ethx
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured
on Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a virtual
interface. This authentication is independent of the authentication configured for the RIP
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a virtual interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
614
Use the delete form of this command to remove RIP virtual interface authentication
configuration information.
Use the show form of this command to display RIP virtual interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
615
Syntax
set interfaces ethernet ethx vif vlan-id ip rip split-horizon poison-reverse
delete interfaces ethernet ethx vif vlan-id ip rip split-horizon
show interfaces ethernet ethx vif vlan-id ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
616
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured
on Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
617
Syntax
set interfaces loopback lo ip rip
delete interfaces loopback lo ip rip
show interfaces loopback lo ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
rip
}
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on an Ethernet interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
618
Syntax
set interfaces loopback lo ip rip authentication [md5 md5-key password md5-password
| plaintext-password password]
delete interfaces loopback lo ip ospf authentication [md5 md5-key password |
plaintext-password]
show interfaces loopback lo ip ospf authentication [md5 md5-key password |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
Parameters
Command Reference
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Rel VC4.1 v. 03
Vyatta
619
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on the loopback
interface. This authentication is independent of the authentication configured for the OSPF
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for the loopback interface.
Use the delete form of this command to remove RIP loopback interface authentication
configuration information.
Use the show form of this command to display RIP loopback interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
620
Syntax
set interfaces loopback lo ip rip split-horizon poison-reverse
delete interfaces loopback lo ip rip split-horizon
show interfaces loopback lo ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
Parameters
None.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
621
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on the loopback
interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on the loopback
interface.
Use the delete form of this command to disable split-horizon poison-reverse on the
loopback interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
622
Syntax
set interfaces multilink mlx ip rip
delete interfaces multilink mlx ip rip
show interfaces multilink mlx ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
rip {
}
}
}
Parameters
mlx
Default
None.
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on a multilink interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
623
Syntax
set interfaces multilink mlx ip rip authentication [md5 md5-key password
md5-password | plaintext-password password]
delete interfaces multilink mlx ip rip authentication [md5 md5-key password |
plaintext-password]
show interfaces multilink mlx ip rip authentication [md5 md5-key password |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
Parameters
Command Reference
mlx
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
Rel VC4.1 v. 03
Vyatta
624
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a multilink
interface. This authentication is independent of the authentication configured for the RIP
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a multilink interface.
Use the delete form of this command to remove RIP multilink interface authentication
configuration information.
Use the show form of this command to display RIP multilink interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
625
Syntax
set interfaces multilink mlx ip rip split-horizon poison-reverse
delete interfaces multilink mlx ip rip split-horizon
show interfaces multilink mlx ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
Parameters
mlx
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
626
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
627
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip rip
delete interfaces serial wanx cisco-hdlc vif 1 ip rip
show interfaces serial wanx cisco-hdlc vif 1
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip rip
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
RIP is not enabled on Cisco HDLC interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
628
Usage Guidelines
Use this command to enable the Routing Information Protocol (RIP) routing protocol on
the virtual interface of a Cisco HDLC serial interface.
Use the set form of this command to enable RIP on a Cisco HDLC virtual interface.
Use the delete form of this command to disable RIP on a Cisco HDLC virtual interface.
Use the show form of this command to display Cisco HDLC virtual interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
629
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip rip authentication [md5 md5-key password
md5-password | plaintext-password password]
delete interfaces serial wanx cisco-hdlc vif 1 ip rip authentication [md5 md5-key
password | plaintext-password]
show interfaces serial wanx cisco-hdlc vif 1 ip rip authentication [md5 md5-key
password | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
630
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a Cisco
HDLC serial interface. This authentication is independent of the authentication configured
for the RIP area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a Cisco HDLC serial
interface.
Use the delete form of this command to remove RIP Cisco HDLC serial interface
authentication configuration information.
Use the show form of this command to display RIP Cisco HDLC serial interface
authentication configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
631
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip rip split-horizon poison-reverse
delete interfaces serial wanx cisco-hdlc vif 1 ip rip split-horizon
show interfaces serial wanx cisco-hdlc vif 1 ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
632
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
633
Syntax
set interfaces serial wanx frame-relay vif dlci ip rip
delete interfaces serial wanx frame-relay vif dlci ip rip
show interfaces serial wanx frame-relay vif dlci
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip rip
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
Default
RIP is not enabled on Frame Relay interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
634
Usage Guidelines
Use this command to enable the Routing Information Protocol (RIP) routing protocol on a
virtual interface of a Frame Relay serial interface.
Use the set form of this command to enable RIP on a Frame Relay virtual interface.
Use the delete form of this command to disable RIP on a Frame Relay virtual interface.
Use the show form of this command to display Frame Relay virtual interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
635
Syntax
set interfaces serial wanx frame-relay vif dlci ip rip authentication [md5 md5-key
password md5-password | plaintext-password password]
delete interfaces serial wanx frame-relay vif dlci ip rip authentication [md5 md5-key
password | plaintext-password]
show interfaces serial wanx frame-relay vif dlci ip rip authentication [md5 md5-key
password | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
636
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this
is the DLCI number for the interface. The range is 16 to 991.
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a virtual
interface of a Frame Relay serial interface. This authentication is independent of the
authentication configured for the RIP area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a virtual interface of a Frame
Relay serial interface.
Use the delete form of this command to remove RIP authentication configuration
information from the virtual interface of a Frame Relay serial interface.
Use the show form of this command to display RIP authentication configuration
information for the virtual interface of a Frame Relay serial interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
637
Syntax
set interfaces serial wanx frame-relay vif dlci ip rip split-horizon poison-reverse
delete interfaces serial wanx frame-relay vif dlci ip rip split-horizon
show interfaces serial wanx frame-relay vif dlci ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this
is the DLCI number for the interface. The range is 16 to 991.
Rel VC4.1 v. 03
Vyatta
638
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
639
Syntax
set interfaces serial wanx ppp vif 1 ip rip
delete interfaces serial wanx ppp vif 1 ip rip
show interfaces serial wanx ppp vif 1
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip rip
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
RIP is not enabled on PPP interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
640
Usage Guidelines
Use this command to enable the Routing Information Protocol (RIP) routing protocol on
the virtual interface of a Point-to-Point Protocol (PPP) serial interface.
Use the set form of this command to enable RIP on a PPP virtual interface.
Use the delete form of this command to disable RIP on a PPP virtual interface.
Use the show form of this command to display PPP virtual interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
641
Syntax
set interfaces serial wanx ppp vif 1 ip rip authentication [md5 md5-key password
md5-password | plaintext-password password]
delete interfaces serial wanx ppp vif 1 ip rip authentication [md5 md5-key password |
plaintext-password]
show interfaces serial wanx ppp vif 1 ip rip authentication [md5 md5-key password |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
}
}
Parameters
wanx
Command Reference
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
642
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on the virtual
interface of a Point-to-Point Protocol (PPP) serial interface. This authentication is
independent of the authentication configured for the RIP area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for the virtual interface of a
Point-to-Point Protocol (PPP) serial interface.
Use the delete form of this command to remove RIP authentication configuration
information from the virtual interface of a Point-to-Point Protocol (PPP) serial interface.
Use the show form of this command to display RIP authentication configuration
information for the virtual interface of a Point-to-Point Protocol (PPP) serial interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
643
Syntax
set interfaces serial wanx ppp vif 1 ip rip split-horizon poison-reverse
delete interfaces serial wanx ppp vif 1 ip rip split-horizon
show interfaces serial wanx ppp vif 1 ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
644
Default
None.
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
645
Syntax
set interfaces tunnel tunx ip rip
delete interfaces tunnel tunx ip rip
show interfaces tunnel tunx ip rip
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
rip {
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
Default
None.
Usage Guidelines
Use this command to enable Routing Information Protocol (RIP) on a tunnel interface.
Use the set form of this command to enable RIP on an interface.
Use the delete form of this command to remove all RIP configuration and disable RIP on
the interface.
Use the show form of this command to display RIP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
646
Syntax
set interfaces tunnel tunx ip rip authentication [md5 md5-key password md5-password
| plaintext-password password]
delete interfaces tunnel tunx ip rip authentication [md5 md5-key password |
plaintext-password]
show interfaces tunnel tunx ip rip authentication [md5 md5-key password |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
rip {
authentication {
md5 u32 {
password: text
}
plaintext-password: text
}
}
}
}
}
Parameters
Command Reference
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
md5-key
Optional. The authentication key ID. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
Rel VC4.1 v. 03
Vyatta
647
md5-password
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for RIP on a tunnel
interface. This authentication is independent of the authentication configured for the RIP
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the RIP packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set RIP authentication for a tunnel interface.
Use the delete form of this command to remove RIP tunnel interface authentication
configuration information.
Use the show form of this command to display RIP tunnel interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
648
Syntax
set interfaces tunnel tunx ip rip split-horizon poison-reverse
delete interfaces tunnel tunx ip rip split-horizon
show interfaces tunnel tunx ip rip split-horizon
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
rip {
split-horizon {
poison-reverse
}
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
649
Usage Guidelines
Use this command to enable or disable split-horizon poison-reverse on a RIP interface.
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected. Enabling split-horizon stops an interface
from including in its network updates any routes that it learned from that interface. Split
horizon is effective at preventing loops between routers that are directly connected to one
another, and speeds convergence when network conditions change.
Poison reverse is a variation of split horizon. When an interface with poison reverse
enabled detects that a link is down, it increases the metric for that route to 16, and
propagates that information in its next update. Since 15 is the largest number of hops
considered reachable on a RIP network, increasing the metric to 16 renders the route
unreachable as far as downstream RIP routers are concerned. This is called poisoning the
route. Poison reverse can be useful for propagating information about bad routes to routers
that are downstream but not immediate neighbors, where split horizon is ineffective.
When this option is enabled, the router includes the route in announcements to the neighbor
from which it was learned. When this option is disabled, the router omits the route in
announcements to the neighbor from which it was learned.
Use the set form of this command to enable split-horizon poison-reverse on a RIP interface.
Use the delete form of this command to disable split-horizon poison-reverse on a RIP
interface.
Use the show form of this command to display split-horizon poison-reverse configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
650
Syntax
set protocols rip default-distance distance
delete protocols rip default-distance
show protocols rip default-distance
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
default-distance 1-255
}
}
Parameters
distance
Mandatory. Sets the default administrative distance for RIP. The range
is 1-255. The default is 120.
Default
The default administrative distance for RIP is 120.
Usage Guidelines
Use the set form of this command to set the default administrative distance for RIP.
Use the delete form of this command to restore the default administrative distance for RIP.
Use the show form of this command to display the administrative distance for RIP.
Command Reference
Rel VC4.1 v. 03
Vyatta
651
Syntax
set protocols rip default-information originate
delete protocols rip default-information originate
show protocols rip default-information originate
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
default-information {
originate
}
}
}
Parameters
None.
Default
By default, the system does not generate an external default route into the OSPF routing
domain.
Usage Guidelines
Use the set form of this command to generate a default route into the RIP routing domain.
Use the delete form of this command to restore the default behavior for default route
generation into RIP.
Use the show form of this command to display default route generation configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
652
Syntax
set protocols rip default-metric metric
delete protocols rip default-metric
show protocols rip default-metric
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
default-metric 1-16
}
}
Parameters
metric
Default
Routes being imported into RIP are assigned a metric of 1.
Usage Guidelines
Use the set form of this command to set the metric for routes being redistributed into RIP.
Use the delete form of this command to restore the default RIP metric to default values.
Use the show form of this command to display the default metric for routes being
redistributed into RIP.
Command Reference
Rel VC4.1 v. 03
Vyatta
653
Syntax
set protocols rip distribute-list access-list {in in-list | out out-list}
delete protocols rip distribute-list access-list {in | out}
show protocols rip distribute-list access-list {in | out}
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
distribute-list {
access-list {
in: u32
out: u32
}
}
}
}
Parameters
in-list
The identifier of a defined access list. The access list will be applied
to filter inbound RIP packets.
out-list
The identifier of a defined access list. The access list will be applied
to filter outbound RIP packets.
Default
None.
Usage Guidelines
Use the set form of this command to apply an access list for filtering inbound or outbound
RIP packets.
Command Reference
Rel VC4.1 v. 03
Vyatta
654
Use the delete form of this command to remove access list packet filtering from RIP
packets.
Use the show form of this command to display RIP access list filtering configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
655
Syntax
set protocols rip distribute-list interface eth0..eth23 access-list {in in-list | out out-list]
delete protocols rip distribute-list interface eth0..eth23 access-list {in | out}
show protocols rip distribute-list interface eth0..eth23 access-list {in | out}
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
distribute-list {
interface eth0..eth23
access-list {
in: u32
out: u32
}
}
}
}
}
Parameters
eth0..eth23
in-list
The identifier of a defined access list. The access list will be applied
to the specified interface to filter inbound RIP packets.
out-list
The identifier of a defined access list. The access list will be applied
to the specified interface to filter outbound RIP packets.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
656
Usage Guidelines
Use the set form of this command to apply an access list to a specific interface for filtering
inbound or outbound RIP packets.
Use the delete form of this command to remove RIP access list packet filtering from an
interface.
Use the show form of this command to display RIP access list filtering configuration for an
interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
657
Syntax
set protocols rip distribute-list interface eth0..eth23 prefix-list {in in-list | out out-list}
delete protocols rip distribute-list interface eth0..eth23 prefix-list {in | out}
show protocols rip distribute-list interface eth0..eth23 prefix-list {in | out}
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
distribute-list {
interface eth0..eth23
prefix-list {
in: text
out: text
}
}
}
}
}
Parameters
eth0..eth23
in-list
The identifier of a defined prefix list. The prefix list will be applied to
the specified interface to filter inbound RIP packets.
out-list
The identifier of a defined prefix list. The prefix list will be applied to
the specified interface to filter outbound RIP packets.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
658
Usage Guidelines
Use the set form of this command to apply a prefix list to a specific interface for filtering
inbound or outbound RIP packets.
Use the delete form of this command to remove RIP prefix list packet filtering from an
interface.
Use the show form of this command to display RIP prefix list filtering configuration for an
interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
659
Syntax
set protocols rip distribute-list prefix-list {in in-list | out out-list}
delete protocols rip distribute-list prefix-list {in | out}
show protocols rip distribute-list prefix-list {in | out}
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
distribute-list {
prefix-list {
in: text
out: text
}
}
}
}
Parameters
in-list
The identifier of a defined prefix list. The prefix list will be applied to
filter inbound RIP packets.
out-list
The identifier of a defined prefix list. The prefix list will be applied to
filter outbound RIP packets.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
660
Usage Guidelines
Use the set form of this command to apply a prefix list for filtering inbound or outbound
RIP packets.
Use the delete form of this command to remove RIP prefix list packet filtering.
Use the show form of this command to display RIP prefix list filtering configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
661
Syntax
set protocols rip interface ethx
delete protocols rip interface ethx
show protocols rip interface ethx
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
interface: eth0..eth23
}
}
Parameters
ethx
Default
None.
Usage Guidelines
Split-horizon is a stability feature that reduces the possibility of network loops, particularly
in the case where links become disconnected and is enabled by default. Split-horizon stops
an interface from including in its network updates any routes that it learned from that
interface. Split horizon is effective at preventing loops between routers that are directly
connected to one another, and speeds convergence when network conditions change.
Command Reference
Rel VC4.1 v. 03
Vyatta
662
Use the set form of this command to enable RIP on an interface. The interface must be
enabled for RIP before you can use it for RIP routing.
Use the delete form of this command to disable RIP on an interface.
Use the show form of this command to display RIP interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
663
Syntax
set protocols rip neighbor ipv4
delete protocols rip neighbor ipv4
show protocols rip neighbor
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
neighbor: ipv4
}
}
Parameters
ipv4
Default
None.
Usage Guidelines
Use the set form of this command to define a RIP neighbor router.
Use the delete form of this command to remove a neighbor router.
Use the show form of this command to display RIP neighbor configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
664
Syntax
set protocols rip network ipv4net
delete protocols rip network ipv4net
show protocols rip network
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
network: ipv4net
}
}
Parameters
ipv4net
Default
None.
Usage Guidelines
Use the set form of this command to specify a RIP network.
Use the delete form of this command to remove a RIP network.
Use the show form of this command to display RIP network configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
665
Syntax
set protocols rip network-distance ipv4net {access-list list-name | distance distance}
delete protocols rip network-distance ipv4net [access-list list-name | distance distance]
show protocols rip network-distance ipv4net [access-list | distance]
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
network-distance ipv4net {
access-list: text
distance: 1-255
}
}
Parameters
ipv4net
access-list
distance
Default
None.
Usage Guidelines
Use the set form of this command to set the default administrative distance for a RIP
network or apply an access list to a RIP network.
Command Reference
Rel VC4.1 v. 03
Vyatta
666
Command Reference
Rel VC4.1 v. 03
Vyatta
667
Syntax
set protocols rip passive-interface ethx
delete protocols rip passive-interface ethx
show protocols rip passive-interface
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
passive-interface: eth0..eth23
}
}
Parameters
eth0..eth23
Default
RIP routing updates are not suppressed.
Usage Guidelines
Use the set form of this command to suppress RIP routing updates on an interface
Use the delete form of this command to disable RIP routing update suppression on an
interface.
Use the show form of this command to display RIP route suppression configuration for an
interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
668
Command Reference
Rel VC4.1 v. 03
Vyatta
669
Syntax
set protocols rip redistribute bgp [metric metric | route-map map-name]
delete protocols rip redistribute bgp [metric | route-map]
show protocols rip redistribute bgp [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
redistribute {
bgp {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric metric
map-name
Default
BGP routes being redistributed into RIP are assigned a routing metric of 1. By default, no
route map is applied to redistributed BGP routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
670
Usage Guidelines
Use the set form of this command to set the routing metric for BGP routes being
redistributed into RIP, or to specify a route map to be applied to redistributed BGP routes.
Use the delete form of this command to remove BGP route redistribution configuration.
Use the show form of this command to display BGP route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
671
Syntax
set protocols rip redistribute connected [metric metric | route-map map-name]
delete protocols rip redistribute connected [metric | route-map]
show protocols rip redistribute connected [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
redistribute {
connected {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric
map-name
Default
Connected routes being redistributed into RIP are assigned a routing metric of 1. By
default, no route map is applied to redistributed connected routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
672
Usage Guidelines
Use the set form of this command to set the routing metric for connected routes being
redistributed into RIP, or to specify a route map to be applied to redistributed connected
routes.
Use the delete form of this command to remove connected route redistribution
configuration.
Use the show form of this command to display connected route redistribution
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
673
Syntax
set protocols rip redistribute kernel [metric metric | route-map map-name]
delete protocols rip redistribute kernel [metric | route-map]
show protocols rip redistribute kernel [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
redistribute {
kernel {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric
map-name
Default
Kernel routes being redistributed into RIP are assigned a routing metric of 1. By default,
no route map is applied to redistributed kernel routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
674
Usage Guidelines
Use the set form of this command to set the routing metric for kernel routes being
redistributed into RIP, or to specify a route map to be applied to redistributed kernel routes.
Use the delete form of this command to remove kernel route redistribution configuration.
Use the show form of this command to display kernel route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
675
Syntax
set protocols rip redistribute ospf [metric metric | route-map map-name]
delete protocols rip redistribute ospf [metric | route-map]
show protocols rip redistribute ospf [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
redistribute {
ospf {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric
map-name
Default
OSPF routes being redistributed into RIP are assigned a routing metric of 1. By default, no
route map is applied to redistributed OSPF routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
676
Usage Guidelines
Use the set form of this command to set the routing metric for OSPF routes being
redistributed into RIP, or to specify a route map to be applied to redistributed OSPF routes.
Use the delete form of this command to remove OSPF route redistribution configuration.
Use the show form of this command to display OSPF route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
677
Syntax
set protocols rip redistribute static [metric metric | route-map map-name]
delete protocols rip redistribute static [metric | route-map]
show protocols rip redistribute static [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
redistribute {
static {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric
map-name
Default
Static routes being redistributed into RIP are assigned a routing metric of 1. By default, no
route map is applied to redistributed static routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
678
Usage Guidelines
Use the set form of this command to set the routing metric for static routes being
redistributed into RIP, or to specify a route map to be applied to redistributed static routes.
Use the delete form of this command to remove static route redistribution configuration.
Use the show form of this command to display static route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
679
Syntax
set protocols rip route ipv4net
delete protocols rip route ipv4net
show protocols rip route
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
route ipv4net
}
}
Parameters
ipv4net
Default
None.
Usage Guidelines
Use the set form of this command to define a RIP static route.
Use the delete form of this command to remove a RIP static route.
Use the show form of this command to display RIP static route configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
680
Syntax
set protocols rip timers garbage-collection seconds
delete protocols rip timers garbage-collection [seconds]
show protocols rip timers garbage-collection
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
timers {
garbage-collection: 5-2147483647
}
}
}
Parameters
seconds
Default
The default is 120.
Usage Guidelines
Use the set form of this command to set the garbage collection timer. When the timer
expires, the system will scan for stale RIP resources and release them for use.
Use the delete form of this command to restore the default value for the RIP garbage
collection timer.
Use the show form of this command to display RIP garbage collection timer configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
681
Syntax
set protocols rip timers timeout seconds
delete protocols rip timers timeout [seconds]
show protocols rip timers timeout
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
timers {
timeout: 5-2147483647
}
}
}
Parameters
seconds
Default
RIP time-outs occur at 180 second.
Usage Guidelines
Use the set form of this command to set the value for RIP time-outs.
Use the delete form of this command to restore the RIP timeout interval to the default
value.
Use the show form of this command to display RIP timeout configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
682
Syntax
set protocols rip timers update seconds
delete protocols rip timers update [seconds]
show protocols rip timers update
Command Mode
Configuration mode.
Configuration Statement
protocols {
rip {
timers {
update: 5-2147483647
}
}
}
Parameters
seconds
Mandatory. The interval at which RIP routing table updates will occur.
The range is 5 is 2147483647. The default is 30.
Default
The RIP routing table is updated every 30 seconds.
Usage Guidelines
Use the set form of this command to set the interval between RIP routing table updates. The
shorter this interval, the more accurate the routing information in the tables; however, the
more protocol network traffic occurs.
Use the delete form of this command to restore the RIP update timer to the default value.
Use the show form of this command to display the RIP update time configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
683
Syntax
show debug rip
Command Mode
Operational mode.
Parameters
None
Default
None.
Usage Guidelines
Use this command to see how debugging is set for RIP.
Command Reference
Rel VC4.1 v. 03
Vyatta
684
Syntax
show ip route rip
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display RIP routes contained in the Routing Information Base (RIB).
Examples
Example 14-1 shows all RIP routes from the RIB.
Example 14-1 show ip route rip: Displaying routes
Command Reference
Rel VC4.1 v. 03
Vyatta
685
show ip rip
show ip rip
Displays information for the Routing Information Protocol (RIP).
Syntax
show ip rip [status]
Command Mode
Operational mode.
Parameters
status
Default
Displays all RIP protocol information.
Usage Guidelines
Use this command to see information about the Routing Information Protocol.
Examples
Example 14-2 lists RIP information.
Example 14-2 show ip rip: Displaying RIP information
Command Reference
Rel VC4.1 v. 03
Metric From
1 self
Tag Time
0
Vyatta
686
Command Reference
show ip rip
Rel VC4.1 v. 03
Vyatta
687
688
This chapter lists the commands for configuring OSPF on the Vyatta system.
This chapter contains the following commands.
Command
Description
689
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
690
Command
Description
OSPF Configuration Commands for ADSL Interfaces with Classical IPOA Encapsulation
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip
ospf
Command Reference
Rel VC4.1 v. 03
Vyatta
691
Command
Description
Sets the OSPF dead interval for an ADSL PVC with PPPoA
encapsulation.
Command Reference
Rel VC4.1 v. 03
Vyatta
692
Command
Description
Sets the OSPF dead interval for an ADSL PVC with PPPoE
encapsulation.
Command Reference
Rel VC4.1 v. 03
Vyatta
693
Command
Description
interfaces ethernet <ethx> pppoe <num> ip ospf priority Sets the priority for OSPF on a PPPoE interface.
<priority>
interfaces ethernet <ethx> pppoe <num> ip ospf
retransmit-interval <interval>
Command Reference
Rel VC4.1 v. 03
Vyatta
694
Command
Description
interfaces ethernet <ethx> vif <vlan-id> ip ospf network Specifies the OSPF network type for a virtual interface.
<type>
interfaces ethernet <ethx> vif <vlan-id> ip ospf priority
<priority>
Command Reference
Rel VC4.1 v. 03
Vyatta
695
Command
Description
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf network Specifies the OSPF network type for the virtual interface
<type>
of a Cisco HDLC serial interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
696
Command
Description
interfaces serial <wanx> ppp vif 1 ip ospf authentication Specifies the authentication method for OSPF on the
virtual interface of a PPP serial interface.
interfaces serial <wanx> ppp vif 1 ip ospf bandwidth
<bandwidth>
Command Reference
Rel VC4.1 v. 03
Vyatta
697
Command
Description
interfaces serial <wanx> ppp vif 1 ip ospf transmit-delay Specifies the OSPF transmit delay for the virtual interface
<delay>
of a PPP serial interface.
interfaces tunnel <tunx> ip ospf dead-interval <interval> Sets the OSPF dead interval for a tunnel interface.
interfaces tunnel <tunx> ip ospf hello-interval <interval> Sets the interval between OSPF hello packets on a tunnel
interface.
interfaces tunnel <tunx> ip ospf mtu-ignore
interfaces tunnel <tunx> ip ospf transmit-delay <delay> Specifies the OSPF transmit delay for a tunnel interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
698
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
Command
699
Description
show ip ospf
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
debug ospf event
no debug ospf event
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF events.
Use the no form of this command to disable debugging for OSPF events.
Command Reference
Rel VC4.1 v. 03
Vyatta
700
Syntax
debug ospf ism [events | status | timers]
no debug ospf ism [events | status | timers]
Command Mode
Operational mode.
Parameters
events
status
timers
Default
When used with no option, this command enables or disables all OSPF ISM messages.
Usage Guidelines
Use this command to enable generation of trace-level messages related to the OSPF ISM.
Use the no form of this command to disable debugging for the OSPF ISM.
Command Reference
Rel VC4.1 v. 03
Vyatta
701
Syntax
debug ospf lsa [flooding | generate | install | refresh]
no debug ospf lsa [flooding | generate | install | refresh]
Command Mode
Operational mode.
Parameters
flooding
generate
install
refresh
Default
When used with no option, this command enables debugging for all OSPF link-state
advertisement activity.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF link-state
advertisements.
Use the no form of this command to disable debugging for OSPF link-state advertisements.
Command Reference
Rel VC4.1 v. 03
Vyatta
702
Syntax
debug ospf nsm [events | status | timers]
no debug ospf nsm [events | status | timers]
Command Mode
Operational mode.
Parameters
events
status
timers
Default
When used with no option, this command enables or disables all OSPF NSM messages.
Usage Guidelines
Use this command to enable generation of trace-level messages related to the OSPF NSM.
Use the no form of this command to disable debugging for the OSPF NSM.
Command Reference
Rel VC4.1 v. 03
Vyatta
703
Syntax
debug ospf nssa
no debug ospf nssa
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF
not-so-stubby areas (NSSAs).
Use the no form of this command to disable debugging for OSPF not-so-stubby areas
(NSSAs).
Command Reference
Rel VC4.1 v. 03
Vyatta
704
Syntax
debug ospf packet all [detail | recv [detail] | send [detail]]
no debug ospf packet all [detail | recv [detail] | send [detail]]
Command Mode
Operational mode.
Parameters
detail
recv
detail
send
detail
Default
Debug messages are generated for all OSPF packets at a medium level of detail.
Usage Guidelines
Use this command to enable generation of trace-level messages related to all OSPF packet
types arriving and leaving the router.
Use the no form of this command to disable debugging for all OSPF packet types.
Command Reference
Rel VC4.1 v. 03
Vyatta
705
Syntax
debug ospf packet dd [detail | recv [detail] | send [detail]]
no debug ospf packet dd [detail | recv [detail] | send [detail]]
Command Mode
Operational mode.
Parameters
detail
recv
detail
send
detail
Default
Debug messages are generated for OSPF DD packets at a medium level of detail.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF Database
Description (DD) packets. OSPF DD packets provide a summary (digest) of each link-state
advertisement in the link-state databases. OSPF routers exchange these packets to keep data
synchronized.
Use the no form of this command to disable debugging for OSPF DD packets.
Command Reference
Rel VC4.1 v. 03
Vyatta
706
Syntax
debug ospf packet hello [detail | recv [detail] | send [detail]]
no debug ospf packet hello [detail | recv [detail] | send [detail]]
Command Mode
Operational mode.
Parameters
detail
recv
detail
send
detail
Default
Debug messages are generated for OSPF hello packets at a medium level of detail.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF hello
packets. OSPF hello packets are sent at intervals to discover neighbors and ensure that
neighbors are reachable. Hello packets include information about certain OSPF timers, the
Designated Router (DR), the Backup Designated Router (BDR), and known neighbors.
Use the no form of this command to disable debugging for OSPF hello packets.
Command Reference
Rel VC4.1 v. 03
Vyatta
707
Syntax
debug ospf packet ls-ack [detail | recv [detail] | send [detail]]
no debug ospf packet ls-ack [detail | recv [detail] | send [detail]]
Command Mode
Operational mode.
Parameters
detail
recv
detail
send
detail
Default
Debug messages are generated for OSPF LS Ack packets at a medium level of detail.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF LS Ack
packets. LS Ack packets are sent to OSPF neighbors to acknowledge receipt of a neighbor's
link-state advertisement update (LSU packet).
Use the no form of this command to disable debugging for OSPF LS Ack packets.
Command Reference
Rel VC4.1 v. 03
Vyatta
708
Syntax
debug ospf packet ls-request [detail | recv [detail] | send [detail]]
no debug ospf packet ls-request [detail | recv [detail] | send [detail]]
Command Mode
Operational mode.
Parameters
detail
recv
detail
send
detail
Default
Debug messages are generated for OSPF LSR packets at a medium level of detail.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF link-state
request (LSR) packets. After exchanging Database Description packets, neighboring OSPF
routers determine which LSAs are missing from the local link-state database. The local
router sends an LSR packet to the neighbor to request the missing LSAs.
Use the no form of this command to disable debugging for OSPF LSR packets.
Command Reference
Rel VC4.1 v. 03
Vyatta
709
Syntax
debug ospf packet ls-update [detail | recv [detail] | send [detail]]
no debug ospf packet ls-update [detail | recv [detail] | send [detail]]
Command Mode
Operational mode.
Parameters
detail
recv
detail
send
detail
Default
Debug messages are generated for OSPF LSU packets at a medium level of detail.
Usage Guidelines
Use this command to enable generation of trace-level messages related to OSPF link-state
update (LSU) packets. LSU packets send any required LSA updates to an OSPF neighbor.
Use the no form of this command to disable debugging for OSPF LSU packets.
Command Reference
Rel VC4.1 v. 03
Vyatta
710
Syntax
debug ospf zebra [interface | redistribute]
no debug ospf zebra [interface | redistribute]
Command Mode
Operational mode.
Parameters
interface
redistribute
Default
Debug messages are generated for actions related to the Zebra OSPF process.
Usage Guidelines
Use this command to enable generation of trace-level messages related to the Zebra OSPF
process.
Use the no form of this command to disable debugging for the Zebra OSPF process.
Command Reference
Rel VC4.1 v. 03
Vyatta
711
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
712
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
PVC with Classical IP over Asynchronous Transfer ModeClassical IP over Asynchronous
Transfer Mode (IPOA) encapsulation on an ADSL interface.
Use the set form of this command to enable OSPF on an interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on an interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
713
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf authentication [md5 key-id
key-id md5-key md5-key | plaintext-password password]
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
714
Parameters
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on a PVC with
Classical IP over Asynchronous Transfer Mode (IPOA) encapsulation on an ADSL
interface. This authentication is independent of the authentication configured for the OSPF
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Command Reference
Rel VC4.1 v. 03
Vyatta
715
Use the set form of this command to set the authentication for a PVC with Classical IPOA
encapsulation on an ADSL interface.
Use the delete form of this command to remove authentication configuration information.
Use the show form of this command to display authentication configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
716
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf bandwidth bandwidth
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf bandwidth
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
717
bandwidth
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of a PVC with Classical IP over Asynchronous
Transfer Mode (IPOA) encapsulation on an ADSL interface for the purpose of computing
OSPF cost.
Use the set form of this command to specify the bandwidth of the interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
718
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf cost cost
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf cost
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
cost: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
719
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
a PVC with Classical IP over Asynchronous Transfer Mode (IPOA) encapsulation on an
ADSL interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-1 shows the OSPF costs for some common media types.
Table 15-1 OSPF Costs for Common Media Types
Command Reference
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
Rel VC4.1 v. 03
Vyatta
720
The values in Table 15-7 show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
721
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf dead-interval interval
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf dead-interval
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
722
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which a PVC with Classical IP over
Asynchronous Transfer Mode (IPOA) encapsulation on an ADSL interface should expect
a hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
723
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf hello-interval interval
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf hello-interval
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
724
interval
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a PVC with
Classical IP over Asynchronous Transfer Mode (IPOA) encapsulation on an ADSL
interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
725
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf mtu-ignore
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf mtu-ignore
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
mtu-ignore
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
726
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
727
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf network [broadcast |
non-broadcast | point-to-multipoint | point-to-point]
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf network
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
network: text
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
728
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
729
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf priority priority
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf priority
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
priority: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
730
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the priority for a PVC with Classical IP over Asynchronous
Transfer Mode (IPOA) encapsulation on an ADSL interface on the broadcast network to
which the interface is connected. The priority determines which routers are selected as the
areas Designated Router (DR) and Backup Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
731
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf retransmit-interval interval
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf retransmit-interval
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
732
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long a PVC with Classical IP over Asynchronous
Transfer Mode (IPOA) encapsulation on an ADSL interface will wait for an
acknowledgment of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for a PVC with
Classical IPOA encapsulation on an ADSL interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
733
Syntax
set interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf transmit-delay delay
delete interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf transmit-delay
show interfaces adsl adslx pvc pvc-id classical-ipoa ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
classical-ipoa {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
734
delay
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for a PVC with Classical IP over Asynchronous
Transfer Mode (IPOA) encapsulation on an ADSL interface. This is the estimated time
required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
735
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
736
num
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
PVC with Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA)
encapsulation on an ADSL interface.
Use the set form of this command to enable OSPF on an interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on an interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
737
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf authentication [md5 key-id
key-id md5-key md5-key | plaintext-password password]
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
738
Parameters
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on a PVC with
Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA) encapsulation on an
ADSL interface. This authentication is independent of the authentication configured for the
OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
Command Reference
Rel VC4.1 v. 03
Vyatta
739
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for a PVC with PPPoA
encapsulation on an ADSL interface.
Use the delete form of this command to remove authentication configuration information.
Use the show form of this command to display authentication configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
740
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf bandwidth <bandwidth>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf bandwidth bandwidth
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf bandwidth
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
741
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf bandwidth <bandwidth>
num
bandwidth
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of a PVC with Point-to-Point Protocol over
Asynchronous Transfer Mode (PPPoA) encapsulation on an ADSL interface for the
purpose of computing OSPF cost.
Use the set form of this command to specify the bandwidth of the interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
742
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf cost cost
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf cost
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
cost: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
743
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost>
num
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
a PVC with Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA)
encapsulation on an ADSL interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-2 shows the OSPF costs for some common media types.
Table 15-2 OSPF Costs for Common Media Types
Command Reference
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
Rel VC4.1 v. 03
Vyatta
744
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost>
T3 (44.736 Mbps
100+ Mbps
The values in Table 15-7 show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
745
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf dead-interval <interval>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf dead-interval interval
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf dead-interval
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
746
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf dead-interval <interval>
num
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which a PVC with Point-to-Point Protocol
over Asynchronous Transfer Mode (PPPoA) encapsulation on an ADSL interface should
expect a hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
747
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf hello-interval <interval>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf hello-interval interval
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf hello-interval
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
748
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf hello-interval <interval>
num
interval
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a PVC with
Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA) encapsulation on an
ADSL interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
749
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf mtu-ignore
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf mtu-ignore
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
mtu-ignore
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
750
num
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an ADSL interface with
Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA) encapsulation running
OSPF.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
751
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf network <type>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf network [broadcast |
non-broadcast | point-to-multipoint | point-to-point]
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf network
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
network: text
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
752
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf network <type>
num
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for an ADSL interface with
Point-to-Point Protocol over Asynchronous Transfer Mode (PPPoA) encapsulation running
OSPF.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
753
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf priority <priority>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf priority priority
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf priority
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
priority: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
754
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf priority <priority>
num
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the priority for a PVC with PPPoA encapsulation on an ADSL
interface on the broadcast network to which the interface is connected. The priority
determines which routers are selected as the areas Designated Router (DR) and Backup
Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
755
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf retransmit-interval <interval>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf retransmit-interval interval
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf retransmit-interval
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
756
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf retransmit-interval <interval>
num
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long a PVC with PPPoA encapsulation on an ADSL
interface will wait for an acknowledgment of a link-state update before resending the
update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for a PVC with
PPPoA encapsulation on an ADSL interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
757
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf transmit-delay <delay>
Syntax
set interfaces adsl adslx pvc pvc-id pppoa num ip ospf transmit-delay delay
delete interfaces adsl adslx pvc pvc-id pppoa num ip ospf transmit-delay
show interfaces adsl adslx pvc pvc-id pppoa num ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoa 0-15 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
758
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf transmit-delay <delay>
num
delay
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for a PVC with PPPoA encapsulation on an
ADSL interface. This is the estimated time required to send a link-state update (LSU)
packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
759
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
760
num
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
PVC with Point-to-Point Protocol over Ethernet (PPPoE) encapsulation on an ADSL
interface.
Use the set form of this command to enable OSPF on an interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on an interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
761
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf authentication [md5 key-id
key-id md5-key md5-key | plaintext-password password]
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
762
Parameters
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
num
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on a PVC with
Point-to-Point Protocol over Ethernet (PPPoE) encapsulation on an ADSL interface. This
authentication is independent of the authentication configured for the OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Command Reference
Rel VC4.1 v. 03
Vyatta
763
Use the set form of this command to set the authentication for a PVC with PPPoE
encapsulation on an ADSL interface.
Use the delete form of this command to remove authentication configuration information.
Use the show form of this command to display authentication configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
764
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf bandwidth <bandwidth>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf bandwidth bandwidth
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf bandwidth
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
765
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf bandwidth <bandwidth>
num
bandwidth
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of a PVC with Point-to-Point Protocol over
Ethernet (PPPoE) encapsulation on an ADSL interface for the purpose of computing OSPF
cost.
Use the set form of this command to specify the bandwidth of the interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
766
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf cost <cost>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf cost cost
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf cost
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
cost: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
767
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf cost <cost>
num
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
a PVC with Point-to-Point Protocol over Ethernet (PPPoE) encapsulation on an ADSL
interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-3 shows the OSPF costs for some common media types.
Table 15-3 OSPF Costs for Common Media Types
Command Reference
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
Rel VC4.1 v. 03
Vyatta
768
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf cost <cost>
100+ Mbps
The values in Table 15-7 show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
769
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf dead-interval <interval>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf dead-interval interval
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf dead-interval
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
770
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf dead-interval <interval>
num
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which a PVC with Point-to-Point Protocol
over Ethernet (PPPoE) encapsulation on an ADSL interface should expect a hello packet
from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
771
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf hello-interval <interval>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf hello-interval interval
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf hello-interval
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
772
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf hello-interval <interval>
num
interval
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a PVC with
Point-to-Point Protocol over Ethernet (PPPoE) encapsulation on an ADSL interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
773
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf mtu-ignore
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf mtu-ignore
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
mtu-ignore
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
774
num
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
775
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf network <type>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf network [broadcast |
non-broadcast | point-to-multipoint | point-to-point]
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf network
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
network: text
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
776
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf network <type>
num
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
777
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf priority <priority>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf priority priority
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf priority
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
priority: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
778
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf priority <priority>
num
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the priority for a PVC with Point-to-Point Protocol over Ethernet
(PPPoE) encapsulation on an ADSL interface on the broadcast network to which the
interface is connected. The priority determines which routers are selected as the areas
Designated Router (DR) and Backup Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
779
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf retransmit-interval <interval>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf retransmit-interval interval
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf retransmit-interval
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
780
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf retransmit-interval <interval>
num
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long a PVC with Point-to-Point Protocol over Ethernet
(PPPoE) encapsulation on an ADSL interface will wait for an acknowledgment of a
link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for a PVC with
PPPoE encapsulation on an ADSL interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
781
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf transmit-delay <delay>
Syntax
set interfaces adsl adslx pvc pvc-id pppoe num ip ospf transmit-delay delay
delete interfaces adsl adslx pvc pvc-id pppoe num ip ospf transmit-delay
show interfaces adsl adslx pvc pvc-id pppoe num ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
adsl adslx {
pvc [0-255/0-65535|auto] {
pppoe 0-15 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
}
Parameters
Command Reference
adslx
Mandatory. Multi-node. The identifier for the ADSL interface you are
defining. This may be adsl0 to adslx, depending on what physical ADSL
ports are actually available on the system.
pvc-id
Mandatory. The identifier for the PVC. It can either be the vpi/vci pair
or the keyword auto, where vpi is a Virtual Path Index from 0 to 255, vci
is a Virtual Circuit Index from from 0 to 65535, and auto directs the
system to detect the Virtual Path Index and Virtual Circuit Index
automatically.
Rel VC4.1 v. 03
Vyatta
782
interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf transmit-delay <delay>
num
delay
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for a PVC with Point-to-Point Protocol over
Ethernet (PPPoE) encapsulation on an ADSL interface. This is the estimated time required
to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
783
Syntax
set interfaces ethernet ethx ip ospf
delete interfaces ethernet ethx ip ospf
show interfaces ethernet ethx ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf
}
}
}
Parameters
ethx
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
784
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on an
Ethernet interface.
Use the set form of this command to enable OSPF on an interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on an interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
785
Syntax
set interfaces ethernet ethx ip ospf authentication [md5 key-id key-id md5-key md5-key
| plaintext-password password]
delete interfaces ethernet ethx ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
show interfaces ethernet ethx ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
786
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on an Ethernet
interface. This authentication is independent of the authentication configured for the OSPF
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for an Ethernet interface.
Use the delete form of this command to remove Ethernet interface authentication
configuration information.
Use the show form of this command to display Ethernet interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
787
Syntax
set interfaces ethernet ethx ip ospf bandwidth bandwidth
delete interfaces ethernet ethx ip ospf bandwidth
show interfaces ethernet ethx ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
bandwidth: u32
}
}
}
}
Parameters
ethx
bandwidth
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
788
Usage Guidelines
Use this command to specify the bandwidth of the Ethernet interface for the purpose of
computing OSPF cost.
Use the set form of this command to specify the bandwidth of the Ethernet interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
789
Syntax
set interfaces ethernet ethx ip ospf cost cost
delete interfaces ethernet ethx ip ospf cost
show interfaces ethernet ethx ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
cost: u32
}
}
}
}
Parameters
ethx
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Command Reference
Rel VC4.1 v. 03
Vyatta
790
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
an Ethernet interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-4 OSPF Costs for Common Media Types
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
The values in Table 15-7show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the Ethernet interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
791
Syntax
set interfaces ethernet ethx ip ospf dead-interval interval
delete interfaces ethernet ethx ip ospf dead-interval
show interfaces ethernet ethx ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
dead-interval: u32
}
}
}
}
Parameters
ethx
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval.
Command Reference
Rel VC4.1 v. 03
Vyatta
792
Usage Guidelines
Use this command to specify the interval during which an Ethernet interface should expect
a hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
793
Syntax
set interfaces ethernet ethx ip ospf hello-interval interval
delete interfaces ethernet ethx ip ospf hello-interval
show interfaces ethernet ethx ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
hello-interval: u32
}
}
}
}
Parameters
ethx
interval
Default
Hello packets are sent every 10 seconds.
Command Reference
Rel VC4.1 v. 03
Vyatta
794
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for an Ethernet
interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
795
Syntax
set interfaces ethernet ethx ip ospf mtu-ignore
delete interfaces ethernet ethx ip ospf mtu-ignore
show interfaces ethernet ethx ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
mtu-ignore
}
}
}
}
Parameters
ethx
Default
MTU mismatch detection is enabled by default.
Command Reference
Rel VC4.1 v. 03
Vyatta
796
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
797
Syntax
set interfaces ethernet ethx ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces ethernet ethx ip ospf network
show interfaces ethernet ethx ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
network: text
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
798
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
799
Syntax
set interfaces ethernet ethx ip ospf priority priority
delete interfaces ethernet ethx ip ospf priority
show interfaces ethernet ethx ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
priority: u32
}
}
}
}
Parameters
ethx
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
An OSPF interface has a priority of 1.
Command Reference
Rel VC4.1 v. 03
Vyatta
800
Usage Guidelines
Use this command to set the priority for an Ethernet interface on the broadcast network to
which the interface is connected. The priority determines which routers are selected as the
areas Designated Router (DR) and Backup Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
801
Syntax
set interfaces ethernet ethx ip ospf retransmit-interval interval
delete interfaces ethernet ethx ip ospf retransmit-interval
show interfaces ethernet ethx ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
Parameters
ethx
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
802
Usage Guidelines
Use this command to specify how long an Ethernet interface will wait for an
acknowledgment of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for an Ethernet
interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
803
Syntax
set interfaces ethernet ethx ip ospf transmit-delay delay
delete interfaces ethernet ethx ip ospf transmit-delay
show interfaces ethernet ethx ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
Parameters
ethx
delay
Default
Link-state transmits occur at 1-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
804
Usage Guidelines
Use this command to set the transmit delay for an Ethernet interface. This is the estimated
time required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
805
Syntax
set interfaces ethernet ethx pppoe num ip ospf
delete interfaces ethernet ethx pppoe num ip ospf
show interfaces ethernet ethx pppoe num ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf
}
}
}
}
Parameters
ethx
num
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
806
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
Point-to-Point over Ethernet (PPPoE) interface.
Use the set form of this command to enable OSPF on an interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on an interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
807
Syntax
set interfaces ethernet ethx pppoe num ip ospf authentication [md5 key-id key-id
md5-key md5-key | plaintext-password password]
delete interfaces ethernet ethx pppoe num ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
show interfaces ethernet ethx pppoe num ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
808
Parameters
ethx
num
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on a
Point-to-Point over Ethernet (PPPoE) interface. This authentication is independent of the
authentication configured for the OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Command Reference
Rel VC4.1 v. 03
Vyatta
809
Use the set form of this command to set the authentication for a PPPoE interface.
Use the delete form of this command to remove PPPoE interface authentication
configuration information.
Use the show form of this command to display PPPoE interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
810
Syntax
set interfaces ethernet ethx pppoe num ip ospf bandwidth bandwidth
delete interfaces ethernet ethx pppoe num ip ospf bandwidth
show interfaces ethernet ethx pppoe num ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
Parameters
ethx
Command Reference
num
bandwidth
Rel VC4.1 v. 03
Vyatta
811
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of the Point-to-Point over Ethernet (PPPoE)
interface for the purpose of computing OSPF cost.
Use the set form of this command to specify the bandwidth of the PPPoE interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
812
Syntax
set interfaces ethernet ethx pppoe num ip ospf cost cost
delete interfaces ethernet ethx pppoe num ip ospf cost
show interfaces ethernet ethx pppoe num ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
cost: u32
}
}
}
}
}
Parameters
ethx
Command Reference
num
cost
Rel VC4.1 v. 03
Vyatta
813
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
OSPF run on a Point-to-Point over Ethernet (PPPoE) interface. You can only assign one
cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-5 OSPF Costs for Common Media Types
Command Reference
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
Rel VC4.1 v. 03
Vyatta
814
The values in Table 15-7 show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the PPPoE interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
815
Syntax
set interfaces ethernet ethx pppoe num ip ospf dead-interval interval
delete interfaces ethernet ethx pppoe num ip ospf dead-interval
show interfaces ethernet ethx pppoe num ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
Parameters
ethx
Command Reference
num
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Rel VC4.1 v. 03
Vyatta
816
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which a Point-to-Point over Ethernet
(PPPoE) interface should expect an OSPF hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
817
Syntax
set interfaces ethernet ethx pppoe num ip ospf hello-interval interval
delete interfaces ethernet ethx pppoe num ip ospf hello-interval
show interfaces ethernet ethx pppoe num ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
Parameters
ethx
Command Reference
num
interval
Rel VC4.1 v. 03
Vyatta
818
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a
Point-to-Point over Ethernet (PPPoE) interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
819
Syntax
set interfaces ethernet ethx pppoe num ip ospf mtu-ignore
delete interfaces ethernet ethx pppoe num ip ospf mtu-ignore
show interfaces ethernet ethx pppoe num ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
mtu-ignore
}
}
}
}
}
Parameters
ethx
num
Command Reference
Rel VC4.1 v. 03
Vyatta
820
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an Point-to-Point over Ethernet
(PPPoE) OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
821
Syntax
set interfaces ethernet ethx pppoe num ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces ethernet ethx pppoe num ip ospf network
show interfaces ethernet ethx pppoe num ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
network: text
}
}
}
}
}
Parameters
ethx
num
Command Reference
Rel VC4.1 v. 03
Vyatta
822
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the OSPF network type for a Point-to-Point
over Ethernet (PPPoE) interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
823
Syntax
set interfaces ethernet ethx pppoe num ip ospf priority priority
delete interfaces ethernet ethx pppoe num ip ospf priority
show interfaces ethernet ethx pppoe num ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
priority: u32
}
}
}
}
}
Parameters
ethx
Command Reference
num
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Rel VC4.1 v. 03
Vyatta
824
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the OSPF priority for a Point-to-Point over Ethernet (PPPoE)
interface on the broadcast network to which the interface is connected. The priority
determines which routers are selected as the areas Designated Router (DR) and Backup
Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
825
Syntax
set interfaces ethernet ethx pppoe num ip ospf retransmit-interval interval
delete interfaces ethernet ethx pppoe num ip ospf retransmit-interval
show interfaces ethernet ethx pppoe num ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
Parameters
ethx
Command Reference
num
interval
Rel VC4.1 v. 03
Vyatta
826
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long a Point-to-Point over Ethernet (PPPoE) interface
will wait for an acknowledgment of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for a PPPoE interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
827
Syntax
set interfaces ethernet ethx pppoe num ip ospf transmit-delay delay
delete interfaces ethernet ethx pppoe num ip ospf transmit-delay
show interfaces ethernet ethx pppoe num ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
pppoe 0-15 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
Parameters
ethx
Command Reference
num
delay
Rel VC4.1 v. 03
Vyatta
828
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for a Point-to-Point over Ethernet (PPPoE)
interface. This is the estimated time required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
829
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf
delete interfaces ethernet ethx vif vlan-id ip ospf
show interfaces ethernet ethx vif vlan-id ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf
}
}
}
}
Parameters
ethx
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
Command Reference
Rel VC4.1 v. 03
Vyatta
830
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
virtual interface.
Use the set form of this command to enable OSPF on an interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on an interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
831
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf authentication [md5 key-id key-id
md5-key md5-key | plaintext-password password]
delete interfaces ethernet ethx vif vlan-id ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
show interfaces ethernet ethx vif vlan-id ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
832
Parameters
ethx
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on a virtual
interface. This authentication is independent of the authentication configured for the OSPF
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
Command Reference
Rel VC4.1 v. 03
Vyatta
833
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for a virtual interface.
Use the delete form of this command to remove virtual interface authentication
configuration information.
Use the show form of this command to display virtual interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
834
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf bandwidth bandwidth
delete interfaces ethernet ethx vif vlan-id ip ospf bandwidth
show interfaces ethernet ethx vif vlan-id ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
835
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
bandwidth
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of the virtual interface for the purpose of
computing OSPF cost.
Use the set form of this command to specify the bandwidth of the virtual interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
836
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf cost cost
delete interfaces ethernet ethx vif vlan-id ip ospf cost
show interfaces ethernet ethx vif vlan-id ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
cost: u32
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
837
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
a virtual interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-6 OSPF Costs for Common Media Types
Command Reference
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
Rel VC4.1 v. 03
Vyatta
838
10
T3 (44.736 Mbps
100+ Mbps
The values in Table 15-7 show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the virtual interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
839
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf dead-interval interval
delete interfaces ethernet ethx vif vlan-id ip ospf dead-interval
show interfaces ethernet ethx vif vlan-id ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
840
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which a virtual interface should expect a
hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
841
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf hello-interval interval
delete interfaces ethernet ethx vif vlan-id ip ospf hello-interval
show interfaces ethernet ethx vif vlan-id ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
842
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
interval
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a virtual
interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
843
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf mtu-ignore
delete interfaces ethernet ethx vif vlan-id ip ospf mtu-ignore
show interfaces ethernet ethx vif vlan-id ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
mtu-ignore
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
844
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
845
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces ethernet ethx vif vlan-id ip ospf network
show interfaces ethernet ethx vif vlan-id ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
network: text
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
846
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
847
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf priority priority
delete interfaces ethernet ethx vif vlan-id ip ospf priority
show interfaces ethernet ethx vif vlan-id ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
priority: u32
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
848
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the priority for a virtual interface on the broadcast network to
which the interface is connected. The priority determines which routers are selected as the
areas Designated Router (DR) and Backup Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
849
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf retransmit-interval interval
delete interfaces ethernet ethx vif vlan-id ip ospf retransmit-interval
show interfaces ethernet ethx vif vlan-id ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
850
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long a virtual interface will wait for an acknowledgment
of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for a virtual interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
851
Syntax
set interfaces ethernet ethx vif vlan-id ip ospf transmit-delay delay
delete interfaces ethernet ethx vif vlan-id ip ospf transmit-delay
show interfaces ethernet ethx vif vlan-id ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
Parameters
ethx
Command Reference
Rel VC4.1 v. 03
Vyatta
852
vlan-id
Mandatory. Multi-node. The VLAN ID for the vif, for use with 802.1q
VLAN tagging. Only tagged packets are received on vifs configured on
Ethernet interfaces.
The range is 0 to 4095.
You can define more than one vif for a single interface by creating
multiple vif configuration nodes.
delay
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for a virtual interface. This is the estimated time
required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
853
Syntax
set interfaces loopback lo ip ospf
delete interfaces loopback lo ip ospf
show interfaces loopback lo ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf
}
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on the
loopback interface.
Use the set form of this command to enable OSPF on the loopback interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on the loopback interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
854
Syntax
set interfaces loopback lo ip ospf authentication [md5 key-id key-id md5-key md5-key
| plaintext-password password]
delete interfaces loopback lo ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
show interfaces loopback lo ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
Parameters
key-id
Command Reference
The key used to identify the MD5 key. This must be the same on both
the sending and receiving systems. The range is 1 to 255.
Rel VC4.1 v. 03
Vyatta
855
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on the
loopback interface. This authentication is independent of the authentication configured for
the OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for the loopback interface.
Use the delete form of this command to remove loopback interface authentication
configuration information.
Use the show form of this command to display loopback interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
856
Syntax
set interfaces loopback lo ip ospf cost cost
delete interfaces loopback lo ip ospf cost
show interfaces loopback lo ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
cost: u32
}
}
}
}
Parameters
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
the loopback interface you are configuring. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
Command Reference
Rel VC4.1 v. 03
Vyatta
857
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-7 OSPF Costs for Common Media Types
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
The values in Table 15-7show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the loopback interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
858
Syntax
set interfaces loopback lo ip ospf dead-interval interval
delete interfaces loopback lo ip ospf dead-interval
show interfaces loopback lo ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
dead-interval: u32
}
}
}
}
Parameters
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which the loopback interface should
expect a hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
Command Reference
Rel VC4.1 v. 03
Vyatta
859
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
860
Syntax
set interfaces loopback lo ip ospf hello-interval interval
delete interfaces loopback lo ip ospf hello-interval
show interfaces loopback lo ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
hello-interval: u32
}
}
}
}
Parameters
interval
Default
Hello packets are sent every 10 seconds.
Command Reference
Rel VC4.1 v. 03
Vyatta
861
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for the loopback
interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
862
Syntax
set interfaces loopback lo ip ospf mtu-ignore
delete interfaces loopback lo ip ospf mtu-ignore
show interfaces loopback lo ip ospf mtu-ignore
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
mtu-ignore
}
}
}
}
Parameters
None.
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
863
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
864
Syntax
set interfaces loopback lo ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces loopback lo ip ospf network
show interfaces loopback lo ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
network: text
}
}
}
}
Parameters
type
Specifies the network type for this interface. The following values are
supported:
broadcast: This is an interface that supports broadcast mode (such as a
LAN link).
non-broadcast: This is an interface that does not support broadcast
mode.
point-to-multipoint: This is an interface that supports
point-to-multipoint mode (such as a PPP interface or a point-to-point
logical interface on Frame Relay).
point-to-point: This is an interface that supports point-to-point mode
(such as an NBMA interface).
The default is broadcast.
Command Reference
Rel VC4.1 v. 03
Vyatta
865
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
866
Syntax
set interfaces loopback lo ip ospf priority priority
delete interfaces loopback lo ip ospf priority
show interfaces loopback lo ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
priority: u32
}
}
}
}
Parameters
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
The loopback interface has an priority of 1.
Usage Guidelines
Use this command to set the priority for the loopback interface on the broadcast network to
which the interface is connected. The priority determines which routers are selected as the
areas Designated Router (DR) and Backup Designated Router (BDR).
Command Reference
Rel VC4.1 v. 03
Vyatta
867
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
868
Syntax
set interfaces loopback lo ip ospf retransmit-interval interval
delete interfaces loopback lo ip ospf retransmit-interval
show interfaces loopback lo ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
Parameters
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
869
Usage Guidelines
Use this command to specify how long an Ethernet interface will wait for an
acknowledgment of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for the loopback
interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
870
Syntax
set interfaces loopback lo ip ospf transmit-delay delay
delete interfaces loopback lo ip ospf transmit-delay
show interfaces loopback lo ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
loopback lo {
ip {
ospf {
transmit-delay: u32
}
}
}
}
Parameters
delay
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay on the loopback interface. This is the estimated
time required to send a link-state update (LSU) packet.
Command Reference
Rel VC4.1 v. 03
Vyatta
871
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
872
Syntax
set interfaces multilink mlx ip ospf
delete interfaces multilink mlx ip ospf
show interfaces multilink mlx ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
}
}
}
Parameters
mlx
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
multilink interface.
Use the set form of this command to enable OSPF on a multilink interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on a multilink interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
873
Command Reference
Rel VC4.1 v. 03
Vyatta
874
Syntax
set interfaces multilink mlx ip ospf authentication [md5 key-id key-id md5-key md5-key
| plaintext-password password]
delete interfaces multilink mlx ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
show interfaces multilink mlx ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
Parameters
mlx
Command Reference
Rel VC4.1 v. 03
Vyatta
875
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on a multilink
interface. This authentication is independent of the authentication configured for the OSPF
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for a multilink interface.
Use the delete form of this command to remove multilink interface authentication
configuration information.
Use the show form of this command to display multilink interface authentication
configuration information.
Command Reference
Rel VC4.1 v. 03
Vyatta
876
Syntax
set interfaces multilink mlx ip ospf bandwidth bandwidth
delete interfaces multilink mlx ip ospf bandwidth
show interfaces multilink mlx ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
bandwidth: u32
}
}
}
}
Parameters
mlx
bandwidth
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
877
Usage Guidelines
Use this command to specify the bandwidth of the multiulink interface for the purpose of
computing OSPF cost.
Use the set form of this command to specify the bandwidth of the multiulink interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
878
Syntax
set interfaces multilink mlx ip ospf cost cost
delete interfaces multilink mlx ip ospf cost
show interfaces multilink mlx ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
cost: u32
}
}
}
}
Parameters
mlx
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Command Reference
Rel VC4.1 v. 03
Vyatta
879
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
OSPF run on a multilink interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-8 shows the OSPF costs for some common media types.
Table 15-8 OSPF Costs for Common Media Types
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
The values in Table 15-7 show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the multilink interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
880
Syntax
set interfaces multilink mlx ip ospf dead-interval interval
delete interfaces multilink mlx ip ospf dead-interval
show interfaces multilink mlx ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
dead-interval: u32
}
}
}
}
Parameters
mlx
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval (40 seconds).
Command Reference
Rel VC4.1 v. 03
Vyatta
881
Usage Guidelines
Use this command to specify the interval during which a multilink interface should expect
an OSPF hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
882
Syntax
set interfaces multilink mlx ip ospf hello-interval interval
delete interfaces multilink mlx ip ospf hello-interval
show interfaces multilink mlx ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
hello-interval: u32
}
}
}
}
Parameters
mlx
interval
Default
Hello packets are sent every 10 seconds.
Command Reference
Rel VC4.1 v. 03
Vyatta
883
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a multilink
interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
884
Syntax
set interfaces multilink mlx ip ospf mtu-ignore
delete interfaces multilink mlx ip ospf mtu-ignore
show interfaces multilink mlx ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
mtu-ignore
}
}
}
}
Parameters
mlx
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on a multilink OSPF interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
885
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
886
Syntax
set interfaces multilink mlx ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces multilink mlx ip ospf network
show interfaces multilink mlx ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
network: text
}
}
}
}
Parameters
mlx
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
Command Reference
Rel VC4.1 v. 03
Vyatta
887
Default
The default is broadcast.
Usage Guidelines
Use this command to configure and display the OSPF network type for a multipoint
interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
888
Syntax
set interfaces multilink mlx ip ospf priority priority
delete interfaces multilink mlx ip ospf priority
show interfaces multilink mlx ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
priority: u32
}
}
}
}
Parameters
mlx
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
An OSPF interface has a priority of 1.
Command Reference
Rel VC4.1 v. 03
Vyatta
889
Usage Guidelines
Use this command to set the OSPF priority for a multilink interface on the broadcast
network to which the interface is connected. The priority determines which routers are
selected as the areas Designated Router (DR) and Backup Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
890
Syntax
set interfaces multilink mlx ip ospf retransmit-interval interval
delete interfaces multilink mlx ip ospf retransmit-interval
show interfaces multilink mlx ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
Parameters
mlx
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
891
Usage Guidelines
Use this command to specify how long a multilink interface will wait for an
acknowledgment of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for a multilink
interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
892
Syntax
set interfaces multilink mlx ip ospf transmit-delay delay
delete interfaces multilink mlx ip ospf transmit-delay
show interfaces multilink mlx ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
multilink ml0..ml23 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
Parameters
mlx
delay
Default
Link-state transmits occur at 1-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
893
Usage Guidelines
Use this command to set the transmit delay for a multilink interface. This is the estimated
time required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
894
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf
show interfaces serial wanx cisco-hdlc vif 1
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip ospf
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
OSPF is not enabled on Cisco HDLC interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
895
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on the
virtual interface of a Cisco HDLC serial interface.
Use the set form of this command to enable OSPF on a Cisco HDLC virtual interface.
Use the delete form of this command to disable OSPF on a Cisco HDLC virtual interface.
Use the show form of this command to display Cisco HDLC virtual interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
896
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf authentication [md5 key-id key-id
md5-key md5-key | plaintext-password password]
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
show interfaces serial wanx cisco-hdlc vif 1 ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
897
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on the virtual
interface of a Cisco HDLC serial interface. This authentication is independent of the
authentication configured for the OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for the virtual interface of a
Cisco HDLC serial interface.
Use the delete form of this command to remove interface authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
898
Use the show form of this command to display interface authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
899
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf bandwidth bandwidth
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf bandwidth
show interfaces serial wanx cisco-hdlc vif 1 ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
bandwidth
Rel VC4.1 v. 03
Vyatta
900
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of the virtual interface of a Cisco HDLC serial
interface for the purpose of computing OSPF cost.
Use the set form of this command to specify the bandwidth of the interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
901
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf cost cost
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf cost
show interfaces serial wanx cisco-hdlc vif 1 ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
cost: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
cost
Rel VC4.1 v. 03
Vyatta
902
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
the virtual interface of a Cisco HDLC serial interface. You can only assign one cost per
interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-9 OSPF Costs for Common Media Types
Command Reference
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
Rel VC4.1 v. 03
Vyatta
903
The values in Table 15-7show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
904
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf dead-interval interval
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf dead-interval
show interfaces serial wanx cisco-hdlc vif 1 ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Rel VC4.1 v. 03
Vyatta
905
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which the virtual interface of a Cisco
HDLC serial interface should expect a hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
906
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf hello-interval interval
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf hello-interval
show interfaces serial wanx cisco-hdlc vif 1 ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
907
interval
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for the virtual
interface of a Cisco HDLC serial interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
908
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf mtu-ignore
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf mtu-ignore
show interfaces serial wanx cisco-hdlc vif 1 ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
mtu-ignore
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
909
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
910
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf network
show interfaces serial wanx cisco-hdlc vif 1 ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
network: text
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
911
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
912
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf priority priority
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf priority
show interfaces serial wanx cisco-hdlc vif 1 ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
priority: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Rel VC4.1 v. 03
Vyatta
913
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the priority for the virtual interface of a Cisco HDLC serial
interface on the broadcast network to which the interface is connected. The priority
determines which routers are selected as the areas Designated Router (DR) and Backup
Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
914
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf retransmit-interval interval
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf retransmit-interval
show interfaces serial wanx cisco-hdlc vif 1 ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
interval
Rel VC4.1 v. 03
Vyatta
915
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long the virtual interface of a Cisco HDLC serial
interface will wait for an acknowledgment of a link-state update before resending the
update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for the virtual
interface of a Cisco HDLC serial interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
916
Syntax
set interfaces serial wanx cisco-hdlc vif 1 ip ospf transmit-delay delay
delete interfaces serial wanx cisco-hdlc vif 1 ip ospf transmit-delay
show interfaces serial wanx cisco-hdlc vif 1 ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
cisco-hdlc {
vif 1 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
917
delay
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for the virtual interface of a Cisco HDLC serial
interface. This is the estimated time required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
918
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf
delete interfaces serial wanx frame-relay vif dlci ip ospf
show interfaces serial wanx frame-relay vif dlci
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip ospf
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
Default
OSPF is not enabled on Frame Relay interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
919
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
virtual interface of a Frame Relay serial interface.
Use the set form of this command to enable OSPF on a Frame Relay virtual interface.
Use the delete form of this command to disable OSPF on a Frame Relay virtual interface.
Use the show form of this command to display Frame Relay virtual interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
920
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf authentication [md5 key-id key-id
md5-key md5-key | plaintext-password password]
delete interfaces serial wanx frame-relay vif dlci ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
show interfaces serial wanx frame-relay vif dlci ip ospf authentication [md5 key-id
key-id md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
921
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on the virtual
interface of a Frame Relay serial interface. This authentication is independent of the
authentication configured for the OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for the virtual interface of a
Cisco HDLC serial interface.
Use the delete form of this command to remove interface authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
922
Use the show form of this command to display interface authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
923
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf bandwidth bandwidth
delete interfaces serial wanx frame-relay vif dlci ip ospf bandwidth
show interfaces serial wanx frame-relay vif dlci ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
bandwidth
Rel VC4.1 v. 03
Vyatta
924
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of the virtual interface of a Frame Relay serial
interface for the purpose of computing OSPF cost.
Use the set form of this command to specify the bandwidth of the interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
925
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf cost cost
delete interfaces serial wanx frame-relay vif dlci ip ospf cost
show interfaces serial wanx frame-relay vif dlci ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
cost: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
cost
Rel VC4.1 v. 03
Vyatta
926
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
the virtual interface of a Frame Relay serial interface. You can only assign one cost per
interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-10 OSPF Costs for Common Media Types
Command Reference
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
Rel VC4.1 v. 03
Vyatta
927
The values in Table 15-7show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
928
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf dead-interval interval
delete interfaces serial wanx frame-relay vif dlci ip ospf dead-interval
show interfaces serial wanx frame-relay vif dlci ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Rel VC4.1 v. 03
Vyatta
929
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which the virtual interface of a Frame
Relay serial interface should expect a hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
930
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf hello-interval interval
delete interfaces serial wanx frame-relay vif dlci ip ospf hello-interval
show interfaces serial wanx frame-relay vif dlci ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
Rel VC4.1 v. 03
Vyatta
931
interval
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for the virtual
interface of a Frame Relay serial interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
932
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf mtu-ignore
delete interfaces serial wanx frame-relay vif dlci ip ospf mtu-ignore
show interfaces serial wanx frame-relay vif dlci ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
mtu-ignore
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
Rel VC4.1 v. 03
Vyatta
933
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
934
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf network [broadcast |
non-broadcast | point-to-multipoint | point-to-point]
delete interfaces serial wanx frame-relay vif dlci ip ospf network
show interfaces serial wanx frame-relay vif dlci ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
network: text
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
Rel VC4.1 v. 03
Vyatta
935
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
936
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf priority priority
delete interfaces serial wanx frame-relay vif dlci ip ospf priority
show interfaces serial wanx frame-relay vif dlci ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
priority: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Rel VC4.1 v. 03
Vyatta
937
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the priority for the virtual interface of a Frame Relay serial
interface on the broadcast network to which the interface is connected. The priority
determines which routers are selected as the areas Designated Router (DR) and Backup
Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
938
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf retransmit-interval interval
delete interfaces serial wanx frame-relay vif dlci ip ospf retransmit-interval
show interfaces serial wanx frame-relay vif dlci ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
interval
Rel VC4.1 v. 03
Vyatta
939
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long the virtual interface of a Frame Relay serial
interface will wait for an acknowledgment of a link-state update before resending the
update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for the virtual
interface of a Frame Relay serial interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
940
Syntax
set interfaces serial wanx frame-relay vif dlci ip ospf transmit-delay delay
delete interfaces serial wanx frame-relay vif dlci ip ospf transmit-delay
show interfaces serial wanx frame-relay vif dlci ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
frame-relay {
vif 16-991 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
dlci
The identifier of the virtual interface. For Frame Relay interfaces, this is
the DLCI number for the interface. The range is 16 to 991.
delay
Rel VC4.1 v. 03
Vyatta
941
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for the virtual interface of a Frame Relay serial
interface. This is the estimated time required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
942
Syntax
set interfaces serial wanx ppp vif 1 ip ospf
delete interfaces serial wanx ppp vif 1 ip ospf
show interfaces serial wanx ppp vif 1
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip ospf
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
OSPF is not enabled on PPP interfaces.
Command Reference
Rel VC4.1 v. 03
Vyatta
943
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on the
virtual interface of a Point-to-Point Protocol (PPP) serial interface.
Use the set form of this command to enable OSPF on a PPP virtual interface.
Use the delete form of this command to disable OSPF on a PPP virtual interface.
Use the show form of this command to display PPP virtual interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
944
Syntax
set interfaces serial wanx ppp vif 1 ip ospf authentication [md5 key-id key-id md5-key
md5-key | plaintext-password password]
delete interfaces serial wanx ppp vif 1 ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
show interfaces serial wanx ppp vif 1 ip ospf authentication [md5 key-id key-id
md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
945
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on the virtual
interface of a PPP serial interface. This authentication is independent of the authentication
configured for the OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for the virtual interface of a PPP
serial interface.
Use the delete form of this command to remove interface authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
946
Use the show form of this command to display interface authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
947
Syntax
set interfaces serial wanx ppp vif 1 ip ospf bandwidth bandwidth
delete interfaces serial wanx ppp vif 1 ip ospf bandwidth
show interfaces serial wanx ppp vif 1 ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
bandwidth: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
bandwidth
Rel VC4.1 v. 03
Vyatta
948
Default
None.
Usage Guidelines
Use this command to specify the bandwidth of the virtual interface of a PPP serial interface
for the purpose of computing OSPF cost.
Use the set form of this command to specify the bandwidth of the interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
949
Syntax
set interfaces serial wanx ppp vif 1 ip ospf cost cost
delete interfaces serial wanx ppp vif 1 ip ospf cost
show interfaces serial wanx ppp vif 1 ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
cost: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
cost
Rel VC4.1 v. 03
Vyatta
950
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
the virtual interface of a PPP serial interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-11 OSPF Costs for Common Media Types
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
The values in Table 15-7show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Command Reference
Rel VC4.1 v. 03
Vyatta
951
Use the set form of this command to specify the OSPF cost for the interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
952
Syntax
set interfaces serial wanx ppp vif 1 ip ospf dead-interval interval
delete interfaces serial wanx ppp vif 1 ip ospf dead-interval
show interfaces serial wanx ppp vif 1 ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
dead-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Rel VC4.1 v. 03
Vyatta
953
Default
The dead interval is 4 times the hello interval.
Usage Guidelines
Use this command to specify the interval during which the virtual interface of a PPP serial
interface should expect a hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
954
Syntax
set interfaces serial wanx ppp vif 1 ip ospf hello-interval interval
delete interfaces serial wanx ppp vif 1 ip ospf hello-interval
show interfaces serial wanx ppp vif 1 ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
hello-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
955
interval
Default
Hello packets are sent every 10 seconds.
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for the virtual
interface of a PPP serial interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
956
Syntax
set interfaces serial wanx ppp vif 1 ip ospf mtu-ignore
delete interfaces serial wanx ppp vif 1 ip ospf mtu-ignore
show interfaces serial wanx ppp vif 1 ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
mtu-ignore
}
}
}
}
}
}
Parameters
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Default
MTU mismatch detection is enabled by default.
Command Reference
Rel VC4.1 v. 03
Vyatta
957
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
MTU mismatch is an important troubleshooting feature. If MTU mismatch is not enabled,
MTU mismatches can only be detected by examining configuration for both interfaces.
There are some network setups where MTU mismatches are unavoidable, and even part of
the normal set-up. It is for these cases only that MTU mismatch detection should be
disabled, so that normal OSPF adjacencies can be formed.
Use the set form of this command to disable MTU mismatch detection.
Use the delete form of this command to re-enable MTU mismatch detection.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
958
Syntax
set interfaces serial wanx ppp vif 1 ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces serial wanx ppp vif 1 ip ospf network
show interfaces serial wanx ppp vif 1 ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
network: text
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
Rel VC4.1 v. 03
Vyatta
959
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
960
Syntax
set interfaces serial wanx ppp vif 1 ip ospf priority priority
delete interfaces serial wanx ppp vif 1 ip ospf priority
show interfaces serial wanx ppp vif 1 ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
priority: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Rel VC4.1 v. 03
Vyatta
961
Default
An OSPF interface has a priority of 1.
Usage Guidelines
Use this command to set the priority for the virtual interface of a PPP serial interface on the
broadcast network to which the interface is connected. The priority determines which
routers are selected as the areas Designated Router (DR) and Backup Designated Router
(BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
962
Syntax
set interfaces serial wanx ppp vif 1 ip ospf retransmit-interval interval
delete interfaces serial wanx ppp vif 1 ip ospf retransmit-interval
show interfaces serial wanx ppp vif 1 ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
interval
Rel VC4.1 v. 03
Vyatta
963
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Usage Guidelines
Use this command to specify how long the virtual interface of a PPP serial interface will
wait for an acknowledgment of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for the virtual
interface of a PPP serial interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
964
Syntax
set interfaces serial wanx ppp vif 1 ip ospf transmit-delay delay
delete interfaces serial wanx ppp vif 1 ip ospf transmit-delay
show interfaces serial wanx ppp vif 1 ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
serial wan0..wan23 {
ppp {
vif 1 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
}
}
Parameters
Command Reference
wanx
Mandatory. Multi-node. The identifier for the serial interface you are
defining. This may be wan0 to wan23, depending on what serial
interfaces that are actually available on the system.
delay
Rel VC4.1 v. 03
Vyatta
965
Default
Link-state transmits occur at 1-second intervals.
Usage Guidelines
Use this command to set the transmit delay for the virtual interface of a PPP serial interface.
This is the estimated time required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
966
Syntax
set interfaces tunnel tunx ip ospf
delete interfaces tunnel tunx ip ospf
show interfaces tunnel tunx ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on a
tunnel interface.
Use the set form of this command to enable OSPF on an interface.
Use the delete form of this command to remove all OSPF configuration and disable OSPF
on an interface.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
967
Syntax
set interfaces tunnel tunx ip ospf authentication [md5 key-id key-id md5-key md5-key
| plaintext-password password]
delete interfaces tunnel tunx ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
show interfaces tunnel tunx ip ospf authentication [md5 key-id key-id md5-key |
plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
Parameters
Command Reference
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
key-id
Optional. The key used to identify the MD5 key. This must be the same
on both the sending and receiving systems. The range is 1 to 255.
Rel VC4.1 v. 03
Vyatta
968
md5-key
password
Default
None.
Usage Guidelines
Use this command to specify the authentication method to be used for OSPF on a tunnel
interface. This authentication is independent of the authentication configured for the OSPF
area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
The authentication parameters must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not consider establish adjacencies, and will disregard one anothers communications.
Use the set form of this command to set the authentication for a tunnel interface.
Use the delete form of this command to remove interface authentication configuration
information.
Use the show form of this command to display interface authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
969
Syntax
set interfaces tunnel tunx ip ospf bandwidth bandwidth
delete interfaces tunnel tunx ip ospf bandwidth
show interfaces tunnel tunx ip ospf bandwidth
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
bandwidth: u32
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
bandwidth
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
970
Usage Guidelines
Use this command to specify the bandwidth of the tunnel interface for the purpose of
computing OSPF cost.
Use the set form of this command to specify the bandwidth of the interface.
Use the delete form of this command to remove the bandwidth parameter.
Use the show form of this command to display the bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
971
Syntax
set interfaces tunnel tunx ip ospf cost cost
delete interfaces tunnel tunx ip ospf cost
show interfaces tunnel tunx ip ospf cost
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
cost: u32
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
cost
Default
For details on the default of OSPF cost, please see the Usage Guidelines.
Command Reference
Rel VC4.1 v. 03
Vyatta
972
Usage Guidelines
Use this command to manually override the default OSPF cost computed by the system for
a tunnel interface. You can only assign one cost per interface.
By default, the metric associated with a link is computed as follows:
Cost = 108 / bandwidth
The cost of reaching any destination is the sum of the costs of the individual hops. Costs
are always rounded to the nearest integer. Costs lower than 1 are rounded up to 1.
Table 15-7 shows the OSPF costs for some common media types.
Table 15-12 OSPF Costs for Common Media Types
Media Type
OSPF Cost
56 Kbps
1785
64 Kbps
1562
128 Kbps
781
256 Kbps
390
512 Kbps
195
768 Kbps
130
T1 (1.544 Mbps)
64
E1 (2.048 Mbps)
48
10 Mbps Ethernet
10
T3 (44.736 Mbps
100+ Mbps
The values in Table 15-7show how OSPF fails to distinguish between interfaces faster than
100 Mbps, for example, between Fast Ethernet (100 Mbps) and Gigabit Ethernet (1000
Mbps) interfaces. If you want to distinguish interfaces equal to or greater than 100 Mbps,
you must manually configure the cost of the interface using this command.
Use the set form of this command to specify the OSPF cost for the interface.
Use the delete form of this command to restore the default cost.
Use the show form of this command to display cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
973
Syntax
set interfaces tunnel tunx ip ospf dead-interval interval
delete interfaces tunnel tunx ip ospf dead-interval
show interfaces tunnel tunx ip ospf dead-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
dead-interval: u32
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
interval
Specifies the time, in seconds, that this interface should wait to detect
hello packets from neighboring routers before declaring the neighbor
down. The range is 1 to 65535. The default is 4 times the hello interval.
Default
The dead interval is 4 times the hello interval.
Command Reference
Rel VC4.1 v. 03
Vyatta
974
Usage Guidelines
Use this command to specify the interval during which a tunnel interface should expect a
hello packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
975
Syntax
set interfaces tunnel tunx ip ospf hello-interval interval
delete interfaces tunnel tunx ip ospf hello-interval
show interfaces tunnel tunx ip ospf hello-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
hello-interval: u32
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
interval
Default
Hello packets are sent every 10 seconds.
Command Reference
Rel VC4.1 v. 03
Vyatta
976
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a tunnel
interface.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
977
Syntax
set interfaces tunnel tunx ip ospf mtu-ignore
delete interfaces tunnel tunx ip ospf mtu-ignore
show interfaces tunnel tunx ip ospf
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
mtu-ignore
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
Default
MTU mismatch detection is enabled by default.
Usage Guidelines
Use this command to disable MTU mismatch detection on an OSPF interface.
OSPF sends the MTU of the interface in a database description packet. If the MTUs of
OSPF neighbors do not match, they cannot form an OSPF adjacency. MTU mismatch
detection detects MTU mismatches and indicates them in the form of a debug message.
Command Reference
Rel VC4.1 v. 03
Vyatta
978
Command Reference
Rel VC4.1 v. 03
Vyatta
979
Syntax
set interfaces tunnel tunx ip ospf network [broadcast | non-broadcast |
point-to-multipoint | point-to-point]
delete interfaces tunnel tunx ip ospf network
show interfaces tunnel tunx ip ospf network
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
network: text
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
type
The network type for this interface. Supported values are as follows:
broadcast: The interface supports broadcast mode, such as a LAN link.
non-broadcast: The interface does not support broadcast mode.
point-to-point: This interface supports point-to-point mode, such as an
NBMA interface.
point-to-multipoint: This interface supports point-to-multipoint mode,
such as a PPP interface or a point-to-point logical interface on Frame
Relay.
The default is broadcast.
Command Reference
Rel VC4.1 v. 03
Vyatta
980
Default
Broadcast is supported.
Usage Guidelines
Use this command to configure and display the network type for the interface.
Use the set form of this command to specify the network type.
Use the delete form of this command to remove the network type.
Use the show form of this command to display the network type.
Command Reference
Rel VC4.1 v. 03
Vyatta
981
Syntax
set interfaces tunnel tunx ip ospf priority priority
delete interfaces tunnel tunx ip ospf priority
show interfaces tunnel tunx ip ospf priority
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
priority: u32
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
priority
Specifies the OSPF router priority for this interface. The range is 0 to
255, where a router with priority 0 can never become the designated
router. The default is 1.
Default
An OSPF interface has a priority of 1.
Command Reference
Rel VC4.1 v. 03
Vyatta
982
Usage Guidelines
Use this command to set the priority for a tunnel interface on the broadcast network to
which the interface is connected. The priority determines which routers are selected as the
areas Designated Router (DR) and Backup Designated Router (BDR).
The DR and BDR are used to reduce the amount of traffic on OSPF overhead on broadcast
networks, by reducing the number of adjacent routers to which a router must flood its
topological information. In broadcast networks (such as Ethernet), each router establishes
an adjacency with only the DR and the BDR, rather than with every router in its area. The
DR and the BDR then flood this information to all other routers on the network segment.
Priority can range from 0 to 255. In general, the router with the highest priority is elected
as the DR, and the router with the second-highest priority is elected as the BDR. The higher
the number, the higher the priority.
Routers with a priority of 0 are ineligible for election.
Use the set form of this command to specify the OSPF priority.
Use the delete form of this command to restore the default priority.
Use the show form of this command to display priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
983
Syntax
set interfaces tunnel tunx ip ospf retransmit-interval interval
delete interfaces tunnel tunx ip ospf retransmit-interval
show interfaces tunnel tunx ip ospf retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
retransmit-interval: u32
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
984
Usage Guidelines
Use this command to specify how long a tunnel interface will wait for an acknowledgment
of a link-state update before resending the update.
The link-state update packet is part of the exchange of topology databases between routers.
When the initial database description (DD) packet is sent, it contains only the headers of
the LSAs. If the receiving router determines that it requires that piece of the OSPF
topology, it sends a link state request packet to request the complete LSA from the sending
router.
After the update packet is sent, the sending router waits for an acknowledgement, either
implicit or explicit, from the receiving router. In an explicit acknowledgement, the
receiving router sends a link-state acknowledge (LS-Ack) packet to the router that sent the
update. In an implicit acknowledgement, the router that sent the update receives an LSA
from the receiving router that contains the update information.
If the retransmit interval passes with neither an explicit nor an implicit acknowledgement,
the sending router will retransmit the link-state update packet.
Too high an interval slows network convergence. Too small an interval causes unnecessary
retransmission.
Use the set form of this command to set the OSPF retransmit interval for a tunnel interface.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
985
Syntax
set interfaces tunnel tunx ip ospf transmit-delay delay
delete interfaces tunnel tunx ip ospf transmit-delay
show interfaces tunnel tunx ip ospf transmit-delay
Command Mode
Configuration mode.
Configuration Statement
interfaces {
tunnel tun0..tun9 {
ip {
ospf {
transmit-delay: u32
}
}
}
}
Parameters
tunx
Mandatory. The name of the tunnel interface you are configuring. The
range is tun0 to tun9.
delay
Default
Link-state transmits occur at 1-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
986
Usage Guidelines
Use this command to set the transmit delay for a tunnel interface. This is the estimated time
required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
987
protocols ospf
protocols ospf
Enables the Open Shortest Path First (OSPF) routing protocol on the router.
Syntax
set protocols ospf
delete protocols ospf
show protocols ospf
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf
}
Parameters
None
Default
None.
Usage Guidelines
Use this command to enable the Open Shortest Path First (OSPF) routing protocol on the
system.
Use the set form of this command to enable the OSPF routing protocol.
Use the delete form of this command to disable OSPF and remove all OSPF configuration.
Use the show form of this command to display OSPF configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
988
Syntax
set protocols ospf access-list list-num [export type]
delete protocols ospf access-list list-num [export type]
show protocols ospf access-list list-num
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
access-list u32 {
export text
}
}
}
Parameters
list-num
type
Default
None.
Usage Guidelines
Use this command to specify an access list to filter networks in routing updates.
Use the set form of this command to specify an access list.
Use the delete form of this command to remove an access list.
Command Reference
Rel VC4.1 v. 03
Vyatta
989
Command Reference
Rel VC4.1 v. 03
Vyatta
990
Syntax
set protocols ospf area area-id
delete protocols ospf area area-id
show protocols ospf area area-id
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text
}
}
Parameters
area-id
Default
None.
Usage Guidelines
Use this command to define an area within an OSPF Autonomous System (AS)
Use the set form of this command to create an OSPF area or define its characteristics.
Use the delete form of this command to remove an OSPF area.
Use the show form of this command to display OSPF area configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
991
Syntax
set protocols ospf area area-id area-type normal
delete protocols ospf area area-id area-type
show protocols ospf area area-id area-type
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
area-type {
normal
}
}
}
Parameters
area-id
Default
None.
Usage Guidelines
Use this command to designate an OSPF area as a normal area.
A normal area is an area that is neither a stub area nor a not-so-stubby area. All external
routes are advertised into normal areas.
Use the set form of this command to set the OSPF area type as normal.
Use the delete form of this command to remove area type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
992
Use the show form of this command to display an area type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
993
Syntax
set protocols ospf area area-id area-type nssa [default-cost cost | no-summary |
translate {always | candidate | never}]
delete protocols ospf area area-id area-type nssa [default-cost | no-summary |
translate]
show protocols ospf area area-id area-type nssa [default-cost | translate]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
area-type {
nssa {
default-cost: 0-16777215
no-summary
translate {
always
candidate
never
}
}
}
}
}
}
Parameters
Command Reference
area-id
cost
Rel VC4.1 v. 03
Vyatta
994
no-summary
translate
Optional. Directs the NSSA ABR when to translate Type 7 LSAs into
Type 5 AS-external LSAs.
always
candidate
Translates only Type 7 LSAs from the candidate NSSA border router.
never
Default
By default, summary routes are generated into the area, and only Type 7 LSAs from the
candidate NSSA Border router are translated.
Usage Guidelines
Use this command to designate this OSPF area as a not-so-stubby area.
Type 5 AS-external LSAs are not allowed in stubby areas, but Type 7 LSAs may be
translated into Type 5 LSAs by the NSSA Area Border Router (ABR) and may traverse the
NSSA in this manner. Inter-area routes are not allowed.
Use the set form of this command to set the OSPF area type to not-so-stubby.
Use the delete form of this command to remove area type configuration.
Use the show form of this command to display an area type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
995
Syntax
set protocols ospf area area-id area-type stub [default-cost cost | no-summary]
delete protocols ospf area area-id area-type stub [default-cost | no-summary]
show protocols ospf area area-id area-type stub [default-cost]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
area-type {
stub {
default-cost: 0-16777215
no-summary
}
}
}
}
}
Parameters
area-id
cost
no-summary
Default
By default, summary routes are generated into the area.
Command Reference
Rel VC4.1 v. 03
Vyatta
996
Usage Guidelines
Use this command to designate this OSPF area as a stub area. No Type 5 AS-external LSAs
are allowed into a stub area.
Use the set form of this command to set the OSPF area type to stub.
Use the delete form of this command to remove area type configuration.
Use the show form of this command to display an area type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
997
Syntax
set protocols ospf area area-id authentication type
delete protocols ospf area area-id authentication
show protocols ospf area area-id authentication
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
authentication txt
}
}
}
Parameters
area-id
type
Default
The default is plain-text authentication.
Command Reference
Rel VC4.1 v. 03
Vyatta
998
Usage Guidelines
Use this command to set the authentication type for an OSPF area.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
Use the set form of this command to set the the authentication type.
Use the delete form of this command to remove the authentication type.
Use the show form of this command to display the authentication type.
Command Reference
Rel VC4.1 v. 03
Vyatta
999
Syntax
set protocols ospf area area-id network ipv4net
delete protocols ospf area area-id network ipv4net
show protocols ospf area area-id network
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
network: ipv4net
}
}
}
Parameters
area-id
ipv4net
Default
None.
Usage Guidelines
Use this command to specify the network to be used for an OSPF area.
Use the set form of this command to specify the area network.
Use the delete form of this command to remove OSPF area network configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
100
Use the show form of this command to display OSPF area network configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
100
Syntax
set protocols ospf area area-id range ipv4net [cost cost | not-advertise | substitute
ipv4net]
delete protocols ospf area area-id range [ipv4net [cost | not-advertise | substitute]]
show protocols ospf area area-id range [ipv4net [cost | substitute]]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
area-type {
range {
cost: 0-16777215
not-advertise
substitute: ipv4net
}
}
}
}
}
Parameters
Command Reference
area-id
ipv4net
cost
not-advertise
Rel VC4.1 v. 03
Vyatta
100
substitute
ipv4net
Default
By default, routes are advertised and routes are not substituted.
Usage Guidelines
Use this command to direct the router to summarize routes matching a prefix range. This
command may only be used with an Area Border Router (ABR).
Use the set form of this command to set the area range.
Use the delete form of this command to remove area range configuration.
Use the show form of this command to display area range configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
100
Syntax
set protocols ospf area area-id shortcut [default | disable | enable]
delete protocols ospf area area-id shortcut
show protocols ospf area area-id shortcut
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
shortcut text
}
}
}
Parameters
area-id
Command Reference
Rel VC4.1 v. 03
Vyatta
100
mode
Default
The shortcut mode is default.
Usage Guidelines
Use this command to set the shortcut mode for an OSPF Area Border Router, (ABR)
according to the standard described in draft-ietf-ospf-shortcut-abr-02.txt. This command
may only be used with an ABR.
Use the set form of this command to set the ABR shortcut mode.
Use the delete form of this command to remove ABR shortcut configuration.
Use the show form of this command to display ABR shortcut configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
100
Syntax
set protocols ospf area area-id virtual-link ipv4 authentication [md5 key-id key-id
md5-key md5-key | plaintext-password password]
delete protocols ospf area area-id virtual-link ipv4 authentication [md5 key-id key-id
md5-key | plaintext-password]
show protocols ospf area area-id virtual-link ipv4 authentication [md5 key-id key-id
md5-key | plaintext-password]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
virtual-link ipv4 {
authentication {
md5 {
key-id 1-255 {
md5-key: text
}
}
plaintext-password: text
}
}
}
}
}
Parameters
area-id
Command Reference
Rel VC4.1 v. 03
Vyatta
100
ipv4
key-id
Optional. The authentication key id. This must be the same on both the
sending and receiving systems. The range is 1 to 255.
md5-key
password
Default
None.
Usage Guidelines
Use this command to set the authentication for a virtual link.
In plain text authentication, passwords are sent through the network in plain text. In MD5
authentication, the system uses the Message Digest 5 (MD5) algorithm to compute a hash
value from the contents of the OSPF packet and the password. The hash value and the MD5
key are included in the transmitted packet, and the receiving system (configured with the
same password) calculates its own hash function, which must match.
Use the set form of this command to specify the authentication.
Use the delete form of this command to remove virtual link authentication configuration
information.
Use the show form of this command to display virtual link authentication configuration
information.
Command Reference
Rel VC4.1 v. 03
Vyatta
100
Syntax
set protocols ospf area area-id virtual-link ipv4 dead-interval interval
delete protocols ospf area area-id virtual-link ipv4 dead-interval
show protocols ospf area area-id virtual-link ipv4 dead-interval
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
virtual-link ipv4 {
dead-interval: 1-65535
}
}
}
}
Parameters
area-id
ipv4
interval
Specifies the time, in seconds, that the virtual link should wait to
detect hello packets from neighboring routers before declaring the
neighbor down. The range is 1 to 65535. The default is 4 times the
hello interval.
Default
The dead interval is 4 times the hello interval.
Command Reference
Rel VC4.1 v. 03
Vyatta
100
Usage Guidelines
Use this command to specify the interval during which a virtual link should expect a hello
packet from its neighbor.
If the dead interval passes without the interface receiving a hello packet from the neighbor,
the neighbors status is changed to out-of-service, and all associated state is cleared.
The dead interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to specify the dead interval.
Use the delete form of this command to restore the default dead interval.
Use the show form of this command to display dead interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
100
Syntax
set protocols ospf area area-id virtual-link ipv4 hello-interval interval
delete protocols ospf area area-id virtual-link ipv4 hello-interval
show protocols ospf area area-id virtual-link ipv4 hello-interval
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
virtual-link ipv4 {
hello-interval: 1-65535
}
}
}
}
Parameters
area-id
ipv4
interval
Default
Hello packets are sent every 10 seconds.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Usage Guidelines
Use this command to set the interval at which OSPF hello packets are sent for a virtual link.
A hello packet is an OSPF packet used to detect and maintain relationships with neighbors
on the same network (directly connected routers). The greater the interval between hello
packets, the less router traffic occurs, but the longer it takes for topological changes to be
detected.
The hello interval must be the same for all routers that are to establish two-way
communication within a network. If two routers do not agree on these parameters, they will
not establish adjacencies and will disregard one anothers communications.
Use the set form of this command to set the hello interval.
Use the delete form of this command to restore the default hello interval.
Use the show form of this command to display hello interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Syntax
set protocols ospf area area-id virtual-link ipv4 retransmit-interval interval
delete protocols ospf area area-id virtual-link ipv4 retransmit-interval
show protocols ospf area area-id virtual-link ipv4 retransmit-interval
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
virtual-link ipv4 {
retransmit-interval: 1-65535
}
}
}
}
Parameters
area-id
ipv4
interval
Default
Unacknowledged LSAs are retransmitted at 5-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Usage Guidelines
Use this command to set the retransmit interval for a virtual link. This is the number of
seconds before retransmitting an unacknowledged link-state advertisement.
When an OSPF router sends a link-state advertisement (LSA) to a neighbor, the neighbor
acknowledges receipt with a link-state acknowledgement (LS Ack) packet. If the local
router fails to receive the expected LS Ack packet, it retransmits the LSA at the interval
specified by this command. This value must be the same for all nodes on the network.
Use the set form of this command to set the default retransmit interval.
Use the delete form of this command to restore the default retransmit interval.
Use the show form of this command to display retransmit interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Syntax
set protocols ospf area area-id virtual-link ipv4 transmit-delay delay
delete protocols ospf area area-id virtual-link ipv4 transmit-delay
show protocols ospf area area-id virtual-link ipv4 transmit-delay
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
area text {
virtual-link ipv4 {
transmit-delay: 1-65535
}
}
}
}
Parameters
area-id
ipv4
delay
Default
Link-state transmits occur at 1-second intervals.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Usage Guidelines
Use this command to set the transmit delay for a virtual link. This is the estimated time
required to send a link-state update (LSU) packet.
This timer is used to accommodate transmission and propagation delays on the network,
particularly on low-speed networks where delays may be significant. The router increments
the age of link-state advertisements in LSU packets to account for these delays.
The value includes both the transmission time and the propagation delay across the
network. The transmit delay is added to the age of the LSA packet before the LSA is
transmitted The LSA age is used to help the network sequence LSAs, so that it can
determine which of competing LSAs is the more recent and trustworthy.
LSAs are numbered in sequence, but the sequence numbers are finite, and so cannot be used
as the sole determinant of the most recent LSA. Instead, OSPF also tracks the age of LSAs.
Each time the LSA is forwarded to another router, its current age is incremented by the
transmit delay. The packets age, together with its sequence number, helps the receiving
router to determine which version of a received LSA is more recent, and therefore to be
used.
Use the set form of this command to set the transmit delay.
Use the delete form of this command to restore the default transmit delay.
Use the show form of this command to display transmit delay configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Syntax
set protocols ospf auto-cost reference-bandwidth bandwidth
delete protocols ospf auto-cost reference-bandwidth
show protocols ospf auto-cost reference-bandwidth
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
auto-cost {
reference-bandwidth: 1-4294967
}
}
}
Parameters
bandwidth
Default
The default reference bandwidth is 108.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Usage Guidelines
Use this command to set a reference bandwidth for calculating OSPF cost. The OSPF
metric is calculated as the reference bandwidth divided by actual bandwidth.
An explicitly set cost for an area overrides automatically calculated values.
Use the set form of this command to set the reference bandwidth.
Use the delete form of this command to restore the default reference bandwidth.
Use the show form of this command to display OSPF auto-cost configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Syntax
set protocols ospf default-information originate [always | metric metric | metric-type
type | route-map map-name]
delete protocols ospf default-information originate [always | metric | metric-type |
route-map]
show protocols ospf default-information originate [always | metric | metric-type |
route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
default-information {
originate {
always
metric: 0-16777214
metric-type: 1-2
route-map: text
}
}
}
}
Parameters
Command Reference
always
metric metric
Rel VC4.1 v. 03
Vyatta
101
metric-type type Optional. The external route metric type to be associated with the Type
5 default link-state advertisement (LSA). Supported values are as
follows:
1: Type 1 external route.
2: Type 2 external route
The default is 2.
map-name
Default
By default, the system does not generate an external default route into the OSPF routing
domain. When enabled to do so, the defaults depend on the type of area into which the
default route is being advertised:
In stub areas, a Type 3 link-state advertisement is generated with a metric of 1 and the
metric type is ignored.
Usage Guidelines
Use this command to redistribute the default route (0.0.0.0) into an OSPF routing domain.
If you redistribute routes in this way, the router automatically becomes an Autonomous
System Boundary Router (ASBR). The router must have a default route configured before
it can generate one, unless the always keyword is specified.
Use the set form of this command to enable generation of external default route into the
OSPF routing domain.
Use the delete form of this command to disable generation of external default route into the
OSPF routing domain or to restore default parameter values.
Use the show form of this command to display default route distribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
101
Syntax
set protocols ospf default-metric metric
delete protocols ospf default-metric
show protocols ospf default-metric
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
default-metric: 0-16777214
}
}
Parameters
metric
Default
None.
Usage Guidelines
Use this command to set the default metric to be applied to routes from other protocols
being redistributed into OSPF.
Use the set form of this command to set the default OSPF metric.
Use the delete form of this command to restore the default value for default metric.
Use the show form of this command to display OSPF default metric configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Syntax
set protocols ospf distance {global global | ospf [external external | inter-area inter |
intra-area intra]}
delete protocols ospf distance [global | ospf [external | inter-area | intra-area]]
show protocols ospf distance [global | ospf [external | inter-area | intra-area]]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
distance {
global: 1-255
ospf {
external: 1-255
inter-area: 1-255
intra-area: 1-255
}
}
}
}
Parameters
Command Reference
global
Sets the administrative distance for all routes. The range is 1 to 255.
external
inter
intra
Rel VC4.1 v. 03
Vyatta
102
Default
The default administrative distance for OSPF routes is 110.
Usage Guidelines
Use this command to set the administrative distance for OSPF routes.
The administrative distance indicates the trustworthiness of a router or group of routers as
a source of routing information. In general, the higher the value, the less trusted the entity.
An administrative distance of 1 usually represents a directly connected network, and and
an administrative distance of 255 the routing source is unreliable or unknown. The
administrative distance conventionally applied to OSPF is 110.
Use the set form of this command to set the administrative distance.
Use the delete form of this command to restore the default value for administrative
distance.
Use the show form of this command to display administrative distance configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Syntax
set protocols ospf log-adjacency-changes [detail]
delete protocols ospf log-adjacency-changes
show protocols ospf log-adjacency-changes
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
log-adjacency-changes {
detail
}
}
}
Parameters
detail
Optional. Logs all state changes, not just changes in adjacency state.
Default
Logging of adjacency changes is disabled. When used without the detail option, only
adjacency state changes are logged.
Usage Guidelines
Use this command to enable logging of adjacency state changes.
Use the set form of this command to enable adjacency state change logging.
Use the delete form of this command to disable adjacency state change logging.
Use the show form of this command to display adjacency state change logging
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Syntax
set protocols ospf max-metric router-lsa [administrative | on-shutdown shutdown |
on-startup startup]
delete protocols ospf max-metric router-lsa [administrative | on-shutdown |
on-startup]
show protocols ospf max-metric router-lsa [on-shutdown | on-startup]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
max-metric {
router-lsa {
administrative
on-shutdown: 5-86400
on-startup: 5-86400
}
}
}
}
Parameters
administrative
on-shutdown shutdown Advertise the maximum metric when the OSPF process is shut
down. The shutdown argument specifies the interval, in
seconds, after which advertisement of maximum metric should
be stopped and the normal OSPF metric even if BGP
convergence has not completed. The range is 5 to 86400. The
default is 600.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
on-startup startup
Default
None.
Usage Guidelines
Use this command to set the Router-LSA advertising metric.
Using this command allows an OSPF router to advertise a maximum metric to other routers
as described in RFC 3137. Advertising a maximum metric effectively makes the router the
least-preferred router in the network for forwarding other traffic to another network. During
the interval when the router is least-preferred, the BGP routing tables can converge and the
router can be gracefully brought into service or taken out of service without interfering with
traffic.
The period of maximum metric advertisement comes to an end if either the BGP tables
complete convergence or the timers expire. At this point, the maximum advertised metric
is replaced with the normal OSPF metric.
Use the the set form of this command to enable maximum metric advertising.
Use the delete form of this command to disable maximum metric advertising.
Use the show form of this command to display maximum metric advertising configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Syntax
set protocols ospf mpls-te [enable | router-address ipv4]
delete protocols ospf mpls-te [enable | router-address]
show protocols ospf mpls-te [router-address]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
mpls-te {
enable
router-address: ipv4
}
}
}
Parameters
enable
ipv4
Default
None.
Usage Guidelines
Use this command to enable Multiprotocol Label Switching traffic engineering
(MPLS-TE).
Use the set form of this command to enable MPLS-TE.
Use the delete form of this command to remove MPLS-TE configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Syntax
set protocols ospf neighbor ipv4 [poll-interval interval | priority priority]
delete protocols ospf neighbor ipv4 [poll-interval | priority]
show protocols ospf neighbor ipv4 [poll-interval | priority]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
neighbor ipv4 {
poll-interval: 1-65535
priority: 0-255
}
}
}
Parameters
ipv4
interval
priority
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Usage Guidelines
Use this command to define an OSPF neighbor and set its characteristics.
Use the set form of this command to create an OSPF neighbor or modify its characteristics.
Use the delete form of this command to remove an OSPF neighbor or reset neighbor
parameters to default values.
Use the show form of this command to display OSPF neighbor configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
102
Syntax
set protocols ospf parameters [abr-type type | opaque-lsa | rfc1583-compatibility |
router-id ipv4]
delete protocols ospf parameters [abr-type | opaque-lsa | rfc1583-compatibility |
router-id]
show protocols ospf parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
parameters {
abr-type: [cisco|ibm|shortcut|standard]
opaque-lsa
rfc1583-compatibility
router-id: ipv4
}
}
}
Parameters
type
opaque-lsa
Command Reference
Rel VC4.1 v. 03
Vyatta
103
rfc1583-compatibility
ipv4
Default
By default, support for opaque LSAs is disabled. By default, RFC 1583 support is disabled.
If no router ID is explicitly configured, the OSPF process calculates an ID for the router
using the following algorithm:
1
Usage Guidelines
Use this command to set OSPF-specific parameters.
NOTE
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Syntax
set protocols ospf passive-interface ethx
delete protocols ospf passive-interface ethx
show protocols ospf passive-interface
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
passive-interface eth0..eth23 {}
}
}
Parameters
eth0..eth23
Default
Routing updates are not suppressed.
Usage Guidelines
Use this command to specify suppression for OSPF routing updates on an interface.
Use the set form of this command to suppress routing updates for an interface.
Use the delete form of this command to remove routing update suppression.
Use the show form of this command to display a routing update suppression configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Syntax
set protocols ospf redistribute bgp [metric metric | route-map map-name]
delete protocols ospf redistribute bgp [metric | route-map]
show protocols ospf redistribute bgp [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
redistribute {
bgp {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric metric
route-map map-name
Default
BGP routes being redistributed into OSPF are assigned a routing metric of 1. By default,
no route map is applied to redistributed BGP routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Usage Guidelines
Use this command to define the routing cost (metric) for BGP routes being redistributed
into OSPF.
Use the set form of this command to set BGP route redistribution parameters.
Use the delete form of this command to remove BGP route redistribution parameters.
Use the show form of this command to display BGP route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Syntax
set protocols ospf redistribute connected [metric metric | route-map map-name]
delete protocols ospf redistribute connected [metric | route-map]
show protocols ospf redistribute connected [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
redistribute {
connected {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric metric
route-map map-name
Default
Connected routes being redistributed into OSPF are assigned a routing metric of 1. By
default, no route map is applied to redistributed connected routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Usage Guidelines
Use this command to specify the routing cost (metric) for directly connected routes being
redistributed into OSPF.
Use the set form of this command to set the routing metric for redistributed connected
routes.
Use the delete form of this command to remove connected route redistribution parameters.
Use the show form of this command to display connected route redistribution
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Syntax
set protocols ospf redistribute kernel [metric metric | route-map map-name]
delete protocols ospf redistribute kernel [metric | route-map]
show protocols ospf redistribute kernel [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
redistribute {
kernel {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric metric
route-map map-name
Default
Kernel routes being redistributed into OSPF are assigned a routing metric of 1. By default,
no route map is applied to redistributed kernel routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Usage Guidelines
Use this command to specify the routing cost (metric) for kernel routes being redistributed
into OSPF.
Use the set form of this command to set the routing metric for redistributed kernel routes.
Use the delete form of this command to remove kernel route redistribution parameters.
Use the show form of this command to display kernel route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Syntax
set protocols ospf redistribute rip [metric metric | route-map map-name]
delete protocols ospf redistribute rip [metric | route-map]
show protocols ospf redistribute rip [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
redistribute {
rip {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric metric
route-map map-name
Default
RIP routes being redistributed into OSPF are assigned a routing metric of 1. By default, no
route map is applied to redistributed RIP routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
103
Usage Guidelines
Use this command to specify the routing cost (metric) for RIP routes being redistributed
into OSPF.
Use the set form of this command to set the routing metric for redistributed RIP routes.
Use the delete form of this command to remove RIP route redistribution parameters.
Use the show form of this command to display RIP route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Syntax
set protocols ospf redistribute static [metric metric | route-map map-name]
delete protocols ospf redistribute static [metric | route-map]
show protocols ospf redistribute static [metric | route-map]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
redistribute {
static {
metric: 1-16
route-map: text
}
}
}
}
Parameters
metric metric
route-map map-name
Default
Static routes being redistributed into OSPF are assigned a routing metric of 1. By default,
no route map is applied to redistributed static routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Usage Guidelines
Use this command to specify the routing cost (metric) for static routes being redistributed
into OSPF.
Use the set form of this command to set the routing metric for redistributed static routes.
Use the delete form of this command to remove static route redistribution parameters.
Use the show form of this command to display static route redistribution configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Syntax
set protocols ospf refresh timers value
delete protocols ospf refresh timers
show protocols ospf refresh timers
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
refresh {
timers: 10-1800
}
}
}
Parameters
value
Default
By default, the refresh timer expires every 30 minutes (1800 seconds).
Usage Guidelines
Use this command to specify the values for the OSPF link-state refresh timer.
A link-state refresh is a mechanism for validating a link-state advertisement (LSA) and
resetting its age before it reaches the maximum age. When the link-state refresh timer
expires, the router floods a new link-state update to all its neighbors who reset the age of
the LSA.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Use the set form of this command to set the refresh timer value.
Use the delete form of this command to restore the default refresh timer value.
Use the show form of this command to display refresh timer configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Syntax
set protocols ospf timers throttle spf [delay delay | initial-holdtime initial |
max-holdtime max]
delete protocols ospf timers throttle spf [delay | initial-holdtime | max-holdtime]
show protocols ospf timers throttle spf [delay | initial-holdtime | max-holdtime]
Command Mode
Configuration mode.
Configuration Statement
protocols {
ospf {
timers {
throttle {
spf {
delay: 0-600000
initial-holdtime: 0-600000
max-holdtime: 0-600000
}
}
}
}
}
Parameters
Command Reference
delay
initial
max
Rel VC4.1 v. 03
Vyatta
104
Default
SPF throttling is disabled.
Usage Guidelines
Use this command to set the timer characteristics of SPF throttling.
Shortest Path First (SPF) calculations, which calculate the Shortest Path Tree (SPT), are
generally performed whenever there is a change of network topology. In an unstable
network this can cause excessive path calculation. SPF throttling allows you delay SPF
calculation. You can delay the first calculation and set a minimum and maximum interval
between calculations.
Use the set form of this command to enable SPF throttling and set its characteristics.
Use the delete form of this command to disable SPF throttling.
Use the show form of this command to display SPF throttling configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Syntax
show debugging ospf
Command Mode
Operational mode.
Parameters
None
Default
None.
Usage Guidelines
Use this command to see how debugging is set for OSPF.
Command Reference
Rel VC4.1 v. 03
Vyatta
104
show ip ospf
show ip ospf
Displays high-level OSPF configuration information.
Syntax
show ip ospf
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display high-level OSPF information.
Examples
Example 15-7 shows OSPF information.
Example 15-1 show ip ospf: Displaying OSPF configuration information
Command Reference
Rel VC4.1 v. 03
Vyatta
104
show ip ospf
Command Reference
Rel VC4.1 v. 03
Vyatta
104
Syntax
show ip ospf border-routers
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display OSPF border router information.
Examples
Example 15-2 shows OSPF border router information.
Example 15-2 show ip ospf border-router: Displaying OSPF border router information
Command Reference
Rel VC4.1 v. 03
Vyatta
105
Syntax
show ip ospf database [max-age | self-originate | {asbr-summary | external | network |
nssa-external | opaque-area | opaque-as | opaque-link | router | summary} [adv-router
<ipv4> |<ipv4> [adv-router <ipv4> | self-originate]]]
Command Mode
Operational mode.
Parameters
Command Reference
max-age
self-originate
asbr-summary
external
network
nssa-external
opaque-area
opaque-as
opaque-link
router
summary
adv-router ipv4
ipv4
self-originate
Rel VC4.1 v. 03
Vyatta
105
Default
None.
Usage Guidelines
Use this command to display OSPF database information.
Examples
Example 15-3 shows general OSPF database information.
Example 15-3 show ip ospf database: Displaying general OSPF database information
ADV Router
10.1.0.33
10.1.0.58
10.100.10.1
Age Seq#
CkSum Link count
123 0x800003e5 0x791f 1
123 0x80000562 0x4e7e 1
117 0x800001b6 0xfe13 1
ADV Router
10.1.0.58
Age Seq#
CkSum
123 0x800003df 0x0bf3
Age Seq#
CkSum Route
1850 0x800000b3 0x83e4 E2
vyatta@vyatta:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
105
Syntax
show ip ospf interface [interface]
Command Mode
Operational mode.
Parameters
interface
Default
If no interfaces are specified then information on all interfaces will be displayed.
Usage Guidelines
Use this command to display OSPF configuration information for an interface.
Examples
Example 15-4 shows OSPF information on all interfaces.
Example 15-4 show ip ospf interface: Displaying OSPF configuration and status
information
vyatta@vyatta:~$ show
eth0 is down
ifindex 3, MTU 1500
OSPF not enabled on
eth1 is down
ifindex 4, MTU 1500
OSPF not enabled on
eth1_rename is down
ifindex 0, MTU 1500
OSPF not enabled on
eth2 is up
Command Reference
ip ospf interface
bytes, BW 0 Kbit <UP,BROADCAST,MULTICAST>
this interface
bytes, BW 0 Kbit <UP,BROADCAST,MULTICAST>
this interface
bytes, BW 0 Kbit <BROADCAST,MULTICAST>
this interface
Rel VC4.1 v. 03
Vyatta
105
Command Reference
Rel VC4.1 v. 03
Vyatta
105
Syntax
show ip ospf neighbor [interface | ipv4 | detail | address ipv4]
Command Mode
Operational mode.
Parameters
interface
ipv4
detail
address ipv4
Default
If no interfaces are specified then information on all neighbors will be displayed.
Usage Guidelines
Use this command to display OSPF neighbor information for a specified address or
interface.
Examples
Example 15-5 shows OSPF neighbor information for all neighbors.
Example 15-5 show ip ospf neighbor: Displaying OSPF neighbor information
Command Reference
Rel VC4.1 v. 03
Vyatta
105
10.1.0.58
eth2:10.1.0.62
vyatta@vyatta:~$
Command Reference
1 Full/DR
0
Rel VC4.1 v. 03
38.581s 10.1.0.58
0
Vyatta
105
Syntax
show ip ospf route
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display OSPF route information.
Examples
Example 15-6 shows OSPF route information.
Example 15-6 show ip ospf route: Displaying OSPF route information
Command Reference
Rel VC4.1 v. 03
Vyatta
105
Command Reference
Rel VC4.1 v. 03
Vyatta
105
Syntax
show ip route ospf
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display all the IP OSPF routes.
Examples
Example 15-7 shows all IP OSPF routes.
Example 15-7 show ip route ospf: Displaying routes
Command Reference
Rel VC4.1 v. 03
Vyatta
105
1060
This chapter lists the commands for setting up the Border Gateway Protocol on the
Vyatta system.
This chapter contains the following commands.
Command
Mode
Description
Configuration
Configuration
Configuration
Configuration
Configuration
106
Command
Mode
Description
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Command Reference
Configuration
Rel VC4.1 v. 03
Vyatta
Command
106
Mode
Description
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Command Reference
Rel VC4.1 v. 03
Vyatta
Command
106
Mode
Description
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Command Reference
Rel VC4.1 v. 03
Vyatta
106
Command
Mode
Description
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Configuration
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Command Reference
Rel VC4.1 v. 03
Vyatta
Command
106
Mode
Description
Resets IPv4 unicast BGP connections for a view
in a BGP route server.
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
show ip bgp
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Command Reference
Rel VC4.1 v. 03
Vyatta
106
Command
Mode
Description
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Command Reference
Rel VC4.1 v. 03
Vyatta
Command
106
Mode
Description
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Operational
Command Reference
Rel VC4.1 v. 03
Vyatta
106
Command
Mode
Description
Operational
Operational
Operational
Operational
Command Reference
Operational
Rel VC4.1 v. 03
Vyatta
Syntax
clear ip bgp {ipv4|ipv6} [in [prefix-filter] | out | rsclient | soft [in | out]]
Command Mode
Operational mode.
Parameters
ipv4
Resets the connection for the IPv4 BGP peer at the specified address.
ipv6
Resets the connection for the IPv6 BGP peer at the specified address.
in
out
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). This keyword is
ignored unless ORF capabilities have been enabled on the local system
or received from the sending BGP peer. In this case, a normal inbound
soft reset is performed.
rsclient
soft
in
out
Default
Both inbound and outbound sessions are reset.
Usage Guidelines
Use this command to reset a BGP connection.
Command Reference
Rel VC4.1 v. 03
Vyatta
106
Syntax
clear ip bgp {ipv4 | ipv6} ipv4 unicast [in [prefix-filter] | out | soft [in | out]]
Command Mode
Operational mode.
Parameters
ipv4
Resets the connection for the IPv4 BGP peer at the specified address.
ipv6
Resets the connection for the IPv6 BGP peer at the specified address.
in
out
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). The prefix-filter
keyword is ignored unless ORF capabilities have been enabled on the
local system or received from the sending BGP peer. In this case, a
normal inbound soft reset is performed.
soft
in
out
Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.
.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
Usage Guidelines
Use this command to reset an inbound BGP IPv4 unicast session for a given IP address.This
forces BGP updates to be generated and new BGP policies to be applied.
Unless the soft option is used, all connections are dropped (a hard reset): TCP
connections are terminated and all routes received from the neighbor are removed from the
BGP routing table. Then the connection with the neighbor is reestablished.
If the soft option is used, routes from the neighbor are marked as stale but are not
immediately removed from the BGP table. Stale routes that are not received from the
neighbor when the connection is reestablished are removed from the BGP table at that
point.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
Syntax
clear ip bgp dampening [ipv4 [ipv4-mask] | ipv4net]
Command Mode
Operational mode.
Parameters
ipv4
Optional. Clears route dampening information for the IPv4 peer at the
specified address.
ipv4-mask
ipv4net
Default
When used with no option, this command clears route dampening information and
unsuppresses routes for all BGP peers.
Usage Guidelines
Use this command on a router running BGP to clear information related to route dampening
and unsupress routes that are currently suppressed.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
Syntax
clear ip bgp external [in [prefix-filter] | out | soft [in | out]]
Command Mode
Operational mode.
Parameters
in
out
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). The prefix-filter
keyword is ignored unless ORF capabilities have been enabled on the
local system or received from the sending BGP peer. In this case, a
normal inbound soft reset is performed.
soft
in
out
Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.
Usage Guidelines
Use this command on a router running BGP to reset sessions for external BGP (eBGP)
neighbors. This forces BGP updates to be generated and new BGP policies to be applied.
Unless the soft option is used, all connections are dropped (a hard reset): TCP
connections are terminated and all routes received from the neighbor are removed from the
BGP routing table. Then the connection with the neighbor is reestablished.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
If the soft option is used, routes from the neighbor are marked as stale but are not
immediately removed from the BGP table. Stale routes that are not received from the
neighbor when the connection is reestablished are removed from the BGP table at that
point.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
Syntax
clear ip bgp external ipv4 unicast [in [prefix-filter] | out | soft [in | out]
Command Mode
Operational mode.
Parameters
in
out
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). The prefix-filter
keyword is ignored unless ORF capabilities have been enabled on the
local system or received from the sending BGP peer. In this case, a
normal inbound soft reset is performed.
soft
in
out
Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.
Usage Guidelines
Use this command to reset inbound IPv4 unicast peering sessions for eBGP neighbors. This
forces BGP updates to be generated and new BGP policies to be applied.
Unless the soft option is used, all connections are dropped (a hard reset): TCP
connections are terminated and all routes received from the neighbor are removed from the
BGP routing table. Then the connection with the neighbor is reestablished.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
If the soft option is used, routes from the neighbor are marked as stale but are not
immediately removed from the BGP table. Stale routes that are not received from the
neighbor when the connection is reestablished are removed from the BGP table at that
point.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
Syntax
clear ip bgp peer-group group-name [in [prefix-filter] | out | soft [in | out]]
Command Mode
Operational mode.
Parameters
group-name
in
out
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). This keyword is
ignored unless ORF capabilities have been enabled on the local system
or received from the sending BGP peer. In this case, a normal inbound
soft reset is performed.
soft
in
out
Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.
Usage Guidelines
Use this command to reset sessions for all members of a peer group. This forces BGP
updates to be generated and new BGP policies to be applied.
Unless the soft option is used, all connections are dropped (a hard reset): TCP
connections are terminated and all routes received from the neighbor are removed from the
BGP routing table. Then the connection with the neighbor is reestablished.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
If the soft option is used, routes from the neighbor are marked as stale but are not
immediately removed from the BGP table. Stale routes that are not received from the
neighbor when the connection is reestablished are removed from the BGP table at that
point.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
Syntax
clear ip bgp peer-group group-name ipv4 unicast [in [prefix-filter] | out | soft [in | out]]
Command Mode
Operational mode.
Parameters
group-name
in
out
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). This keyword is
ignored unless ORF capabilities have been enabled on the local system
or received from the sending BGP peer. In this case, a normal inbound
soft reset is performed.
soft
in
out
Default
None.
Usage Guidelines
Use this command to reset inbound unicast sessions for all members of a peer group. This
forces BGP updates to be generated and new BGP policies to be applied.
Unless the soft option is used, all connections are dropped (a hard reset): TCP
connections are terminated and all routes received from the neighbor are removed from the
BGP routing table. Then the connection with the neighbor is reestablished.
Command Reference
Rel VC4.1 v. 03
Vyatta
107
If the soft option is used, routes from the neighbor are marked as stale but are not
immediately removed from the BGP table. Stale routes that are not received from the
neighbor when the connection is reestablished are removed from the BGP table at that
point.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Syntax
clear ip bgp view view-name {ipv4 | ipv6} [in [prefix-filter] | soft [in | out] | rsclient]
Command Mode
Operational mode.
Parameters
view-name
ipv4
Resets the connection for the IPv4 BGP peer at the specified address.
ipv6
Resets the connection for the IPv6 BGP peer at the specified address.
in
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). This keyword is
ignored unless ORF capabilities have been enabled on the local system
or received from the sending BGP peer. In this case, a normal inbound
soft reset is performed.
soft
in
out
rsclient
Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Usage Guidelines
Use this command to clear BGP connection statistics for a view. This forces BGP updates
to be generated and new BGP policies to be applied.
Using a BGP route server is a way of solving the scalability problem that results from the
requirement that iBGP peers be fully meshed. When a route server is employed, BGP
routers peer only to the route server, and the route server servers BGP information to other
BGP routers. This greatly reduces the number of BGP connections required.
Unlike a normal BGP router, a BGP router server must have several routing tables for
managing the various routing policies of each BGP speakers: each of these routing tables
is called a view.
Unless the soft option is used, all connections are dropped (a hard reset): TCP
connections are terminated and all routes received from the neighbor are removed from the
BGP routing table. Then the connection with the neighbor is reestablished.
If the soft option is used, routes from the neighbor are marked as stale but are not
immediately removed from the BGP table. Stale routes that are not received from the
neighbor when the connection is reestablished are removed from the BGP table at that
point.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Syntax
clear ip bgp view view-name {ipv4 | ipv6} ipv4 unicast [in [prefix-filter] | soft [in | out]]
Command Mode
Operational mode.
Parameters
view-name
Mandatory. The name of a view (routing table) in a BGP route server for
which connection statistics are to be cleared.
ipv4
Resets the connection for the IPv4 BGP peer at the specified address.
ipv6
Resets the connection for the IPv6 BGP peer at the specified address.
in
prefix-filter
Optional. Clears the BGP outbound route filter (ORF). This keyword is
ignored unless ORF capabilities have been enabled on the local system
or received from the sending BGP peer. In this case, a normal inbound
soft reset is performed.
soft
in
out
rsclient
Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Usage Guidelines
Use this command on a router running BGP to reset BGP sessions for a view (routing table)
in a BGP route server. This forces BGP updates to be generated and new BGP policies to
be applied.
Using a BGP route server is a way of solving the scalability problem that results from the
requirement that iBGP peers be fully meshed. When a route server is employed, BGP
routers peer only to the route server, and the route server servers BGP information to other
BGP routers. This greatly reduces the number of BGP connections required.
Unlike a normal BGP router, a BGP router server must have several routing tables for
managing the various routing policies of each BGP speakers: each of these routing tables
is called a view.
Unless the soft option is used, all connections are dropped (a hard reset): TCP
connections are terminated and all routes received from the neighbor are removed from the
BGP routing table. Then the connection with the neighbor is reestablished.
If the soft option is used, routes from the neighbor are marked as stale but are not
immediately removed from the BGP table. Stale routes that are not received from the
neighbor when the connection is reestablished are removed from the BGP table at that
point.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
debug bgp
debug bgp
Enables or disables debug message generation related to the acquisition of the BGP router
ID and the sending and receiving of BGP messages.
Syntax
debug bgp
no debug bgp
undebug bgp
Command Mode
Operational mode.
Parameters
None.
Default
None
Usage Guidelines
Use this command to enable generation of trace-level messages related to the acquisition
of the BGP router ID and the sending and receiving of BGP messages.
Use the no or undebug forms of this command to disable debugging related to the
acquisition of the BGP router ID and the sending and receiving of BGP messages.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Syntax
debug bgp events
no debug bgp events
undebug bgp events
Command Mode
Operational mode.
Parameters
None.
Default
None
Usage Guidelines
Use this command to enable generation of trace-level messages related to BGP events.
Use the no or undebug forms of this command to disable debugging of BGP events.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Syntax
debug bgp filters
no debug bgp filters
undebug bgp filters
Command Mode
Operational mode.
Parameters
None.
Default
None
Usage Guidelines
Use this command to enable generation of trace-level messages related to the operation of
BGP routing filters.
Use the no or undebug forms of this command to disable debugging of BGP filters.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Syntax
debug bgp fsm
no debug bgp fsm
undebug bgp fsm
Command Mode
Operational mode.
Parameters
None.
Default
None
Usage Guidelines
Use this command to enable generation of trace-level messages related to the BGP finite
state machine (FSM).
A BGP router uses an FSM consisting of six states, as defined by RFC 1771. The FSM
describes how and when the BGP router should make decisions about its operations with
other BGP neighbors.
Use the no or undebug forms of this command to disable debugging of the BGP FSM.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Syntax
debug bgp keepalives
no debug bgp keepalives
undebug bgp keepalives
Command Mode
Operational mode.
Parameters
None.
Default
None
Usage Guidelines
Use this command to enable generation of trace-level messages related to sending and
receiving BGP keep-alive messages.
Use the no or undebug forms of this command to disable debugging of BGP keep-alive
messages.
Command Reference
Rel VC4.1 v. 03
Vyatta
108
Syntax
debug bgp updates [in | out]
no debug bgp updates
undebug bgp updates
Command Mode
Operational mode.
Parameters
in
out
Default
Debug messages are generated for both inbound and outbound routing messages.
Usage Guidelines
Use this command to enable generation of trace-level messages related to BGP routing
updates.
Use the no or undebug forms of this command to disable debugging or BGP routing
updates.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Syntax
debug bgp zebra
no debug bgp zebra
undebug bgp zebra
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enable generation of trace-level messages related to configuration of
the Zebra BGP daemon.
Use the no or undebug forms of this command to disable debugging of the Zebra BGP
daemon.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Syntax
no debug all bgp
undebug all bgp
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to disable all BGP debug message generation.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Syntax
set protocols bgp asn
delete protocols bgp asn
show protocols bgp [asn]
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. Any
peers of this router must be configured to know this AS numberif
there is a mismatch, a peering will not be established.
The range of values is 1 to 65535. The subrange 64512 to 65535 is
reserved for private autonomous systems.
Default
None.
Usage Guidelines
Use the set form of this command to enable a BGP instance on the router, and set its
Autonomous System. All subsequent BGP configuration falls under this configuration
node.
Note that you cannot create another BGP instance (that is, you cannot specify a second or
further AS) unless you declare multiple BGP instances using the multiple-instance
command.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Use the delete form of this command to disable BGP on the router, removing all BGP
configuration.
Use the show form of this command to view all BGP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Syntax
set protocols bgp asn aggregate-address ipv4net [as-set | summary-only]
delete protocols bgp asn aggregate-address ipv4net
show protocols bgp asn aggregate-address [ipv4net]
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
aggregate-address ipv4net {
as-set
summary-only
}
}
}
Parameters
asn
ipv4net
as-set
Specifies that the routes resulting from aggregation include the AS set.
summary-only Specifies that aggregated routes are summarized. These routes will not
be announced.
Usage Guidelines
Use the set form of this command to specify a contiguous block of IP addresses to
aggregate.
Use the delete form of this command to delete an aggregate address.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Use the show form of this command to view aggregate address configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Syntax
set protocols bgp asn neighbor id
delete protocols bgp asn neighbor id
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
None.
Usage Guidelines
Use the set form of this command to define a BGP neighbor.
Use the delete form of this command to remove a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Syntax
set protocols bgp asn neighbor id advertisement-interval seconds
delete protocols bgp asn neighbor id advertisement-interval
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
advertisement-interval: u32
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
seconds
Default
The default advertisement interval is 30 seconds for eBGP peers and 5 seconds for iBGP
peers.
Command Reference
Rel VC4.1 v. 03
Vyatta
109
Usage Guidelines
Use the set form of this command to set the minimum interval between BGP routing
advertisements to a BGP neighbor.
Use the delete form of this command to restore the advertisement interval to the default.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Syntax
set protocols bgp asn neighbor id allowas-in [number num]
delete protocols bgp asn neighbor id allowas-in
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
allowas-in {
number u32
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
number num
Default
Readvertisement is disabled.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Usage Guidelines
Use the set form of this command to allow the router to accept BGP AS paths advertising
the routers own AS number.
This situation could indicate a routing loop, and by default such an update is dropped.
However, you can use this command to direct the router to accept updates readvertising its
AS number for a specified number of times.
Use the delete form of this command to disallow readvertisement of the routers AS path.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Syntax
set protocols bgp asn neighbor id attribute-unchanged [as-path | med | next-hop]
delete protocols bgp asn neighbor id [as-path | med | next-hop]
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
attribute-unchanged {
as-path
med
next-hop
}
}
}
}
Parameters
Command Reference
asn
id
as-path
med
Rel VC4.1 v. 03
Vyatta
110
next-hop
Default
Disabled.
Usage Guidelines
Use the set form of this command to direct the router to propagate routing updates without
modifying the BGP AS_PATH, Multi Exit Discriminator (MED), or next-hop attribute.
Use the delete form of this command to restore normal modification of BGP attributes.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Syntax
set protocols bgp asn neighbor id capability dynamic
delete protocols bgp asn neighbor id capability dynamic
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
capability {
dynamic
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
By default, the session is brought up with minimal capability on both sides.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Usage Guidelines
In general, BGP-4 requires that if a BGP speaker receives an OPEN message with an
unrecognized optional parameters, the speaker must terminate BGP peering. This makes it
difficult to introduce new capabilities into the protocol. The Capabilities parameter allows
graceful negotiation of BGP capabilities without requiring a peer to terminate peering.
This command specifies use of the BGP Dynamic Capability feature, which allows
dynamic update of capabilities over an established BGP session.
Use the set form of this command to specify dynamic update of BGP capabilities to be used
in capability negotiation.
Use the delete form of this command to remove the dynamic update capability.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Syntax
set protocols bgp asn neighbor id capability orf [prefix-list [receive | send]]
delete protocols bgp asn neighbor id capability orf
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
capability {
orf {
prefix-list {
receive
send
}
}
}
}
}
}
Parameters
Command Reference
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
prefix-list
receive
Optional. Advertise the ability to receive the ORF from this neighbor.
Rel VC4.1 v. 03
Vyatta
110
send
Default
By default, the session is brought up with minimal capability on both sides.
Usage Guidelines
In general, BGP-4 requires that if a BGP speaker receives an OPEN message with an
unrecognized optional parameters, the speaker must terminate BGP peering. This makes it
difficult to introduce new capabilities into the protocol. The Capabilities parameter allows
graceful negotiation of BGP capabilities without requiring a peer to terminate peering.
This command specifies use of BGP Outbound Route Filtering (ORF) to send and receive
capabilities. Using ORF minimizes the number of BGP updates that are sent between peer
routers.
Use the set form of this command to specify BGP ORF capabilities to be used in capability
negotiation.
Use the delete form of this command to remove the ORF capability.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Syntax
set protocols bgp asn neighbor id default-originate [route-map map-name]
delete protocols bgp asn neighbor id default-originate [route-map map-name]
show protocols bgp asn neighbor id default-originate
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
default-originate {
route-map: text
}
}
}
}
Parameters
asn
id
route-map map-name
Default
The default route is not distributed.
Command Reference
Rel VC4.1 v. 03
Vyatta
110
Usage Guidelines
Use the set form of this command to enable the router to advertise the default route 0.0.0.0
to this BGP neighbor. This route can then be used by the neighbor to reach the local router
if no other routes are available.
The route 0.0.0.0 need not be explicitly configured on the local router.
If a route map is specified, the default route is advertised if two conditions are satisfied:
Route maps are configured using the protocols bgp <asn> neighbor <id> local-as
command (see page 1129).
Use the delete form of this command to disable forwarding of the default route or to delete
a route map.
Use the show form of this command to view BGP neighbor default route configuration
settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Syntax
set protocols bgp asn neighbor id description desc
delete protocols bgp asn neighbor id description
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
description: text
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Usage Guidelines
Use the set form of this command to enter a description for this BGP neighbor.
Use the delete form of this command to delete the neighbors description.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Syntax
set protocols bgp asn neighbor id disable-capability-negotiation
delete protocols bgp asn neighbor id disable-capability-negotiation
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
disable-capability-negotiation
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
Capability negotiation is performed.
Usage Guidelines
Use the set form of this command to disable BGP capability negotiation.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Use the delete form of this command to delete this attribute and restore BGP capability
negotiation.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Syntax
set protocols bgp asn neighbor id disable-connected-check
delete protocols bgp asn neighbor id disable-connected-check
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
disable-connected-check
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
Connection verification is performed.
Usage Guidelines
Use the set form of this command to disable connection verification.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Syntax
set protocols bgp asn neighbor id disable-send-community [extended | standard]
delete protocols bgp asn neighbor id disable-send-community
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
disable-send-community {
extended
standard
}
}
}
}
Parameters
Command Reference
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
extended
standard
Rel VC4.1 v. 03
Vyatta
111
Default
None.
Usage Guidelines
Use this command to enable and disable sending community attributes between BGP
neighbors.
Use the set form of this command to disable sending community attributes.
Use the delete form of this command to restore sending community attributes.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
111
Syntax
set protocols bgp asn neighbor id distribute-list import acl-num
delete protocols bgp asn neighbor id distribute-list
show protocols bgp asn neighbor id distribute-list
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
distribute-list {
import: 1-199
}
}
}
}
Parameters
Command Reference
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
acl-num
Rel VC4.1 v. 03
Vyatta
111
Default
None.
Usage Guidelines
Use the set form of this command to apply an access list to filter inbound routing updates
from a BGP neighbor.
Use the delete form of this command to disable inbound distribute list filtering.
Use the show form of this command to view BGP neighbor distribute list configuration
settings.
NOTE
A neighbor distribute list cannot be used together with a neighbor prefix list in
the same direction. These two lists are mutually exclusive, and only one list may be applied
to the specified direction.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Syntax
set protocols bgp asn neighbor id distribute-list export acl-num
delete protocols bgp asn neighbor id distribute-list
show protocols bgp asn neighbor id distribute-list
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
distribute-list {
export: 1-199
}
}
}
}
Parameters
Command Reference
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
acl-num
Rel VC4.1 v. 03
Vyatta
112
Default
None.
Usage Guidelines
Use the set form of this command to apply an access list to filter outbound routing updates
to a BGP neighbor.
Use the delete form of this command to disable outbound distribute list filtering.
Use the show form of this command to view BGP neighbor distribute list configuration
settings.
NOTE
A neighbor distribute list cannot be used together with a neighbor prefix list in
the same direction. These two lists are mutually exclusive, and only one list may be applied
to a given direction.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Syntax
set protocols bgp asn neighbor id ebgp-multihop ttl
delete protocols bgp asn neighbor id ebgp-multihop
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
ebgp-multihop: 1-255
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
ttl
Default
Only directly connected neighbors are allowed.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Usage Guidelines
Use the set form of this command to allow connections to eBGP peers residing on networks
that are not directly connected.
Use the delete form of this command to restrict connections to directly connected peers.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Syntax
set protocols bgp asn neighbor id filter-list import acl-num
delete protocols bgp asn neighbor id filter-list import acl-num
show protocols bgp asn neighbor id filter-list
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
filter-list {
import: 1-65535
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
acl-num
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Usage Guidelines
Use the set form of this command to apply an access list for filtering inbound routing
updates.
Use the delete form of this command to disable inbound routing update filtering.
Use the show form of this command to view BGP neighbor filter list configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Syntax
set protocols bgp asn neighbor id filter-list export acl-num
delete protocols bgp asn neighbor id filter-list export acl-num
show protocols bgp asn neighbor id filter-list
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
filter-list {
export: 1-65535
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
acl-num
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Usage Guidelines
Use the set form of this command to apply an access list for filtering outbound routing
updates.
Use the delete form of this command to disable outbound routing update filtering.
Use the show form of this command to view BGP neighbor filter list configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
112
Syntax
set protocols bgp asn neighbor id local-as [local-as asn | no-prepend]
delete protocols bgp asn neighbor id local-as [local-as asn | no-prepend]
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
local-as {
local-as: 1-65535
no-prepend
}
}
}
}
Parameters
Command Reference
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
asn
no-prepend
Optional. Directs the router to not prepend the local autonomous system
number to routes received from an external peer.
Rel VC4.1 v. 03
Vyatta
112
Default
None.
Usage Guidelines
Use the set form of this command to set a local autonomous system number for eBGP peer
groupings. This number is used by all peers in the group for peering. It cannot be applied
to individual peers in the group.
A local autonomous system number can only be applied to a true eBGP peer; it cannot be
applied to peers in different subautonomous systems within a confederation.
The no-prepend keyword can cause routing loops and should be used with care. It should
be used only to change the autonomous system number in a BGP network. After the
network transition has completed, this setting should be deleted.
Use the delete form of this command to remove a local autonomous system number, or to
remove the no-prepend keyword.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Syntax
set protocols bgp asn neighbor id maximum-prefix max-num
delete protocols bgp asn neighbor id maximum-prefix max-num
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
maximum-prefix: u32
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
max-num
Default
No maximum to the number of prefixes accepted.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Usage Guidelines
Use the set form of this command to set the maximum number of prefixes to accept from
this neighbor before the neighbor is taken down. This helps alleviate situations where the
router receives more routes than it can handle.
Use the delete form of this command to remove the maximum.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Syntax
set protocols bgp asn neighbor id nexthop-self
delete protocols bgp asn neighbor id nexthop-self
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
nexthop-self
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
Disabled.
Usage Guidelines
Use the set form of this command to set this router as the next hop for this neighbor. This
disables the next-hop calculation for this neighbor.
Use the delete form of this command to restore next-hop calculation for the neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Syntax
set protocols bgp asn neighbor id override-capability
delete protocols bgp asn neighbor id override-capability
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
override-capability
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
A session cannot be established if the neighbor does not support capability negotiation.
Usage Guidelines
Use the set form of this command to enable a peering session to be established with a BGP
neighbor that does not support capability negotiation.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Normally, if a BGP peer does not support capability negotiation, a peering session cannot
be established and the connection is terminated. Setting this value overrides this process
and allows the session to be established.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Syntax
set protocols bgp asn neighbor id passive
delete protocols bgp asn neighbor id passive
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
passive
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
The router both accepts inbound connections and initiates outbound connections.
Usage Guidelines
Use the set form of this command to configure the local router such that accepts inbound
connections from the neighbor, but does not initiate outbound connections by sending a
BGP OPEN message.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Syntax
To create a BGP peer group, the syntax is as follows:
set protocols bgp asn neighbor group-name peer-group
delete protocols bgp asn neighbor group-name peer-group
show protocols bgp asn neighbor group-name
To add a BGP neighbor to a peer group, the syntax is as follows:
set protocols bgp asn neighbor ipv4 peer-group group-name
delete protocols bgp asn neighbor ipv4 peer-group group-name
show protocols bgp asn neighbor ipv4
Command Mode
Configuration mode.
Configuration Statement
The configuration statement for a BGP peer group is as follows:
protocols {
bgp asn {
neighbor text{
peer-group
}
}
}
The configuration statement for a BGP neighbor that is a member of a BGP peer group is
as follows:
protocols {
bgp asn {
neighbor ipv4{
peer-group: text
}
}
}
Command Reference
Rel VC4.1 v. 03
Vyatta
113
Parameters
asn
ipv4
group-name
Default
By default, peer group members inherit the following settings, if configured:
Remote AS
Update source
Nexthop-self settings
Usage Guidelines
Use the set form of this command to define a peer group or to assign this BGP neighbor to
a peer-group.
Configuring a peer group simplifies configuration for neighbors with similar update
policies. Once a peer group is created, it can be configured using the same commands for
configuring individual BGP neighbors. Each member of the peer group inherits the peer
groups update policies unless overridden by explicit configuration of the individual peer.
This also makes update calculation more efficient.
All members of a peer group must share identical outbound routing policiesthat is, they
must have identified distribute lists, filter lists, prefix lists, and route maps applied. They
need not have identical settings for default-originate, as this is always processed on a
per-peer basis. Inbound update routing policies may vary per peer group member.
Use the delete form of this command to remove a peer group or to remove a neighbor from
a peer group.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Syntax
set protocols bgp asn neighbor id port port-num
delete protocols bgp asn neighbor id port
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
port: 1-65535
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
port-num
Mandatory. The port on which the BGP neighbor will be listening for
BGP messages. The range is 1 to 65535. The default is 179.
Default
By default, the router uses the well-known port for BGP, which is 179.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Usage Guidelines
Use the set form of this command to specify the port number to which BGP signals will be
sent.
Use the delete form of this command to restore the port to the default.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Syntax
set protocols bgp asn neighbor id prefix-list import list-name
delete protocols bgp asn neighbor id prefix-list import list-name
show protocols bgp asn neighbor id prefix-list
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
prefix-list {
import: text
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
list-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Usage Guidelines
Use the set form of this command to restrict distribution of inbound BGP neighbor
information by filtering with a prefix list.
Use the delete form of this command to remove an inbound prefix list filter.
Use the show form of this command to view BGP neighbor prefix list configuration
settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Syntax
set protocols bgp asn neighbor id prefix-list export list-name
delete protocols bgp asn neighbor id prefix-list export list-name
show protocols bgp asn neighbor id prefix-list
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
prefix-list {
export: text
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
list-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Usage Guidelines
Use the set form of this command to restrict distribution of outbound BGP neighbor
information by filtering with a prefix list.
Use the delete form of this command to remove an outbound prefix list filter.
Use the show form of this command to view BGP neighbor prefix list configuration
settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Syntax
set protocols bgp asn neighbor id remote-as asn
delete protocols bgp asn neighbor id remote-as
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
remote-as: u32
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
None.
Usage Guidelines
Use the set form of this command to specify the autonomous system (AS) number of a BGP
neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
If the AS number of the neighbor is the same as that of the local router, the neighbor is an
internal BGP (iBGP) peer. If it is different the neighbor is an external BGP (eBGP) peer.
Use the delete form of this command to remove AS number settings for the neighbor.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Syntax
set protocols bgp asn neighbor id remove-private-as
delete protocols bgp asn neighbor id remove-private-as
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
remove-private-as
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
Private AS numbers are included in outgoing updates.
Command Reference
Rel VC4.1 v. 03
Vyatta
114
Usage Guidelines
Use the set form of this command to direct the router to exclude private autonomous system
(AS) numbers from updates to eBGP peers. When this feature is enabled, the router omits
private AS numbers from the AS_PATH attribute. The range of private AS numbers is
64512 to 65535.
Note that it is a configuration error to include both private and public AS numbers in an AS
path. If the router detects this error, it does not remove private AS numbers.
This command may be used in confederations provided that the private AS numbers are
appended after the confederation portion of the AS path.
This command applies only to eBGP peers; it cannot be used with iBGP peers.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Syntax
set protocols bgp asn neighbor id route-map import map-name
delete protocols bgp asn neighbor id route-map import map-name
show protocols bgp asn neighbor id route-map import map-name
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
route-map {
import: text
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
map-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Usage Guidelines
Use the set form of this command to restrict distribution of BGP neighbor information by
filtering with a route map.
Use the delete form of this command to remove a route map filter.
Use the show form of this command to view BGP neighbor route map configuration
settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Syntax
set protocols bgp asn neighbor id route-map export map-name
delete protocols bgp asn neighbor id route-map export map-name
show protocols bgp asn neighbor id route-map export map-name
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
route-map {
export: text
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
map-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Usage Guidelines
Use the set form of this command to restrict distribution of outbound BGP neighbor
information by filtering with a route map.
Use the delete form of this command to remove an outbound route map filter.
Use the show form of this command to view BGP neighbor route map configuration
settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Syntax
set protocols bgp asn neighbor id route-reflector-client
delete protocols bgp asn neighbor id route-reflector-client
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
route-reflector-client
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
There is no route reflector in the autonomous system.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Usage Guidelines
Use the set form of this command to make the local router a BGP route reflector, and to
designate the specified neighbor as a route reflector client.
Another technology designed to help ASs with large numbers of iBGP peers is route
reflection. In a standard BGP implementation, all iBGP peers must be fully meshed.
because of this requirement, when an iBGP peer learns a route from another iBGP peer, the
receiving router does not forward the route to any of its iBGP peers, since these routers
should have learned the route directly from the announcing router.
In a route reflector environment the iBGP peers are no longer fully meshed. Instead, each
iBGP peer has an iBGP connection to one or more route reflectors (RRs). Routers
configured with a connection to an RR server are referred to as RR clients. Only the RR
server is configured to be aware that the RR client is part of an RR configuration; from the
RR clients point of view, it is configured normally, and does not have any awareness that
it is part of a RR configuration.
In route reflection, internal peers of an RR server are categorized into two types:
Client peers. The RR server and its client peers form a cluster. Within a cluster, client
peers need not be fully meshed, but must have an iBGP connection to at least one RR
in the cluster.
Non-client peers. Non-client peers, including the RR server, must be fully meshed.
If the route was learned from a client peer, the RR reflects the route to both client and
non-client peers. All iBGP updates from client peers are reflected to all other client
peers in the cluster. This is done regardless of whether the update was the best path for
the RR itself.
If the route was learned from a non-client iBGP peer, it is reflected out to all RR client
peers.
If the route was learned from an eBGP peer, the route is reflected to all RR clients and
all non-clients.
Use the delete form of this command to remove the neighbor as a route reflector client.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Syntax
set protocols bgp asn neighbor id route-server-client
delete protocols bgp asn neighbor id route-server-client
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
route-server-client
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
There is no route server in the autonomous system.
Usage Guidelines
Use the set form of this command to make the local router a BGP route server, and to
designate the specified neighbor as a route server client.
Use the delete form of this command to remove the neighbor as a route server client.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Syntax
set protocols bgp asn neighbor id shutdown
delete protocols bgp asn neighbor id shutdown
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
shutdown
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
Disabled.
Usage Guidelines
Use the set form of this command to administratively shut down a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
115
Shutting down a BGP speaker administratively terminates any active sessions for the
neighbor and removes any associated routing information. If the neighbor is a peer group,
this could terminate a large number of sessions.
To determine whether a BGP neighbor has been administratively shut down, you can view
BGP summary information. A neighbor with a status of Idle with a comment of Admin
have been administratively shut down.
Use the delete form of this command to administratively reenable a BGP neighbor.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Syntax
set protocols bgp asn neighbor id soft-reconfiguration [inbound]
delete protocols bgp asn neighbor id soft-reconfiguration
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
soft-reconfiguration {
inbound
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
inbound
Default
Disabled.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Usage Guidelines
Use the set form of this command to enable soft reconfiguration.
When this command is issued, the router begins storing routing updates, which can be used
subsequently for inbound soft reconfiguration. Outbound BGP soft reconfiguration can be
performed without enabling inbound soft reconfiguration.
Soft reconfiguration is memory-intensive and is not recommended for long periods of time.
Use the delete form of this command to disable soft reconfiguration.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Syntax
set protocols bgp asn neighbor id strict-capability-match
delete protocols bgp asn neighbor id strict-capability-match
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
strict-capability-match
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
Default
Disabled.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Usage Guidelines
Use the set form of this command to direct the router strictly compare the capabilities of
the local router and the remote peer. If the capabilities are different, the session is
terminated.
Use the delete form of this command to disable strict capability matching.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Syntax
set protocols bgp asn neighbor id timers [connect seconds | keepalive seconds | holdtime
seconds]
delete protocols bgp asn neighbor id timers [connect | keepalive | holdtime]
show protocols bgp asn neighbor id timers
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
timers {
connect: 0-65535
keepalive: 1-65535
holdtime: 0, 4-65535
}
}
}
Parameters
asn
id
connect seconds
Command Reference
Rel VC4.1 v. 03
Vyatta
116
keepalive seconds
holdtime seconds
Default
The default for the connect timer is 120. The default for the keep-alive timer is 60 seconds.
The default for the holdtime timer is 180 seconds.
Usage Guidelines
Use the set form of this command to set timers for monitoring the health of the remote peer.
If this command is issued and values are specified, the values configured here override
global timers set for the local router.
If this command is issued but values are not specified, the defaults for this command
apply.
If this command is not issued, or if the configuration statement is deleted, timers set
globally for the router using the protocols bgp <asn> timers command (see
page 1220) apply to this neighbor.
Use the delete form of this command to remove explicitly configured timers for a neighbor.
In this case, timers set globally for the router apply to this neighbor.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Syntax
set protocols bgp asn neighbor id unsuppress-map map-name
delete protocols bgp asn neighbor id unsuppress-map
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
unsuppress-map
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
map-name
Default
Routes suppressed by address aggregation are not advertised.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Usage Guidelines
Use the set form of this command to selectively advertise routes suppressed by aggregating
addresses.
Use the delete form of this command to restore the default behavior.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Syntax
set protocols bgp asn neighbor id update-source ethx
delete protocols bgp asn neighbor id update-source
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
update-source: eth0..eth23
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
ethx
Default
The closest interface (that is, the best local address) is assigned for TCP sessions.
Command Reference
Rel VC4.1 v. 03
Vyatta
116
Usage Guidelines
Use the set form of this command to direct the router to use a specific interface for TCP
connections rather than the best local address.
Use the delete form of this command to restore automatic use of the best local address for
TCP connections.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Syntax
set protocols bgp asn neighbor id weight weight
delete protocols bgp asn neighbor id weight
show protocols bgp asn neighbor id
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor [ipv4|text] {
weight: 0-65535
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
id
weight
Default
Routes learned from a BGP neighbor have a weight of 0. Routes sourced by the local router
have a weight of 32768.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Usage Guidelines
Use the set form of this command to set the default weights for routes learned from a BGP
neighbor.
Use the delete form of this command to restore route weighting to the default. Existing
route weights are not changed.
Use the show form of this command to view BGP neighbor configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Syntax
set protocols bgp asn network ipv4net [backdoor | route-map map-name]
delete protocols bgp asn network ipv4net [backdoor | route-map]
show protocols bgp asn network
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
network ipv4net {
backdoor
route-map: text
}
}
}
Parameters
asn
ipv4net
Command Reference
backdoor
route-map map-name
Rel VC4.1 v. 03
Vyatta
117
Default
None.
Usage Guidelines
Use this command to advertise networks to BGP neighbors.
Use the set form of this command to specify a network to be announced via BGP.
Use the delete form of this command to remove a network from the list of networks to be
announced by BGP.
Use the show form of this command to view BGP network advertising configuration
settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Syntax
set protocols bgp asn parameters always-compare-med
delete protocols bgp asn parameters always-compare-med
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
always-compare-med
}
}
}
Parameters
asn
Default
The MED is not compared.
Usage Guidelines
Use the set form of this command to have the router compare the Multi Exit Discriminator
(MED) for paths from neighbors in different autonomous systems.
The MED is compared only if the AS path for the compared routes is identical.
Use the delete form of this command to disable MED comparison.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Syntax
set protocols bgp asn parameters bestpath as-path [confed | ignore]
delete protocols bgp asn parameters bestpath as-path
show protocols bgp asn parameters bestpath
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
bestpath {
as-path {
confed
ignore
}
}
}
}
}
Parameters
Command Reference
asn
confed
ignore
Rel VC4.1 v. 03
Vyatta
117
Default
By default, when making the best-path selection the router does not compare AS_PATHs
within a confederation and does not ignore the AS_PATH.
Usage Guidelines
Use the set form of this command to direct the router to compare the AS paths during best
path selection.
Use the delete form of this command to restore the default best-path selection behavior.
Use the show form of this command to view BGP best path selection configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Syntax
set protocols bgp asn parameters bestpath compare-routerid
delete protocols bgp asn parameters bestpath compare-routerid
show protocols bgp asn parameters bestpath
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
bestpath {
compare-routerid
}
}
}
}
Parameters
asn
Default
By default, when making the best-path selection the router does not compare identical
routes received from different external peers.
Command Reference
Rel VC4.1 v. 03
Vyatta
117
Usage Guidelines
Use the set form of this command to direct the router to compare identical routes received
from different external peers during best path selection, and select as the best path the route
with the lowest router ID.
Use the delete form of this command to restore the default best-path selection behavior.
Use the show form of this command to view BGP best path selection configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Syntax
set protocols bgp asn parameters bestpath med [confed | missing-as-worst]
delete protocols bgp asn parameters bestpath med [confed | missing-as-worst]
show protocols bgp asn parameters bestpath
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
bestpath {
med {
confed
missing-as-worst
}
}
}
}
}
Parameters
asn
confed
missing-as-worst
Default
By default, when making the best-path selection the router does not consider the MED.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Usage Guidelines
Use the set form of this command to direct the router to compare the Multi Exit
Discriminator (MED) among paths learned from confederation peers during best-path
selection.
Use the delete form of this command to restore the default best-path selection behavior.
Use the show form of this command to view BGP best path selection configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Syntax
set protocols bgp asn parameters cluster-id id
delete protocols bgp asn parameters cluster-id id
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
cluster-id: ipv4
}
}
}
Parameters
asn
id
Default
None.
Usage Guidelines
Use the set form of this command to specify the route reflection cluster ID for an internal
route reflection cluster.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
When there is only one route reflector in a cluster, the cluster uses the router ID of the route
reflector as an ID. If more than one route reflector is deployed in a cluster (for example, to
provide redundancy), you must provide an ID for the cluster. In this case, the cluster ID is
assigned to every route reflector in the cluster.
Use the delete form of this command to remove a cluster ID.
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Syntax
set protocols bgp asn parameters confederation identifier asn
delete protocols bgp asn parameters confederation identifier asn
show protocols bgp asn parameters confederation
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
confederation {
identifier: u32
}
}
}
}
Parameters
asn
identifier asn
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Usage Guidelines
Use the set form of this command to create a BGP confederation.
Use the delete form of this command to remove the BGP confederation.
Use the show form of this command to view BGP confederation configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Syntax
set protocols bgp asn parameters confederation peers asn [asn... asn]
delete protocols bgp asn parameters confederation peers asn [asn... asn]
show protocols bgp asn parameters confederation
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
confederation {
peers: u32
}
}
}
}
Parameters
asn
peers asn
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Usage Guidelines
Use the set form of this command to list the subautonomous systems that will be the
members of a BGP confederation. To a peer outside the confederation, the confederation
appears as a single autonomous system.
Use the delete form of this command to remove an AS from a confederation.
Use the show form of this command to view BGP confederation configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
118
Syntax
set protocols bgp asn parameters dampening [half-life minutes | re-use penalty |
start-suppress-time penalty | max-suppress-time minutes]
delete protocols bgp asn parameters dampening [half-life | re-use | start-suppress-time
| max-suppress-time]
show protocols bgp asn parameters dampening
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
dampening {
half-life: 1-45
max-suppress-time: 1-20000
re-use: 1-20000
start-suppress-time: 1-20000
}
}
}
}
Parameters
Command Reference
asn
half-life minutes
max-suppress-time
minutes
Rel VC4.1 v. 03
Vyatta
118
re-use penalty
start-suppress-time
penalty
Default
Route dampening is disabled.
Usage Guidelines
Use the set form of this command to configure route dampening. When used with no
options, this command enables route dampening at the default values.
Use the delete form of this command to disable route dampening or reset route dampening
parameters to default values.
Use the show form of this command to view BGP route dampening configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Syntax
set protocols bgp asn parameters default [local-pref pref | no-ipv4-unicast]
delete protocols bgp asn parameters default [local-pref | no-ipv4-unicast]
show protocols bgp asn parameters default
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
default {
local-pref: u32
no-ipv4-unicast
}
}
}
}
Parameters
Command Reference
asn
local-pref pref
no-ipv4-unicast
Rel VC4.1 v. 03
Vyatta
119
Default
The value of the local-pref attribute is 100. IPv4 unicast is the default address family.
Usage Guidelines
Use the set form of this command to override default local route preferences and automatic
address family exchanges.
Use the delete form of this command to reset the route preferences and address family
exchanges to the default.
Use the show form of this command to view BGP default routing configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Syntax
set protocols bgp asn parameters deterministic-med
delete protocols bgp asn parameters deterministic-med
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
deterministic-med
}
}
}
Parameters
asn
Default
Deterministic MED is not enforced.
Usage Guidelines
Use the set form of this command to enforce the deterministic comparison of the Multi Exit
Discriminator (MED) value between all paths received from within the same autonomous
system.
Use the delete form of this command to disable required MED comparison.
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Syntax
set protocols bgp asn parameters disable-network-import-check
delete protocols bgp asn parameters disable-network-import-check
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
disable-network-import-check
}
}
}
Parameters
asn
Default
IGP route check for network statements is enabled.
Usage Guidelines
This command will cause BGP to advertise a network regardless of IGP.
Use the set form of this command to disable IGP route checks for network statements.
Use the delete form of this command to enable IGP route checks for network statements.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Syntax
set protocols bgp asn parameters enforce-first-as
delete protocols bgp asn parameters enforce-first-as
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
enforce-first-as
}
}
}
Parameters
asn
Default
Enabled.
Usage Guidelines
Use the set form of this command to direct the router to enforce listing of an eBGP peers
AS number at the beginning of the AS_PATH.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
When this feature is enabled, the router will deny an update received from an external BGP
(eBGP) peer unless the AS number is listed at the beginning of the AS_PATH in the
incoming update. This prevents spoof situations where a misconfigured or unauthorized
peer misdirecting traffic by advertising a route as if it were sourced from another
autonomous system.
Use the delete form of this command to disable this behavior.
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Syntax
set protocols bgp asn parameters graceful-restart [stalepath-time seconds]
delete protocols bgp asn parameters graceful-restart
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
graceful-restart {
stalepath-time: 1-3600
}
}
}
}
Parameters
asn
stalepath-time seconds Optional. Sets the maximum interval, in seconds, to retain stale
paths for a restarting peer. If this interval is exceeded, all stale
paths are removed.
The range is 1 to 3600. The default is 360.
The default value for this attribute is optimal for most
deployments, and changing this value can have negative effects
on network behavior. We recommend that only experienced
network operators change this values.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Default
By default, paths for restarting peers are retained for at most 360 seconds.
Usage Guidelines
Use the set form of this command to direct the router to restart gracefully when it is reset.
Use the delete form of this command to disable graceful restart.
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
119
Syntax
set protocols bgp asn parameters log-neighbor-changes
delete protocols bgp asn parameters log-neighbor-changes
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
log-neighbor-changes
}
}
}
Parameters
asn
Default
Disabled.
Usage Guidelines
Use the set form of this command to direct the router to log changes in adjacencies for BGP
neighbors.
This feature helps detect network problems, by recording when BGP neighbors come up or
go down, and when they reset. Log messages are sent to the main log file.
Use the delete form of this command to disable logging of neighbor status changes.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Use the show form of this command to view global BGP configuration settings.
Even when this feature is disabled, the system tracks neighbor resets; these resets can be
seen in the output of the show ip bgp neighbors command.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Syntax
set protocols bgp asn parameters no-client-to-client-reflection
delete protocols bgp asn parameters no-client-to-client-reflection
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
no-client-to-client-reflection
}
}
}
Parameters
asn
Default
By default client-to-client-reflection is enabled.
Usage Guidelines
Use the set form of this command to disable route reflection from a BGP route reflector to
clients. When client-to-client route reflection is enabled, the configured route reflector
reflects routes from one client to other clients.
Use the delete form of this command to enable client-to-client route reflection.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Syntax
set protocols bgp asn parameters no-fast-external-failover
delete protocols bgp asn parameters no-fast-external-failover
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
no-fast-external-failover
}
}
}
Parameters
asn
Default
Disabled. By default, sessions are automatically reset.
Usage Guidelines
Use the set form of this command to disable fast external failover.
When fast external failover is enabled, then BGP sessions for directly adjacent external
peers are immediately reset if the link fails.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Use the delete form of this command to restore fast external failover.
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Syntax
set protocols bgp asn parameters router-id id
delete protocols bgp asn parameters router-id id
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
router-id: ipv4
}
}
}
Parameters
asn
id
Default
When router ID is not explicitly set, then the router ID is automatically set to the IP address
of the loopback address, if configured. If the loopback address is not configured, the router
ID is set to the highest IP address on a physical interface.
Usage Guidelines
Use the set form of this command to configure a fixed router ID for the local BGP routing
process. This ID will override the router ID automatic set by the system.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Use the delete form of this command to remove the fixed router ID and restore the
automatically selected ID.
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Syntax
set protocols bgp asn parameters scan-time seconds
delete protocols bgp asn parameters scan-time seconds
show protocols bgp asn parameters
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
parameters {
scan-time: u32
}
}
}
Parameters
asn
seconds
Mandatory. The interval, in seconds, at which the router scans for BGP
routing information. The range is 5 to 60. The default is 15.
Default
Scans take place every 15 seconds.
Usage Guidelines
Use the set form of this command to set the interval at which the router scans for BGP
routing information.
Use the delete form of this command to reset the scanning interval to the default.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Use the show form of this command to view global BGP configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
120
Syntax
set protocols bgp asn redistribute connected [metric metric | route-map map-name]
delete protocols bgp asn redistribute connected [metric | route-map]
show protocols bgp asn redistribute
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor text {
redistribute {
connected {
metric: u32
route-map: text
}
}
}
}
}
Parameters
Command Reference
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
metric
map-name
Rel VC4.1 v. 03
Vyatta
121
Default
When this command has not been set, directly connected routes are not distributed into
BGP.
Usage Guidelines
Use this command to redistribute directly connected routes into BGP.
Use the set form of this command to direct the router to redistribute directly connected
routes into BGP.
Use the delete form of this command to prevent redistribution of directly connected routes
into BGP.
Use the show form of this command to view route redistribution configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Syntax
set protocols bgp asn redistribute kernel [metric metric | route-map map-name]
delete protocols bgp asn redistribute kernel [metric | route-map]
show protocols bgp asn redistribute
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor text {
redistribute {
kernel {
metric: u32
route-map: text
}
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
metric
map-name
Default
When this command has not been set, kernel routes are not distributed into BGP.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Usage Guidelines
Use this command to redistribute kernel routes into BGP.
Use the set form of this command to direct the router to redistribute kernel routes into BGP.
Use the delete form of this command to prevent redistribution of kernel routes into BGP.
Use the show form of this command to view route redistribution configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Syntax
set protocols bgp asn redistribute ospf [metric metric | route-map map-name]
delete protocols bgp asn redistribute ospf [metric | route-map]
show protocols bgp asn redistribute
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor text {
redistribute {
ospf {
metric: u32
route-map: text
}
}
}
}
}
Parameters
Command Reference
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
metric
map-name
Rel VC4.1 v. 03
Vyatta
121
Default
When this command has not been set, routes learned from OSPF are not distributed into
BGP.
Usage Guidelines
Use this command to redistribute Open Shortest Path First (OSPF) routes into BGP.
Use the set form of this command to direct the router to redistribute routes learned from
OSPF into BGP.
Use the delete form of this command to prevent redistribution of routes learned from OSPF
into BGP.
Use the show form of this command to view route redistribution configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Syntax
set protocols bgp asn redistribute rip [metric metric | route-map map-name]
delete protocols bgp asn redistribute rip [metric | route-map]
show protocols bgp asn redistribute
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor text {
redistribute {
rip {
metric: u32
route-map: text
}
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
metric
map-name
Default
When this command has not been set, routes learned from RIP are not distributed into BGP.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Usage Guidelines
Use this command to redistribute Routing Information Protocol (RIP) routes into BGP.
Use the set form of this command to direct the router to redistribute routes learned from
RIP into BGP.
Use the delete form of this command to prevent redistribution of routes learned from RIP
into BGP.
Use the show form of this command to view route redistribution configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Syntax
set protocols bgp asn redistribute static [metric metric | route-map map-name]
delete protocols bgp asn redistribute static [metric | route-map]
show protocols bgp asn redistribute
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
neighbor text {
redistribute {
static {
metric: u32
route-map: text
}
}
}
}
}
Parameters
asn
Mandatory. The number for the AS in which this router resides. The
range of values is 1 to 65535. The subrange 64512 to 65535 is reserved
for private autonomous systems.
metric
map-name
Default
When this command has not been set static routes are not distributed into BGP.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Usage Guidelines
Use this command to redistribute static routes into BGP.
Use the set form of this command to direct the router to redistribute static routes into BGP.
Use the delete form of this command to prevent redistribution of static routes into BGP.
Use the show form of this command to view route redistribution configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
121
Syntax
set protocols bgp asn timers [keepalive seconds | holdtime seconds]
delete protocols bgp asn timers [keepalive | holdtime]
show protocols bgp asn timers
Command Mode
Configuration mode.
Configuration Statement
protocols {
bgp asn {
timers {
keepalive: 1-65535
holdtime: 0, 4-65535
}
}
Parameters
asn
keepalive seconds
holdtime seconds
Default
The default for the keep-alive timer is 60 seconds. The default for the holdtime timer is 180
seconds.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Usage Guidelines
Use the set form of this command to set global BGP timers for monitoring the health of
remote peers. These timers will be applied to all remote peers unless a neighbor has timers
explicitly configured for it. Timers explicitly specified for a neighbor override the timers
set globally.
Use the delete form of this command to restore global BGP timers to default values.
Use the show form of this command to view global BGP timer configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show debugging bgp
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display BGP protocol debugging flags.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
show ip bgp
show ip bgp
Displays BGP routes.
Syntax
show ip bgp [ipv4 | ipv4net [longer-prefixes] | summary]
Command Mode
Operational mode.
Parameters
ipv4
ipv4net
longer-prefixes
Optional. Displays any routes more specific than the one specified.
summary
Default
Displays all BGP routes by default.
Usage Guidelines
Use this command to display the BGP routing table.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show ip bgp attribute-info
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display BGP attribute information.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show ip bgp cidr-only
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display only routes with non-natural network masks; that is, Classless
Inter Domain Routing network masks.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show ip bgp community-info
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display BGP community information.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show ip bgp community community [exact-match]
Command Mode
Operational mode.
Parameters
community
exact-match
Default
None.
Usage Guidelines
Use this command to display the BGP routes belonging to up to four BGP communities.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show ip bgp community-list list-name [exact-match]
Command Mode
Operational mode.
Parameters
list-name
exact-match
Default
None.
Usage Guidelines
Use this command to display the BGP routes permitted by the specified community list.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show ip bgp dampened-paths
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display the BGP routes that are currently dampened.
Command Reference
Rel VC4.1 v. 03
Vyatta
122
Syntax
show ip bgp filter-list list-num
Command Mode
Operational mode.
Parameters
list-num
Default
None.
Usage Guidelines
Use this command to filter displayed routes according to preconfigured access list of
autonomous system paths.
BGP filter lists are defined using the the policy as-path-list <list-name> command (see
page 1291).
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp flap-statistics [ipv4 | ipv4net [longer-prefixes]
Command Mode
Operational mode.
Parameters
ipv4
ipv4net
longer-prefixes
Optional. Displays any routes more specific than the one specified.
Default
Displays route flap statistics for all BGP routes.
Usage Guidelines
Use this command to display statistics for flapping BGP routes.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp flap-statistics cidr-only
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display route flap statistics for BGP routes with non-natural network
masks; that is, Classless Inter Domain Routing (CIDR) network masks.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp flap-statistics filter-list list-num
Command Mode
Operational mode.
Parameters
list-num
Default
None.
Usage Guidelines
Use this command to display route flap statistics for BGP routes matching a preconfigured
access list of autonomous system (AS) paths.
AS path filter lists are configured using the policy as-path-list <list-name> command (see
page 1291).
.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp flap-statistics prefix-list list-name
Command Mode
Operational mode.
Parameters
list-name
Default
None.
Usage Guidelines
Use this command to display BGP statistics for BGP routes matching a list of network
prefixes.
Prefix lists are configured using the policy prefix-list <list-name> command (see
page 1307).
.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp flap-statistics regexp expr
Command Mode
Operational mode.
Parameters
expr
Default
Displays flap statistics for all BGP routes by default.
Usage Guidelines
Use this command to display route flap statistics for BGP routes matching a regular
expression representing a set of autonomous system (AS) paths.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp flap-statistics route-map map-name
Command Mode
Operational mode.
Parameters
map-name
Default
Displays flap statistics for all BGP routes by default.
Usage Guidelines
Use this command to display route flap statistics for BGP routes matching a preconfigured
route map.
Route maps are configured using the policy route-map <map-name> command (see
page 1319).
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp ipv4 unicast [ipv4 | ipv4net [longer-prefixes] | summary]
Command Mode
Operational
Parameters
ipv4
ipv4net
longer-prefixes
Optional. Displays any routes more specific than the one specified.
summary
Default
Displays all IPv4 unicast BGP routes by default.
Usage Guidelines
Use this command to display IPv4 unicast routes in the BGP routing table.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp ipv4 unicast cidr-only
Command Mode
Operational
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display only BGP IPv4 unicast routes with non-natural network
masks; that is, Classless Inter Domain Routing (CIDR) network masks.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp ipv4 unicast community community [exact-match]
Command Mode
Operational mode.
Parameters
community
exact-match
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast routes belonging to up to four BGP
communities.
Command Reference
Rel VC4.1 v. 03
Vyatta
123
Syntax
show ip bgp ipv4 unicast community-list list-name [exact-match]
Command Mode
Operational mode.
Parameters
list-name
exact-match
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast routes permitted by the specified
community list.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast filter-list list-num
Command Mode
Operational mode.
Parameters
list-num
Default
None.
Usage Guidelines
Use this command to filter displayed BGP IPv4 unicast routes matching a preconfigured
access list of autonomous system paths.
BGP filter lists are defined using the the policy as-path-list <list-name> command (see
page 1291).
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast neighbors [ipv4]
Command Mode
Operational mode.
Parameters
ipv4
Default
Information is shown for all IPv4 unicast BGP neighbors.
Usage Guidelines
Use this command to display BGP IPv4 unicast neighbor information.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast neighbors ipv4 advertised-routes
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display advertised BGP IPv4 unicast routes for a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast neighbors ipv4 prefix-counts
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display IPv4 unicast prefix counts for a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast neighbors ipv4 received prefix-filter
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast prefix-lists received from a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast neighbors ipv4 received-routes
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display IPv4 unicast routes (both accepted and rejected) received
from a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast neighbors ipv4 routes
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display IPv4 unicast received and accepted routes from a
BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast paths
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast path information.
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast prefix-list list-name
Command Mode
Operational mode.
Parameters
list-name
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast routes matching a preconfigured prefix list.
Prefix lists are configured using the policy prefix-list <list-name> command (see
page 1307).
Command Reference
Rel VC4.1 v. 03
Vyatta
124
Syntax
show ip bgp ipv4 unicast regexp regexp
Command Mode
Operational mode.
Parameters
regexp
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast routes matching the specified AS path
regular expression.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp ipv4 unicast route-map map-name
Command Mode
Operational mode.
Parameters
map-name
Default
None.
Usage Guidelines
Use this command to display IPv4 unicast BGP routes matching a preconfigured route map.
Route maps are defined using the the policy route-map <map-name> command (see
page 1319).
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp ipv4 unicast rsclient summary
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display IPv4 unicast BGP route server client summary information.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp ipv4 unicast statistics
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast statistics.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp memory
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display the amount of memory being used for BGP, including the
RIB, cache entries, attributes, AS-PATH entries, and hashes.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp neighbors [ipv4]
Command Mode
Operational mode.
Parameters
ipv4
Default
Information is shown for all BGP neighbors.
Usage Guidelines
Use this command to display BGP neighbor information.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp neighbors ipv4 advertised-routes
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display advertised routes for a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp neighbors ipv4 dampened-routes
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display routes that have been dampened (suppressed) to a BGP
neighbor due to route flapping.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp neighbors ipv4 flap-statistics
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display route flap statistics for routes learned from a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp neighbors ipv4 prefix-counts
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display prefix counts for a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
125
Syntax
show ip bgp neighbors ipv4 received prefix-filter
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display prefix lists received from a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp neighbors ipv4 received-routes
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display routes (both accepted and rejected) received from a BGP
neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp neighbors ipv4 routes
Command Mode
Operational mode.
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to display received and accepted routes from a BGP neighbor.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp paths
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display all BGP paths.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp prefix-list list-name
Command Mode
Operational mode.
Parameters
list-name
Default
None.
Usage Guidelines
Use this command to display routes that match a preconfigured prefix list.
Prefix lists are configured using the policy prefix-list <list-name> command (see
page 1307).
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp regexp regexp
Command Mode
Operational mode.
Parameters
regexp
Default
None.
Usage Guidelines
Use this command to display routes matching a regular expression representing an
autonomous system (AS) path list.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp route-map map-name
Command Mode
Operational mode.
Parameters
map-name
Default
None.
Usage Guidelines
Use this command to display routes matching a preconfigured route map.
Route maps are defined using the the policy route-map <map-name> command (see
page 1319).
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp rsclient address [ipv4 | ipv4net | summary]
Command Mode
Operational mode.
Parameters
ipv4
Optional. Displays routes for the route server client at the specified IPv4
address.
ipv4net
Optional. Displays routes for route server clients on the specified IPv4
network.
summary
Default
Detailed information is displayed for all route server clients.
Usage Guidelines
Use this command to display BGP route server client information.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp scan
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display BGP scan status.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp view view-name [ipv4 | ipv4net | summary]
Command Mode
Operational mode.
Parameters
view-name
ipv4
ipv4net
summary
Default
None.
Usage Guidelines
Use this command to display BGP information for a view in a BGP route server.
Using a BGP route server is a way of solving the scalability problem that results from the
requirement that iBGP peers be fully meshed. When a route server is employed, BGP
routers peer only to the route server, and the route server servers BGP information to other
BGP routers. This greatly reduces the number of BGP connections required.
Unlike a normal BGP router, a BGP router server must have several routing tables for
managing the various routing policies of each BGP speakers: each of these routing tables
is called a view.
Command Reference
Rel VC4.1 v. 03
Vyatta
126
Syntax
show ip bgp view view-name ipv4 unicast rsclient summary
Command Mode
Operational mode.
Parameters
view-name
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast route server client summary information
for a view in a BGP route server.
Using a BGP route server is a way of solving the scalability problem that results from the
requirement that iBGP peers be fully meshed. When a route server is employed, BGP
routers peer only to the route server, and the route server servers BGP information to other
BGP routers. This greatly reduces the number of BGP connections required.
Unlike a normal BGP router, a BGP router server must have several routing tables for
managing the various routing policies of each BGP speakers: each of these routing tables
is called a view.
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Syntax
show ip bgp view view-name ipv4 unicast summary
Command Mode
Operational mode.
Parameters
view-name
Default
None.
Usage Guidelines
Use this command to display BGP IPv4 unicast summary information for a view in a BGP
route server.
Using a BGP route server is a way of solving the scalability problem that results from the
requirement that iBGP peers be fully meshed. When a route server is employed, BGP
routers peer only to the route server, and the route server servers BGP information to other
BGP routers. This greatly reduces the number of BGP connections required.
Unlike a normal BGP router, a BGP router server must have several routing tables for
managing the various routing policies of each BGP speakers: each of these routing tables
is called a view.
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Syntax
show ip bgp view view-name neighbors [ipv4]
Command Mode
Operational mode.
Parameters
view-name
ipv4
ipv6
Default
Information is displayed for all BGP neighbors in the view.
Usage Guidelines
Use this command to display BGP neighbor information for a view in a BGP route server.
Using a BGP route server is a way of solving the scalability problem that results from the
requirement that iBGP peers be fully meshed. When a route server is employed, BGP
routers peer only to the route server, and the route server servers BGP information to other
BGP routers. This greatly reduces the number of BGP connections required.
Unlike a normal BGP router, a BGP router server must have several routing tables for
managing the various routing policies of each BGP speakers: each of these routing tables
is called a view.
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Syntax
show ip bgp view view-name rsclient {ipv4 | ipv6 | ipv4net| | summary}
Command Mode
Operational mode.
Parameters
view-name
ipv4
Displays route server client information for the specified IPv4 neighbor.
ipv6
Displays route server client information for the specified IPv6 neighbor.
ipv4net
summary
Default
Detailed information is displayed.
Usage Guidelines
Use this command to display BGP route server client information for a view in a BGP route
server.
Using a BGP route server is a way of solving the scalability problem that results from the
requirement that iBGP peers be fully meshed. When a route server is employed, BGP
routers peer only to the route server, and the route server servers BGP information to other
BGP routers. This greatly reduces the number of BGP connections required.
Unlike a normal BGP router, a BGP router server must have several routing tables for
managing the various routing policies of each BGP speakers: each of these routing tables
is called a view.
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Syntax
show ip route bgp
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display BGP routes.
Examples
Example 16-1 shows BGP routes.
Example 16-1 show ip route bgp: Displaying BGP routes
vyatta@vyatta:~$ show ip route bgp
Codes: K - kernel route, C - connected, S - static, R - RIP, O - OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
B
B>*
B>*
B>*
B>*
B>*
B>*
B>*
B>*
B>*
B>*
B>*
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Command Reference
Rel VC4.1 v. 03
Vyatta
127
1276
This chapter lists the commands you can use to create routing policies.
This chapter contains the following commands.
Command
Description
127
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
127
Command
Description
policy route-map <map-name> rule <rule-num> match peer Defines a match condition for a route map based on
<ipv4>
peer IP address.
policy route-map <map-name> rule <rule-num> match tag
<tag>
Operational Commands
show ip access-list
show ip as-path-access-list
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Command
Description
show ip community-list
show ip extcommunity-list
show ip prefix-list
show ip protocol
show route-map
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
set policy access-list list-num
delete policy access-list list-num
show policy access-list list-num
Command Mode
Configuration mode.
Configuration Statement
policy {
access-list u32 {}
}
Parameters
list-num
Default
None.
Usage Guidelines
Use the set form of this command to create an access list.
Use the delete form of this command to remove an access list.
Use the show form of this command to display access list configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Syntax
set policy access-list list-num description desc
delete policy access-list list-num description
show policy access-list list-num description
Command Mode
Configuration mode.
Configuration Statement
policy {
access-list u32 {
description: text
}
}
Parameters
list-num
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for an access list.
Use the delete form of this command to remove an access list description.
Use the show form of this command to display the description for an access list.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Syntax
set policy access-list list-num rule rule-num
delete policy access-list list-num rule rule-num
show policy access-list list-num rule rule-num
Command Mode
Configuration mode.
Configuration Statement
policy {
access-list u32 {
rule u32 {}
}
}
Parameters
list-num
rule-num
Default
None.
Usage Guidelines
Use the set form of this command to create an access list rule.
Use the delete form of this command to remove an access list rule.
Use the show form of this command to display configuration settings for an access list rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Syntax
set policy access-list list-num rule rule-num action {deny | permit}
delete policy access-list list-num rule rule-num action
show policy access-list list-num rule rule-num action
Command Mode
Configuration mode.
Configuration Statement
policy {
access-list u32 {
rule u32 {
action {
deny
permit
}
}
}
}
Parameters
list-num
rule-num
deny
permit
Default
Packets matching this rule are forwarded.
Usage Guidelines
Use the set form of this command to define the action taken when received packets satisfy
the match criteria for this rule.
If the action for a rule is deny, packets meeting the match criteria of the rule are silently
dropped. If the action for the rule is permit, packets meeting the match criteria of the rule
are forwarded.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Use the delete form of this command to restore the default action for packets satisfying the
match criteria.
Use the show form of this command to display action settings for this rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Syntax
set policy access-list list-num rule rule-num description desc
delete policy access-list list-num rule rule-num description
show policy access-list list-num rule rule-num description
Command Mode
Configuration mode.
Configuration Statement
policy {
access-list u32 {
rule u32 {
description: text
}
}
}
Parameters
list-num
rule-num
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for an access list rule.
Use the delete form of this command to remove an access list rule description.
Use the show form of this command to display an access list rule description.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Syntax
set policy access-list list-num rule rule-num destination {any | host ipv4 | inverse-mask
ipv4 | network ipv4net}
delete policy access-list list-num rule rule-num destination
show policy access-list list-num rule rule-num destination
Command Mode
Configuration mode.
Configuration Statement
policy {
access-list u32 {
rule u32 {
destination {
any
host: ipv4
inverse-mask: ipv4
network: ipv4net
}
}
}
}
Parameters
Command Reference
list-num
rule-num
any
host ipv4
Match packets destined for the specified IPv4 host. Exactly one
of any, host, inverse-mask, and network is mandatory.
inverse-mask ipv4
Rel VC4.1 v. 03
Vyatta
128
network ipv4net
Default
None.
Usage Guidelines
Use the set form of this command to specify the destination match criteria for this access
list rule.
Use the delete form of this command to remove configured destination match criteria for
this rule. If no match criteria are specified, no packet filtering on destination will take place;
that is, packets to all destinations are permitted.
Use the show form of this command to display configuration settings for access list rule
destination packet filtering.
Command Reference
Rel VC4.1 v. 03
Vyatta
128
Syntax
set policy access-list list-num rule rule-num source {any | host ipv4 | inverse-mask ipv4
| network ipv4net}
delete policy access-list list-num rule rule-num source
show policy access-list list-num rule rule-num source
Command Mode
Configuration mode.
Configuration Statement
policy {
access-list u32 {
rule u32 {
source {
any
host: ipv4
inverse-mask: ipv4
network: ipv4net
}
}
}
}
Parameters
Command Reference
list-num
rule-num
any
host ipv4
inverse-mask ipv4
Rel VC4.1 v. 03
Vyatta
128
network ipv4net
Default
None.
Usage Guidelines
Use the set form of this command to specify the source match criteria for this access list
rule.
Use the delete form of this command to remove the configured source match criteria for
this rule. If no match criteria are specified, no packet filtering on source will take place; that
is, packets from all sources are permitted.
Use the show form of this command to display configuration settings for access list rule
source packet filtering.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy as-path-list list-name
delete policy as-path-list list-name
show policy as-path-list list-name
Command Mode
Configuration mode.
Configuration Statement
policy {
as-path-list text {}
}
Parameters
list-name
Default
None.
Usage Guidelines
Use the set form of this command to define an autonomous system (AS) path list for use in
policy-based routing.
Use the delete form of this command to remove an AS path list.
Use the show form of this command to display AS path list configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy as-path-list list-name description desc
delete policy as-path-list list-name description
show policy as-path-list list-name description
Command Mode
Configuration mode.
Configuration Statement
policy {
as-path-list text {
description: text
}
}
Parameters
list-name
desc
Default
None.
Usage Guidelines
Use the set form of this command to specify a description for an AS path list.
Use the delete form of this command to remove an AS path list description.
Use the show form of this command to display an AS path list description.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy as-path-list list-name rule rule-num
delete policy as-path-list list-name rule rule-num
show policy as-path-list list-name rule rule-num
Command Mode
Configuration mode.
Configuration Statement
policy {
as-path-list text {
rule u32 {}
}
}
Parameters
list-name
rule-num
Default
None.
Usage Guidelines
Use the set form of this command to create an AS path list rule.
Use the delete form of this command to remove an AS path list rule.
Use the show form of this command to display configuration settings for an AS path list
rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy as-path-list list-name rule rule-num action {deny | permit}
delete policy as-path-list list-name rule rule-num action
show policy as-path-list list-name rule rule-num action
Command Mode
Configuration mode.
Configuration Statement
policy {
as-path-list text {
rule u32 {
action {
deny
permit
}
}
}
}
Parameters
list-name
rule-num
deny
permit
Default
Packets matching this rule are forwarded.
Usage Guidelines
Use the set form of this command to define the action taken when received packets satisfy
the match criteria for this rule.
If the action for a rule is deny, packets meeting the match criteria of the rule are silently
dropped. If the action for the rule is permit, destination-based routing is performed; that is,
packets are sent using the normal forwarding channels.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Use the delete form of this command to restore the default action for packets satisfying the
match criteria.
Use the show form of this command to display action settings for this rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy as-path-list list-name rule rule-num description desc
delete policy as-path-list list-name rule rule-num description
show policy as-path-list list-name rule rule-num description
Command Mode
Configuration mode.
Configuration Statement
policy {
as-path-list text {
rule u32 {
description: text
}
}
}
Parameters
list-name
rule-num
desc
Default
None.
Usage Guidelines
Use the set form of this command to specify a description for an AS path list.
Use the delete form of this command to remove an AS path list description.
Use the show form of this command to display an AS path list description.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy as-path-list list-name rule rule-num regex regex
delete policy as-path-list list-name rule rule-num regex
show policy as-path-list list-name rule rule-num regex
Command Mode
Configuration mode.
Configuration Statement
policy {
as-path-list text {
rule u32 {
regex: text
}
}
}
Parameters
list-name
rule-num
regex
Default
If no regular expression is defined, all packets are considered to match the rule.
Usage Guidelines
Use the set form of this command to define the match criteria to be used to determine
forwarding policy based on AS paths.
Packets are matched based on whether the AS paths listed in the packet match the regular
expression defined using this command. Depending on the action defined for the rule using
the policy as-path-list <list-name> rule <rule-num> action command (see page 1294),
matched packets are either permitted or denied.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Use the delete form of this command to remove the regular expression entry. If no regular
expression is defined, all packets are considered to match the rule.
Use the show form of this command to display the regular expression entry.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy community-list list-num
delete policy community-list list-num
show policy community-list list-num
Command Mode
Configuration mode.
Configuration Statement
policy {
community-list: u32 {}
}
Parameters
list-num
Default
None.
Usage Guidelines
Use the set form of this command to create a BGP community list for use in policy-based
routing.
Use the delete form of this command to remove a community list.
Use the show form of this command to display community list configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
129
Syntax
set policy community-list list-num description desc
delete policy community-list list-num description
show policy community-list list-num description
Command Mode
Configuration mode.
Configuration Statement
policy {
community-list u32 {
description: text
}
}
Parameters
list-num
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for a community list.
Use the delete form of this command to remove a community list description.
Use the show form of this command to display the description for a community list.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy community-list list-num rule rule-num
delete policy community-list list-num rule rule-num
show policy community-list list-num rule rule-num
Command Mode
Configuration mode.
Configuration Statement
policy {
community-list u32 {
rule u32 {}
}
}
Parameters
list-num
rule-num
Default
None.
Usage Guidelines
Use the set form of this command to create a community list rule.
Use the delete form of this command to remove a community list rule.
Use the show form of this command to display configuration settings for a community list
rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy community-list list-num rule rule-num action {deny | permit}
delete policy community-list list-num rule rule-num action
show policy community-list list-num rule rule-num action
Command Mode
Configuration mode.
Configuration Statement
policy {
community-list u32 {
rule u32 {
action {
deny
permit
}
}
}
}
Parameters
list-num
rule-num
deny
permit
Default
Packets matching this rule are forwarded.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Usage Guidelines
Use the set form of this command to define the action taken when received packets satisfy
the match criteria for this rule.
If the action for a rule is deny, packets meeting the match criteria of the rule are silently
dropped. If the action for the rule is permit, destination-based routing is performed; that is,
packets are sent using the normal forwarding channels.
Use the delete form of this command to restore the default action for packets satisfying the
match criteria.
Use the show form of this command to display action settings for this rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy community-list list-num rule rule-num description desc
delete policy community-list list-num rule rule-num description
show policy community-list list-num rule rule-num description
Command Mode
Configuration mode.
Configuration Statement
policy {
community-list u32 {
rule u32 {
description: text
}
}
}
Parameters
list-num
rule-num
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for a community list rule.
Use the delete form of this command to remove a community list rule description.
Use the show form of this command to display the description for a community list rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy community-list list-num rule rule-num regex regex
delete policy community-list list-num rule rule-num regex
show policy community-list list-num rule rule-num regex
Command Mode
Configuration mode.
Configuration Statement
policy {
community-list u32 {
rule u32 {
regex: text
}
}
}
Parameters
list-num
rule-num
regex
Default
If no regular expression is defined, all packets are considered to match the rule.
Usage Guidelines
Use the set form of this command to define the match criteria to be used to determine
forwarding policy based on BGP community.
Packets are matched based on whether the communities listed in the packet match the
regular expression defined using this command. Depending on the action defined for the
rule using the policy community-list <list-num> rule <rule-num> action command (see
page 1302), matched packets are either permitted or denied.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Use the delete form of this command to remove the regular expression entry. If no regular
expression is defined, all packets are considered to match the rule.
Use the show form of this command to display the regular expression entry.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy prefix-list list-name
delete policy prefix-list list-name
show policy prefix-list list-name
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {}
}
Parameters
list-name
Default
None.
Usage Guidelines
Use the set form of this command to create a prefix list for use in policy-based routing.
Use the delete form of this command to remove a prefix list.
Use the show form of this command to display prefix list configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy prefix-list list-name description desc
delete policy prefix-list list-name description
show policy prefix-list list-name description
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {
description: text
}
}
Parameters
list-name
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for a prefix list.
Use the delete form of this command to remove a prefix list description.
Use the show form of this command to display the description for a prefix list.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy prefix-list list-name rule rule-num
delete policy prefix-list list-name rule rule-num
show policy prefix-list list-name rule rule-num
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {
rule u32 {}
}
}
Parameters
list-name
rule-num
Default
None.
Usage Guidelines
Use the set form of this command to create a prefix list rule.
Use the delete form of this command to remove a prefix list rule.
Use the show form of this command to display configuration settings for a prefix list rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
130
Syntax
set policy prefix-list list-name rule rule-num action {deny | permit}
delete policy prefix-list list-name rule rule-num action
show policy prefix-list list-name rule rule-num action
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {
rule u32 {
action {
deny
permit
}
}
}
Parameters
list-name
rule-num
deny
permit
Default
Packets matching this rule are forwarded.
Usage Guidelines
Use the set form of this command to define the action taken when received packets satisfy
the match criteria for this rule.
If the action for a rule is deny, packets meeting the match criteria of the rule are silently
dropped. If the action for the rule is permit, destination-based routing is performed; that is,
packets are sent using the normal forwarding channels.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Use the delete form of this command to restore the default action for packets satisfying the
match criteria.
Use the show form of this command to display action settings for this rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Syntax
set policy prefix-list list-name rule rule-num description desc
delete policy prefix-list list-name rule rule-num description
show policy prefix-list list-name rule rule-num description
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {
rule u32 {
description: text
}
}
}
Parameters
list-name
rule-num
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for a prefix list rule.
Use the delete form of this command to remove a prefix list rule description.
Use the show form of this command to display the description for a prefix list rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Syntax
set policy prefix-list list-name rule rule-num ge value
delete policy prefix-list list-name rule rule-num ge
show policy prefix-list list-name rule rule-num ge
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {
rule u32 {
ge: 0-32
}
}
}
Parameters
list-name
rule-num
value
Default
If no prefix is specified, all network prefixes are considered to match the rule.
Usage Guidelines
Use the set form of this command to specify a network prefix for determining routing. The
network prefixes of incoming packets are compared with this value; if the prefix is greater
than or equal to the specified prefix, the rule is matched and the action specified for the rule
is taken.
Exactly one comparison (ge, le, or prefix) may be specified for a prefix list rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Use the delete form of this command to remove the specified ge prefix. If no prefix is
specified, all network prefixes are considered to match the rule.
Use the show form of this command to display the value specified as ge prefix.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Syntax
set policy prefix-list list-name rule rule-num le value
delete policy prefix-list list-name rule rule-num le
show policy prefix-list list-name rule rule-num le
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {
rule u32 {
le: 0-32
}
}
}
Parameters
list-name
rule-num
value
Default
If no prefix is specified, all network prefixes are considered to match the rule.
Usage Guidelines
Use the set form of this command to specify a network prefix for determining routing
policy. The network prefixes of incoming packets are compared with this value; if the
prefix is less than or equal to the specified prefix, the rule is matched and the action
specified for the rule is taken.
Exactly one comparison (ge, le, or prefix) may be specified for a prefix list rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Use the delete form of this command to remove the specified le prefix. If no prefix is
specified, all network prefixes are considered to match the rule.
Use the show form of this command to display the value specified as le prefix.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Syntax
set policy prefix-list list-name rule rule-number prefix ipv4net
delete policy prefix-list list-name rule rule-num prefix
show policy prefix-list list-name rule rule-num prefix
Command Mode
Configuration mode.
Configuration Statement
policy {
prefix-list text {
rule u32 {
prefix: ipv4net
}
}
}
Parameters
list-name
rule-num
ipv4net
Default
If no network is specified, all networks are considered to match the rule.
Usage Guidelines
Use the set form of this command to specify a network for determining routing policy. The
network specified in incoming packets are compared with this value; if it exactly matches
the network specified in this command, the rule is matched and the action specified for the
rule is taken.
Exactly one comparison (ge, le, or prefix) may be specified for a prefix list rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Use the delete form of this command to remove the specified ge prefix. If no prefix is
specified, all network prefixes are considered to match the rule.
Use the show form of this command to display the value specified as ge prefix.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Syntax
set policy route-map map-name
delete policy route-map map-name
show policy route-map map-name
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {}
}
Parameters
map-name
Default
None.
Usage Guidelines
Use the set form of this command to create a route map for policy-based routing.
Use the delete form of this command to remove a route map.
Use the show form of this command to display route map configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
131
Syntax
set policy route-map map-name description desc
delete policy route-map map-name description
show policy route-map map-name description
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
description: text
}
}
Parameters
map-name
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for a route map.
Use the delete form of this command to remove a route map policy description.
Use the show form of this command to display the description for a route map.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Syntax
set policy route-map map-name rule rule-num
delete policy route-map map-name rule rule-num
show policy route-map map-name rule rule-num
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {}
}
}
Parameters
map-name
rule-num
Default
None.
Usage Guidelines
Use the set form of this command to create a route map rule.
Use the delete form of this command to remove a route map rule.
Use the show form of this command to display configuration settings for a route map rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Syntax
set policy route-map map-name rule rule-num action {deny | permit}
delete policy route-map map-name rule rule-num action
show policy route-map map-name rule rule-num action
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
action {
deny
permit
}
}
}
}
Parameters
map-name
rule-num
deny
permit
Default
Routes are denied.
Usage Guidelines
Use the set form of this command to define the action taken when received packets satisfy
the match criteria for this rule.
If the action for a rule is deny, packets meeting the match criteria of the rule are silently
dropped. If the action for the rule is permit, destination-based routing is performed; that is,
packets are sent using the normal forwarding channels.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
The default action of a route map is to deny; that is if no entries satisfy the match criteria
the route is denied. To change this behavior, specify an empty permit rule as the last entry
in the route map.
Use the delete form of this command to restore the default action for packets satisfying the
match criteria.
Use the show form of this command to display action settings for this rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Syntax
set policy route-map map-name rule rule-num call target
delete policy route-map map-name rule rule-num call
show policy route-map map-name rule rule-num
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
call: text
}
}
}
Parameters
map-name
rule-num
target
Default
None.
Usage Guidelines
Use the set form of this command to call to another route map.
The new route map is called after all set actions specified in the route map have been
performed. If the called route map returns permit, then the matching and exit policies of
the route map govern further behavior in the normal way. If the called route-map returns
deny, processing of the route map completes and the route is denied, regardless of any
further matching or exit policies.
Use the delete form of this command to remove this statement from the route map.
Use the show form of this command to display route map rule configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Syntax
set policy route-map map-name rule rule-num continue target-num
delete policy route-map map-name rule rule-num continue
show policy route-map map-name rule rule-num continue
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
continue: u32
}
}
}
Parameters
map-name
rule-num
target
Default
None.
Usage Guidelines
Use the set form of this command to call to another rule within the current route map. The
new route map rule is called after all set actions specified in the route map rule have been
performed.
Use the delete form of this command to remove this statement from the route map.
Use the show form of this command to display route map rule configuration settings.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Syntax
set policy route-map map-name rule rule-num description desc
delete policy route-map map-name rule rule-num description
show policy route-map map-name rule rule-num description
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
description: text
}
}
}
Parameters
map-name
rule-num
desc
Default
None.
Usage Guidelines
Use the set form of this command to create a description for a route map rule.
Use the delete form of this command to remove a route map rule description.
Use the show form of this command to display the description for a route map rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Syntax
set policy route-map map-name rule rule-num match as-path list-name
delete policy route-map map-name rule rule-num match as-path
show policy route-map map-name rule rule-num match as-path
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
as-path: text
}
}
}
}
Parameters
map-name
rule-num
list-name
Default
If no AS path match condition is specified, packets are not filtered by AS path.
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
on an AS path list.
Packets are matched based on whether the AS path listed in the route match the AS path
defined by this command. Depending on the action defined for the rule using the policy
route-map <map-name> rule <rule-num> action command (see page 1322), matched
Command Reference
Rel VC4.1 v. 03
Vyatta
132
packets are either permitted or denied. Based on the forwarding information specified by
the set statements in the route map rule, permitted packets are forwarded to their various
destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the AS path match condition.
Use the show form of this command to display AS path match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Syntax
set policy route-map map-name rule rule-num match community {community-list
list-num | exact-match}
delete policy route-map map-name rule rule-num match community
show policy route-map map-name rule rule-num match community
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
community {
community-list: u32
exact-match
}
}
}
}
}
Parameters
map-name
rule-num
community-list
list-num
Matches the BGP communities in the route with those permitted by the
specified community list. The community list policy must already be
defined. Either community-list or exact-match must be specified.
exact-match
Default
If no community list match condition is specified, packets are not filtered by BGP
community.
Command Reference
Rel VC4.1 v. 03
Vyatta
132
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
on BGP communities.
Packets are matched based on whether the BGP communities listed in the route match the
communities defined by this command. Depending on the action defined for the rule using
the policy route-map <map-name> rule <rule-num> action command (see page 1322),
matched packets are either permitted or denied. Based on the forwarding information
specified by the set statements in the route map rule, permitted packets are forwarded to
their various destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the BGP community match condition.
Use the show form of this command to display BGP community match condition
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
133
Syntax
set policy route-map map-name rule rule-num match interface ethx
delete policy route-map map-name rule rule-num match interface
show policy route-map map-name rule rule-num match interface
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
interface: text
}
}
}
}
Parameters
map-name
rule-num
ethx
Default
If no interface match condition is specified, packets are not filtered by interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
133
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
on first-hop interface.
Packets are matched based on whether the first-hop interface of the route matches the
interface specified by this command. Depending on the action defined for the rule using the
policy route-map <map-name> rule <rule-num> action command (see page 1322),
matched packets are either permitted or denied. Based on the forwarding information
specified by the set statements in the route map rule, permitted packets are forwarded to
their various destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the interface match condition.
Use the show form of this command to display interface match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
133
Syntax
set policy route-map map-name rule rule-num match ip address {access-list list-num |
prefix-list list-name}
delete policy route-map map-name rule rule-num match ip address
show policy route-map map-name rule rule-num match ip address
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
ip address {
access-list: u32
prefix-list: text
}
}
}
}
}
}
Parameters
Command Reference
map-name
rule-num
access-list
list-num
prefix-list
list-name
Rel VC4.1 v. 03
Vyatta
133
Default
If no IP address match condition is specified, packets are not filtered by IP address.
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
on IP address.
Packets are matched based on whether the source or destination IP address of the route
matches an address contained in the specified access list or prefix list. Depending on the
action defined for the rule using the policy route-map <map-name> rule <rule-num>
action command (see page 1322), matched packets are either permitted or denied. Based
on the forwarding information specified by the set statements in the route map rule,
permitted packets are forwarded to their various destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the IP address match condition.
Use the show form of this command to display IP address match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
133
Syntax
set policy route-map map-name rule rule-num match ip nexthop {access-list list-num |
prefix-list list-name}
delete policy route-map map-name rule rule-num match ip nexthop
show policy route-map map-name rule rule-num match ip nexthop
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
ip {
nexthop {
access-list: u32
prefix-list: text
}
}
}
}
}
}
Parameters
Command Reference
map-name
rule-num
access-list list-num
Rel VC4.1 v. 03
Vyatta
133
prefix-list list-name
Default
If no next-hop match condition is specified, packets are not filtered by next hop.
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
on next-hop IP address.
Packets are matched based on whether the next-hop IP address of the route matches an
address contained in the specified access list or prefix list. Depending on the action defined
for the rule using the policy route-map <map-name> rule <rule-num> action command
(see page 1322), matched packets are either permitted or denied. Based on the forwarding
information specified by the set statements in the route map rule, permitted packets are
forwarded to their various destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the next-hop IP address match condition.
Use the show form of this command to display next-hop IP address match condition
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
133
Syntax
set policy route-map map-name rule rule-num match ip route-source {access-list
list-num | prefix-list list-name}
delete policy route-map map-name rule rule-num match ip route-source
show policy route-map map-name rule rule-num match ip route-source
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
ip {
route-source {
access-list: u32
prefix-list: text
}
}
}
}
}
}
Parameters
Command Reference
map-name
rule-num
access-list list-num
prefix-list list-name
Rel VC4.1 v. 03
Vyatta
133
Default
If no route source match condition is specified, packets are not filtered by route source.
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
on the address from where routes are advertised (its route source).
Packets are matched based on whether the route source matches an address contained in the
specified access list or prefix list. Depending on the action defined for the rule using the
policy route-map <map-name> rule <rule-num> action command (see page 1322),
matched packets are either permitted or denied. Based on the forwarding information
specified by the set statements in the route map rule, permitted packets are forwarded to
their various destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the route source match condition.
Use the show form of this command to display route source match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
133
Syntax
set policy route-map map-name rule rule-num match metric metric
delete policy route-map map-name rule rule-num match metric
show policy route-map map-name rule rule-num match metric
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
metric: u32
}
}
}
}
Parameters
map-name
rule-num
metric
Default
If no metric match condition is specified, packets are not filtered by metric.
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
route metric.
Packets are matched based on whether the route metric matches that specified by this
command. Depending on the action defined for the rule using the policy route-map
<map-name> rule <rule-num> action command (see page 1322), matched packets are
Command Reference
Rel VC4.1 v. 03
Vyatta
133
either permitted or denied. Based on the forwarding information specified by the set
statements in the route map rule, permitted packets are forwarded to their various
destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the route source match condition.
Use the show form of this command to display route source match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Syntax
set policy route-map map-name rule rule-num match origin {egp | igp | incomplete}
delete policy route-map map-name rule rule-num match origin
show policy route-map map-name rule rule-num match origin
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
origin {
origin-code: [egp|igp|incomplete]
}
}
}
}
}
Parameters
map-name
rule-num
egp:
igp:
incomplete
Default
If no origin match condition is specified, packets are not filtered by BGP origin code.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
BGP origin.
Packets are matched based on whether the BGP origin code in the route matches that
specified by this command. Depending on the action defined for the rule using the policy
route-map <map-name> rule <rule-num> action command (see page 1322), matched
packets are either permitted or denied. Based on the forwarding information specified by
the set statements in the route map rule, permitted packets are forwarded to their various
destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the origin match condition.
Use the show form of this command to display origin match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Syntax
set policy route-map map-name rule rule-num match peer ipv4
delete policy route-map map-name rule rule-num match peer
show policy route-map map-name rule rule-num match peer
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
peer: ipv4
}
}
}
}
Parameters
map-name
rule-num
ipv4
Default
If no peer address match condition is specified, packets are not filtered by peer IP address.
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
peer IP address.
Packets are matched based on whether the address of the peer in the route matches that
specified by this command. Depending on the action defined for the rule using the policy
route-map <map-name> rule <rule-num> action command (see page 1322), matched
Command Reference
Rel VC4.1 v. 03
Vyatta
134
packets are either permitted or denied. Based on the forwarding information specified by
the set statements in the route map rule, permitted packets are forwarded to their various
destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the peer address match condition.
Use the show form of this command to display peer address match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Syntax
set policy route-map map-name rule rule-num match tag tag
delete policy route-map map-name rule rule-num match tag
show policy route-map map-name rule rule-num match tag
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
match {
tag: u32
}
}
}
}
Parameters
map-name
rule-num
tag
Default
If no tag match condition is specified, packets are not filtered by tag.
Usage Guidelines
Use the set form of this command to define a match condition for a route map policy based
on OSPF tag.
Packets are matched based on whether the value of the OSPF external LSA 32-bit tag field
in the route matches that specified by this command. Depending on the action defined for
the rule using the policy route-map <map-name> rule <rule-num> action command (see
Command Reference
Rel VC4.1 v. 03
Vyatta
134
page 1322), matched packets are either permitted or denied. Based on the forwarding
information specified by the set statements in the route map rule, permitted packets are
forwarded to their various destinations.
If more than one match condition is defined in a route map rule, the packet must match all
conditions to count as a match. If no match condition is defined for the route map rule, all
packets are considered to match the rule.
Use the delete form of this command to remove the OSPF tag match condition.
Use the show form of this command to display OSPF tag match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Syntax
set policy route-map map-name rule rule-num on-match {goto rule-num | next}
delete policy route-map map-name rule rule-num on-match
show policy route-map map-name rule rule-num on-match
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
on-match {
goto: u32
}
}
}
}
Parameters
map-name
rule-num
goto rule-num
The number of a defined route map rule. When all matches listed in
the route map rule succeed, the current route map rule is exited and
this rule is invoked and executed. Note that jumping to a previous
route map rule is not permitted.
next
When all matches listed in the route map rule succeed, the current
route map rule is exited and the next rule in the sequence is invoked
and executed.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Usage Guidelines
Use the set form of this command to define an exit policy for a route map entry, by
specifying the route map rule to be executed when a match occurs. When all the match
conditions specified by the route map rule succeed, the route map rule specified by this
command is invoked and executed.
Normally, when a route map is matched, the route map is exited and the route is permitted.
This command allows you to specify an alternative exit policy, by directing execution to a
specified route map rule or to the next rule in the sequence.
Use the delete form of this command to remove the exit policy.
Use the show form of this command to display route map exit policy configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Syntax
set policy route-map map-name rule rule-num set aggregator {as asn | ip ipv4}
delete policy route-map map-name rule rule-num set aggregator
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
aggregator {
as: 1-65535
ip: ipv4
}
}
}
}
Parameters
map-name
rule-num
as asn
ip ipv4
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
134
Usage Guidelines
Use the set form of this command to modify the aggregator attribute of a route. When all
the match conditions in the route map rule succeed, the aggregator attribute is modified as
specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set as-path-prepend prepend
delete policy route-map map-name rule rule-num set as-path-prepend
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
as-path-prepend: text
}
}
}
}
Parameters
map-name
rule-num
prepend
Default
None.
Usage Guidelines
Use the set form of this command to prepend a string to the AS path list in a route. When
all the match conditions in the route map rule succeed, the specified string is prepended to
the AS path in the route.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set atomic-aggregate
delete policy route-map map-name rule rule-num set atomic-aggregate
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
atomic-aggregate
}
}
}
}
Parameters
map-name
rule-num
Default
None.
Usage Guidelines
Use the set form of this command to set the BGP atomic aggregate attribute in a route.
When all the match conditions in the route map rule succeed, the BGP atomic aggregate
attribute is modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set comm-list {comm-list list-name |
delete}
delete policy route-map map-name rule rule-num set comm-list
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
comm-list {
comm-list: text
delete
}
}
}
}
}
Parameters
map-name
rule-num
comm-list list-name
delete
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Usage Guidelines
Use the set form of this command to modify the BGP community list in a route. When all
the match conditions in the route map rule succeed, the community list is modified as
specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set community {community [additive] |
none}
delete policy route-map map-name rule rule-num set community
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
community: text
}
}
}
}
Parameters
c
map-name
rule-num
community
additive
Default
When the additive keyword is not used, the specified community replaces the existing
communities in the route.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Usage Guidelines
Use the set form of this command to modify the BGP communities attribute in a route.
When all the match conditions in the route map rule succeed, the communities attribute is
modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set ip-next-hop ipv4
delete policy route-map map-name rule rule-num set ip-next-hop
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
ip-next-hop: ipv4
}
}
}
}
Parameters
map-name
rule-num
ip-next-hop ipv4
Default
None.
Usage Guidelines
Use the set form of this command to modify the next hop destination for packets that
traverse a route map. When all the match conditions in the route map rule succeed, the next
hop of the route is modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set local-preference local-pref
delete policy route-map map-name rule rule-num set local-preference
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
local-preference: u32
}
}
}
}
Parameters
map-name
rule-num
local-pref
Default
None.
Usage Guidelines
Use the set form of this command to modify the BGP local-pref attribute for packets that
traverse a route map. When all the match conditions in the route map rule succeed, the
local-pref attribute of the route is modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set metric metric
delete policy route-map map-name rule rule-num set metric
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
metric: text
}
}
}
}
Parameters
map-name
rule-num
metric
Default
None.
Usage Guidelines
Use the set form of this command to modify the route metric for packets that traverse a
route map. When all the match conditions in the route map rule succeed, the route metric
is modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
135
Syntax
set policy route-map map-name rule rule-num set metric-type type
delete policy route-map map-name rule rule-num set metric-type
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
metric-type: [type-1|type-2]
}
}
}
}
Parameters
map-name
rule-num
type-1
OSPF external type 1 metric. This metric uses both internal and external
costs when calculating the cost to access an external network.
type-2
OSPF external type 2 metric. This metric uses only external cost when
calculating the cost to access an external network.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
136
Usage Guidelines
Use this command to specify the metric OSPF should use to calculate the cost of accessing
an external network.
Use the set form of this command to specify the OSPF external metric type for a route.
Use the delete form of this command to delete the metric type.
Use the show form of this command to display the metric type.
Command Reference
Rel VC4.1 v. 03
Vyatta
136
Syntax
set policy route-map map-name rule rule-num set origin {asn | egp | igp | incomplete}
delete policy route-map map-name rule rule-num set origin
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
origin [egp|igp|incomplete]
}
}
}
}
Parameters
map-name
rule-num
asn
egp
igp
incomplete
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
136
Usage Guidelines
Use the set form of this command to set the BGP origin code for packets that traverse a
route map. When all the match conditions in the route map rule succeed, the BGP origin
code is modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
136
Syntax
set policy route-map map-name rule rule-num set originator-id ipv4
delete policy route-map map-name rule rule-num set originator-id
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
originator-id: ipv4
}
}
}
}
Parameters
map-name
rule-num
ipv4
Default
None.
Usage Guidelines
Use the set form of this command to set the BGP originator ID for packets that traverse a
route map. When all the match conditions in the route map rule succeed, the BGP originator
ID is modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
136
Syntax
set policy route-map map-name rule rule-num set tag tag
delete policy route-map map-name rule rule-num set tag
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
tag: u32
}
}
}
}
Parameters
map-name
rule-num
tag
Default
None.
Usage Guidelines
Use the set form of this command to set the OSPF tag value for packets that traverse a route
map. When all the match conditions in the route map rule succeed, the route tag is modified
as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
136
Syntax
set policy route-map map-name rule rule-num set weight weight
delete policy route-map map-name rule rule-num set weight
show policy route-map map-name rule rule-num set
Command Mode
Configuration mode.
Configuration Statement
policy {
route-map text {
rule u32 {
set {
weight: u32
}
}
}
}
Parameters
map-name
rule-num
weight
Default
None.
Usage Guidelines
Use the set form of this command to set the BGP weight for routes. When all the match
conditions in the route map rule succeed, the route weight is modified as specified.
Use the delete form of this command to delete this statement from the route map rule.
Use the show form of this command to display set statement configuration for route maps.
Command Reference
Rel VC4.1 v. 03
Vyatta
136
show ip access-list
show ip access-list
Displays all IP access lists.
Syntax
show ip access-list
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display IP access lists.
Examples
Example 17-1 shows IP access lists.
Example 17-1 show ip access-list: Displaying IP access lists
Command Reference
Rel VC4.1 v. 03
Vyatta
136
show ip as-path-access-list
show ip as-path-access-list
Displays all as-path access lists.
Syntax
show ip as-path-access-list
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display as-path access lists.
Examples
Example 17-2 shows as-path access lists.
Example 17-2 show ip as-path-access-list: Displaying as-path access lists
Command Reference
Rel VC4.1 v. 03
Vyatta
136
show ip community-list
show ip community-list
Displays all IP community lists.
Syntax
show ip community-list
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display community lists.
Examples
Example 17-3 shows community lists.
Example 17-3 show ip community-list: Displaying community lists
Command Reference
Rel VC4.1 v. 03
Vyatta
136
show ip extcommunity-list
show ip extcommunity-list
Displays all extended IP community lists.
Syntax
show ip extcommunity-list
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display extended IP community lists.
Examples
Example 17-4 shows extended IP community lists.
Example 17-4 show ip extcommunity-list: Displaying extended IP community lists
Command Reference
Rel VC4.1 v. 03
Vyatta
137
show ip prefix-list
show ip prefix-list
Displays IP prefix lists.
Syntax
show ip prefix-list [detail | summary | list-name [seq seq-num | ipv4net [first-match |
longer]]]
Command Mode
Operational mode.
Parameters
detail
summary
list-name
seq-num
ipv4net
first-match
Displays the first match from the select prefix of the named IP prefix list.
longer
Displays the longer match of the select prefix from the named IP prefix
list
Default
None.
Usage Guidelines
Use this command to display prefix lists.
Examples
Example 17-5 shows prefix lists.
Example 17-5 show ip prefix-list: Displaying prefix lists
Command Reference
Rel VC4.1 v. 03
Vyatta
137
show ip prefix-list
Command Reference
Rel VC4.1 v. 03
Vyatta
137
show ip protocol
show ip protocol
Displays IP route maps per protocol.
Syntax
show ip protocol
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display IP route maps per protocol.
Examples
Example 17-6 shows IP route maps by protocol.
Example 17-6 show ip protocol: Displaying IP route maps by protocol
Command Reference
Rel VC4.1 v. 03
Vyatta
137
Command Reference
show ip protocol
Rel VC4.1 v. 03
Vyatta
137
show route-map
show route-map
Displays route map information.
Syntax
show route-map [map-name]
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to display route map information.
Examples
Example 17-7 shows route map information.
Example 17-7 show route-map: Displaying route map information
Command Reference
Rel VC4.1 v. 03
Vyatta
137
show route-map
OSPF:
route-map MAP1, permit, sequence 1
Match clauses:
interface eth0
Set clauses:
Call clause:
Action:
Exit routemap
BGP:
route-map MAP1, permit, sequence 1
Match clauses:
Set clauses:
Call clause:
Action:
Exit routemap
vyatta@vyatta:~$
Command Reference
Rel VC4.1 v. 03
Vyatta
137
1377
This chapter lists the commands for defining Quality of Service (QoS) policies to
manage traffic on your networkVyatta system.
This chapter contains the following commands.
Command
Description
137
Command
Description
qos-policy traffic-shaper <policy-name> class <class> priority Specifies the priority of a traffic class for allocation
<priority>
of extra bandwidth.
qos-policy traffic-shaper <policy-name> class <class>
queue-limit <limit>
Command Reference
Rel VC4.1 v. 03
Vyatta
137
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
set interfaces ethernet ethx qos-policy out policy-name
delete interfaces ethernet ethx qos-policy out
show interfaces ethernet ethx qos-policy out
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
qos-policy {
out: text
}
}
}
Parameters
ethx
policy-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Usage Guidelines
Use this command to apply an outbound QoS policy to an interface.
Use the set form of this command to apply the QoS policy to the interface.
Use the delete form of this command to remove the QoS policy from the interface.
Use the show form of this command to display QoS policy configuration for an interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Syntax
set interfaces ethernet ethx vif vlan-id qos-policy out policy-name
delete interfaces ethernet ethx vif vlan-id qos-policy out
show interfaces ethernet ethx vif vlan-id qos-policy out
Command Mode
Configuration mode.
Configuration Statement
interfaces {
ethernet eth0..eth23 {
vif 0-4095 {
qos-policy {
out: text
}
}
}
}
Parameters
ethx
vlan-id
policy-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Usage Guidelines
Use this command to apply an outbound QoS policy to an interface.
Use the set form of this command to apply the QoS policy to the interface.
Use the delete form of this command to remove the QoS policy from the interface.
Use the show form of this command to display QoS policy configuration for an interface.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Syntax
set qos-policy fair-queue policy-name
delete qos-policy fair-queue policy-name
show qos-policy fair-queue policy-name
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
fair-queue text {
}
}
Parameters
policy-name
Default
None.
Usage Guidelines
Use this command to define a fair queue (FQ) QoS policy.
The Vyatta system uses Stochastic Fair Queuing, which is one of a number of FQ
algorithms aiming to provide per-flowbased fairness. The FQ algorithm attempts to
provide fair access to network resources and prevent any one flow from consuming an
inordinate amount of output port bandwidth.
In Stochastic Fair Queuing, bandwidth is divided into separate hash buckets based on the
IP source or destination address such that no single flow receives an unfair portion of
bandwidth.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Syntax
set qos-policy fair-queue policy-name description desc
delete qos-policy fair-queue policy-name description
show qos-policy fair-queue policy-name description
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
fair-queue text {
description: text
}
}
Parameters
policy-name
desc
Default
None.
Usage Guidelines
Use this command to record a description for a fair queue policy.
Use the set form of this command to specify a description.
Use the delete form of this command to remove a description.
Use the show form of this command to display description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Syntax
set qos-policy fair-queue policy-name hash-interval seconds
delete qos-policy fair-queue policy-name hash-interval
show qos-policy fair-queue policy-name hash-interval
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
fair-queue text {
hash-interval: u32
}
}
Parameters
policy-name
seconds
Default
The hash function is never updated.
Usage Guidelines
Use this command to set the interval at which the flow hash function is updated.
Updating the hash function at intervals increases security and prevents attacks based on an
attacker determining the hash bucket for traffic flows and sending spoofed packets based
on that information.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Use the set form of this command to specify a flow hash update interval.
Use the delete form of this command to restore the default hash interval.
Use the show form of this command to display hash interval configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Syntax
set qos-policy fair-queue policy-name queue-limit limit
delete qos-policy fair-queue policy-name queue-limit
show qos-policy fair-queue policy-name queue-limit
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
fair-queue text {
queue-limit: u32
}
}
Parameters
policy-name
limit
Default
A queue is not permitted to exceed 127 packets.
Usage Guidelines
Use this command to set the maximum number of packets that can wait in a queue for this
queuing policy. If maximum queue size is reached, the system begins dropping packets.
Use the set form of this command to set the queue limit.
Use the delete form of this command to restore the default queue limit.
Command Reference
Rel VC4.1 v. 03
Vyatta
138
Use the show form of this command to display queue limit configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Syntax
set qos-policy traffic-shaper policy-name
delete qos-policy traffic-shaper policy-name
show qos-policy traffic-shaper policy-name
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
}
}
Parameters
policy-name
Default
None.
Usage Guidelines
Use this command to define a traffic shaper QoS policy.
The Vyatta system uses a version of the Token Bucket traffic shaping algorithm. The Token
Bucket algorithm places a limit on the average traffic transmission rate, but allows
controlled bursting on the network. The Token Bucket algorithm provides the ability to
control bandwidth for VoIP, or limit bandwidth consumption for peer-to-peer applications.
In the Token Bucket algorithm, the network administrator determines how many tokens
are required to transmit a given number of bytes. Each flow has a certain number of tokens
in its bucket, and transmitting traffic spends these tokens. If the token bucket is empty,
the flow is not permitted to send packets.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
This method allows a network administrator to control how network resources are
consumed by configuring the appropriate number of tokens for different types of traffic.
This method also allows a flow to burst traffic, provided it has enough tokens in its bucket.
Use the set form of this command to create a traffic shaper QoS policy.
Use the delete form of this command to remove a traffic shaper QoS policy.
Use the show form of this command to display traffic shaper QoS policy configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Syntax
set qos-policy traffic-shaper policy-name bandwidth [auto | rate | rate-suffix]
delete qos-policy traffic-shaper policy-name bandwidth
show qos-policy traffic-shaper policy-name bandwidth
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
bandwidth: text
}
}
Parameters
policy-name
auto
rate
rate-suffix
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Default
The default is auto.
Usage Guidelines
Use this command to set bandwidth constraints for a traffic shaper QoS policy. This is the
maximum bandwidth available for all classes.
Use the set form of this command to specify bandwidth constraints for the policy.
Use the delete form of this command to restore default bandwidth constraints for the policy.
Use the show form of this command to display policy bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Syntax
set qos-policy traffic-shaper policy-name class class
delete qos-policy traffic-shaper policy-name class class
show qos-policy traffic-shaper policy-name class class
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
}
}
}
Parameters
policy-name
class
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Usage Guidelines
Use this command to define a traffic class for a traffic shaper QoS policy. This allows
packets to be grouped into various traffic classes, which can be treated with different levels
of service.
Use the set form of this command to create a traffic class in a traffic shaper QoS policy.
Use the delete form of this command to remove a traffic class from a traffic shaper QoS
policy.
Use the show form of this command to display traffic class configuration within a traffic
shaper QoS policy.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Syntax
set qos-policy traffic-shaper policy-name class class bandwidth [rate | rate-pct |
rate-suffix]
delete qos-policy traffic-shaper policy-name class class bandwidth
show qos-policy traffic-shaper policy-name class class bandwidth
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
bandwidth: text
}
}
}
Parameters
Command Reference
policy-name
class
rate
rate-pct
Rel VC4.1 v. 03
Vyatta
139
rate-suffix
Default
100% bandwidth usage is available.
Usage Guidelines
Use this command to set a base level of guaranteed bandwidth for a traffic class.
Use the set form of this command to set the available bandwidth for the traffic class.
Use the delete form of this command to restore the default available bandwidth for the
traffic class.
Use the show form of this command to display class bandwidth configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Syntax
set qos-policy traffic-shaper policy-name class class burst [num | num-suffix]
delete qos-policy traffic-shaper policy-name class class burst
show qos-policy traffic-shaper policy-name class class burst
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
burst: text
}
}
}
Parameters
policy-name
class
num
num-suffix
Command Reference
Rel VC4.1 v. 03
Vyatta
139
Default
The burst size is 15 kilobits per second.
Usage Guidelines
Use this command to set the burst size for the traffic class. This is the maximum amount of
traffic that may be sent at a given time.
Use the set form of this command to specify the burst size for a traffic class.
Use the delete form of this command to restore the default burst size for a traffic class.
Use the show form of this command to display traffic class burst size configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Syntax
set qos-policy traffic-shaper policy-name class class ceiling [rate | rate-pct | rate-suffix]
delete qos-policy traffic-shaper policy-name class class ceiling
show qos-policy traffic-shaper policy-name class class ceiling
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
ceiling: text
}
}
}
Parameters
policy-name
class
rate
rate-pct
rate-suffix
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Default
The default is 100%.
Usage Guidelines
Use this command to set the maximum amount of bandwidth a traffic class may consume
when excess bandwidth is available.
Use the set form of this command to set the bandwidth ceiling for a traffic class.
Use the delete form of this command to restore the default bandwidth ceiling for a traffic
class.
Use the show form of this command to display traffic class bandwidth ceiling
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Syntax
set qos-policy traffic-shaper policy-name class class description desc
delete qos-policy traffic-shaper policy-name class class description
show qos-policy traffic-shaper policy-name class class description
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
description: text
}
}
}
Parameters
policy-name
class
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Usage Guidelines
Use this command to record a description for a traffic class.
Use the set form of this command to specify a description.
Use the delete form of this command to remove a description.
Use the show form of this command to display description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Chapter 18: Quality of Service Policies qos-policy traffic-shaper <policy-name> class <class> match <match-name>
Syntax
set qos-policy traffic-shaper policy-name class class match match-name
delete qos-policy traffic-shaper policy-name class class match match-name
show qos-policy traffic-shaper policy-name class class match match-name
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
}
}
}
}
Parameters
policy-name
class
match-name
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Chapter 18: Quality of Service Policies qos-policy traffic-shaper <policy-name> class <class> match <match-name>
Usage Guidelines
Use this command to define a rule setting out the match conditions for membership in a
traffic class.
Use the set form of this comm and to create the traffic class matching rule. Note that you
cannot use set to change the name of an existing traffic class matching rule. To change the
rule, delete it and re-create it.
Use the delete form of this command to remove the traffic class matching rule
configuration node.
Use the show form of this command to display traffic class matching rule configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Chapter 18: Quality of Service Policies qos-policy traffic-shaper <policy-name> class <class> match <match-name>
Syntax
set qos-policy traffic-shaper policy-name class class match match-name description
desc
delete qos-policy traffic-shaper policy-name class class match match-name description
show qos-policy traffic-shaper policy-name class class match match-name description
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
description: text
}
}
}
}
Parameters
policy-name
class
match-name
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Chapter 18: Quality of Service Policies qos-policy traffic-shaper <policy-name> class <class> match <match-name>
Usage Guidelines
Use this command to record a description for a traffic class matching rule.
Use the set form of this command to set the description.
Use the delete form of this command to remove the description.
Use the show form of this command to display description configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Chapter 18: Quality of Service Policies qos-policy traffic-shaper <policy-name> class <class> match <match-name>
Syntax
set qos-policy traffic-shaper policy-name class class match match-name interface
interface
delete qos-policy traffic-shaper policy-name class class match match-name interface
show qos-policy traffic-shaper policy-name class class match match-name interface
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
interface: text
}
}
}
}
Parameters
he n
policy-name
class
match-name
interface
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
140
Chapter 18: Quality of Service Policies qos-policy traffic-shaper <policy-name> class <class> match <match-name>
Usage Guidelines
Use this command to set a match condition for a traffic class based on incoming interface.
If incoming packets ingress through the interface specified by this command, the traffic is
a member of this traffic class (provided other match conditions are satisfied).
Use the set form of this command to specify an interface to be matched by incoming
packets.
Use the delete form of this command to remove the match interface.
Use the show form of this command to display interface match configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
Syntax
set qos-policy traffic-shaper policy-name class class match match-name ip destination
{address ipv4 | port port}
delete qos-policy traffic-shaper policy-name class class match match-name ip
destination [address | port]
show qos-policy traffic-shaper policy-name class class match match-name ip
destination
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
ip {
destination {
address: ipv4
port: text
}
}
}
}
}
}
Parameters
Command Reference
policy-name
class
match-name
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
ipv4
port
Default
If not set, packets are not matched against destination information.
Usage Guidelines
Use this command to define a match condition based on destination address and/or port for
a traffic class.
You can match packets based on a destination represented by either or both of IP address
and destination port(s).
Use the set form of this command to specify a destination to be matched.
Use the delete form of this command to remove destination as a match condition.
Use the show form of this command to display destination match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
Syntax
set qos-policy traffic-shaper policy-name class class match match-name ip dscp value
delete qos-policy traffic-shaper policy-name class class match match-name ip dscp
show qos-policy traffic-shaper policy-name class class match match-name ip dscp
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
ip {
dscp: text
}
}
}
}
}
Parameters
Command Reference
policy-name
class
match-name
value
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
Default
If not set, packets are not matched against DSCP value.
Usage Guidelines
Use this command to define a match condition based on the Differentiated Services Code
Point (DSCP) field.
The DSCP field is a 6-bit field in the Type of Service (ToS) byte of the IP header. It
provides a way of marking packets in order to allow classification of traffic into service
classes, and traffic conditioning such as metering, policing, and shaping.
Use the set form of this command to set a match condition based on DSCP value.
Use the delete form of this command to remove DSCP as a match condition.
Use the show form of this command to display DSCP value configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
Syntax
set qos-policy traffic-shaper policy-name class class match match-name ip protocol
proto
delete qos-policy traffic-shaper policy-name class class match match-name ip protocol
show qos-policy traffic-shaper policy-name class class match match-name ip protocol
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
ip {
protocol: text
}
}
}
}
}
Parameters
Command Reference
policy-name
class
match-name
proto
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
Default
If not set, packets are not matched against IP protocol.
Usage Guidelines
Use this command to define a match condition for a traffic class based on protocol.
Use the set form of this command to set a match condition based on protocol.
Use the delete form of this command to remove protocol value as a match condition.
Use the show form of this command to match condition protocol configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
Syntax
set qos-policy traffic-shaper policy-name class class match match-name ip source
{address ipv4 | port port}
delete qos-policy traffic-shaper policy-name class class match match-name ip source
{address | port}
show qos-policy traffic-shaper policy-name class class match match-name ip source
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
ip {
source {
}
}
}
}
}
}
Parameters
Command Reference
policy-name
class
match-name
ipv4
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> ip
port
The source port to match for this rule. The port may be specified as a
lower-case name (for example ssh) or as a number. The range for port
numbers is 0 to 65535.
Default
If not set, packets are not matched against IP source information.
Usage Guidelines
Use this command to define a match condition based on source address and/or port for a
traffic class.
You can match packets based on a source represented by either or both of IP address and
destination port(s).
Use the set form of this command to specify a source to be matched.
Use the delete form of this command to remove source as a match condition.
Use the show form of this command to display source match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> vif
Syntax
set qos-policy traffic-shaper policy-name class class match match-name vif vlan-id
delete qos-policy traffic-shaper policy-name class class match match-name vif
show qos-policy traffic-shaper policy-name class class match match-name vif
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
match text {
vif: 1-4096
}
}
}
}
Parameters
policy-name
class
match-name
vlan-id
Default
If not set, packets are not matched against VLAN ID.
Command Reference
Rel VC4.1 v. 03
Vyatta
141
Chapter 18: Quality of Service Policiesqos-policy traffic-shaper <policy-name> class <class> match <match-name> vif
Usage Guidelines
Use this command to define a match condition based on VLAN ID for a traffic class.
Use the set form of this command to specify a VLAN ID to be matched.
Use the delete form of this command to remove VLAN ID as a match condition.
Use the show form of this command to display VLAN ID match condition configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Syntax
set qos-policy traffic-shaper policy-name class class priority priority
delete qos-policy traffic-shaper policy-name class class priority
show qos-policy traffic-shaper policy-name class class priority
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
priority: u32
}
}
}
Parameters
policy-name
class
priority
The priority with which this traffic class should be allocated extra
bandwidth. The range is 1 to 1000, where the higher the number the
lower the priority. The default is 1000.
Default
Traffic classes are assigned a priority of 1000.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Usage Guidelines
Use this command to set the priority with which a traffic class is to be awarded extra
bandwidth when excess is available.
Use the set form of this command to specify priority for a traffic class.
Use the delete form of this command to restore the default priority for a traffic class.
Use the show form of this command to display traffic class priority configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Syntax
set qos-policy traffic-shaper policy-name class class queue-limit limit
delete qos-policy traffic-shaper policy-name class class queue-limit
show qos-policy traffic-shaper policy-name class class queue-limit
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
queue-limit: u32
}
}
}
Parameters
policy-name
class
limit
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Usage Guidelines
Use this command to set the maximum queue size (in packets) for a traffic class.
Use the set form of this command to specify the queue limit.
Use the delete form of this command to remove queue limit.
Use the show form of this command to display queue limit configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Syntax
set qos-policy traffic-shaper policy-name class class queue-type type
delete qos-policy traffic-shaper policy-name class class queue-type
show qos-policy traffic-shaper policy-name class class queue-type
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
queue-type: [fair-queue|drop-tail|priority|random-detect]
}
}
}
Parameters
policy-name
class
type
Default
The default is fair-queue.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Usage Guidelines
Use this command to set the type of queuing mechanism to use for a traffic class.
Use the set form of this command to specify the queue type.
Use the delete form of this command to restore the default queue type.
Use the show form of this command to display queue type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Syntax
set qos-policy traffic-shaper policy-name class class set-dscp value
delete qos-policy traffic-shaper policy-name class class set-dscp
show qos-policy traffic-shaper policy-name class class set-dscp
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
class 2-65535 {
set-dscp: text
}
}
}
Parameters
policy-name
class
value
The value to write into the DSCP field of packets in this traffic class. The
DSCP value can be specified as a decimal number (for example, 12), as
a hexidecimal number (for example 0x1D), or as a standard name from
/etc/iproute2/rt_dsfield (for example, lowdelay). By default, the DSCP
field is not rewritten.
Default
If not set, the DSCP byte is not rewritten.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Usage Guidelines
Use this command to direct the system to rewrite the Differentiated Services Code Point
(DSCP) field of packets in a traffic class to a specific value.
Rewriting the DSCP field can be a way to specify forwarding behavior of a network for
packets to allow classification of traffic into service classes, and traffic conditioning such
as metering, policing, and shaping.
The following table shows the standard semantics for DSCP values, as specified by RFC
2474.
Table 18-1
Binary
Value
Configured
Value
Drop
Rate
Meaning
101 110
46
N/A
000 000
N/A
001 010
10
Low
001 100
12
Medium
001 110
14
High
010 010
18
Low
010 100
20
Medium
010 110
22
High
011 010
26
Low
011 100
28
Medium
011 110
30
High
100 010
34
Low
100 100
36
Medium
100 110
38
High
Use the set form of this command to rewrite DSCP values of packets in a traffic class.
Use the delete form of this command to stop DSCP values from being rewritten.
Use the show form of this command to display DSCP rewrite configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Syntax
set qos-policy traffic-shaper policy-name default
delete qos-policy traffic-shaper policy-name default
show qos-policy traffic-shaper policy-name default
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
}
}
}
Parameters
policy-name
Default
None.
Usage Guidelines
Use this command to define a default traffic shaping policy. This policy will be applied to
all traffic that does not match any other defined class.
Use the set form of this command to create the default class configuration node.
Use the delete form of this command to remove the default class configuration node.
Use the show form of this command to display the default class configuration node.
Command Reference
Rel VC4.1 v. 03
Vyatta
142
Syntax
set qos-policy traffic-shaper policy-name default bandwidth [rate | rate-pct | rate-suffix]
delete qos-policy traffic-shaper policy-name default bandwidth
show qos-policy traffic-shaper policy-name default bandwidth
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
bandwidth: text
}
}
}
Parameters
Command Reference
policy-name
rate
Bandwidth in kbps.
rate-pct
Rel VC4.1 v. 03
Vyatta
143
rate-suffix
Default
100% bandwidth usage is available.
Usage Guidelines
Use this command to set a base level of guaranteed bandwidth for the default traffic class.
Use the set form of this command to set the available bandwidth for the default traffic class.
Use the delete form of this command to restore the default available bandwidth for the
default traffic class.
Use the show form of this command to display bandwidth configuration for the default
traffic class.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Syntax
set qos-policy traffic-shaper policy-name default burst [num | num-suffix]
delete qos-policy traffic-shaper policy-name default burst
show qos-policy traffic-shaper policy-name default burst
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
burst: text
}
}
}
Parameters
policy-name
num
num-suffix
Default
The burst size is 15 kilobits per second.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Usage Guidelines
Use this command to set the burst size for the default traffic class. This is the maximum
amount of traffic that may be sent at a given time.
Use the set form of this command to specify the burst size for the default traffic class.
Use the delete form of this command to restore the default burst size for the default traffic
class.
Use the show form of this command to display burst size configuration for the default
traffic class.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Syntax
set qos-policy traffic-shaper policy-name default ceiling [rate | rate-pct | rate-suffix]
delete qos-policy traffic-shaper policy-name default ceiling
show qos-policy traffic-shaper policy-name default ceiling
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
ceiling: text
}
}
}
Parameters
policy-name
rate
rate-pct
rate-suffix
Default
The default is 100%.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Usage Guidelines
Use this command to set the maximum amount of bandwidth the default traffic class may
consume when excess bandwidth is available.
Use the set form of this command to set the bandwidth ceiling for the default traffic class.
Use the delete form of this command to restore the default bandwidth ceiling for the default
traffic class.
Use the show form of this command to display bandwidth ceiling configuration for the
default traffic class.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Syntax
set qos-policy traffic-shaper policy-name default priority priority
delete qos-policy traffic-shaper policy-name default priority
show qos-policy traffic-shaper policy-name default priority
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
priority: 1-1000
}
}
}
Parameters
policy-name
priority
The priority with which this traffic class should be allocated extra
bandwidth. The range is 1 to 1000, where the higher the number the
lower the priority. The default is 1000.
Default
The default class is assigned a value of 1000.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Usage Guidelines
Use this command to set the priority with which the default traffic class is to be awarded
extra bandwidth when excess is available.
Use the set form of this command to specify priority for the default traffic class.
Use the delete form of this command to restore the default priority for the default traffic
class.
Use the show form of this command to display priority configuration for the default traffic
class.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Syntax
set qos-policy traffic-shaper policy-name default queue-limit limit
delete qos-policy traffic-shaper policy-name default queue-limit
show qos-policy traffic-shaper policy-name default queue-limit
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
queue-limit: u32
}
}
}
Parameters
policy-name
limit
Default
None.
Usage Guidelines
Use this command to set the maximum queue size (in packets) for the default class.
Use the set form of this command to specify the queue limit.
Use the delete form of this command to remove queue limit.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Use the show form of this command to display queue limit configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
143
Syntax
set qos-policy traffic-shaper policy-name default queue-type type
delete qos-policy traffic-shaper policy-name default queue-type
show qos-policy traffic-shaper policy-name default queue-type
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
queue-type: [fair-queue|drop-tail|priority|random-detect]
}
}
}
Parameters
policy-name
type
Default
The default is fair-queue.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
Usage Guidelines
Use this command to set the type of queuing mechanism to use for the default traffic class.
Use the set form of this command to specify the queue type.
Use the delete form of this command to restore the default queue type.
Use the show form of this command to display queue type configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
Syntax
set qos-policy traffic-shaper policy-name default set-dscp value
delete qos-policy traffic-shaper policy-name default set-dscp
show qos-policy traffic-shaper policy-name default set-dscp
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
default {
set-dscp: text
}
}
}
Parameters
policy-name
value
The value to write into the DSCP field of packets in the default traffic
class. The DSCP value can be specified as a decimal number (for
example, 12), as a hexidecimal number (for example 0x1D), or as a
standard name from /etc/iproute2/rt_dsfield (for example, lowdelay).
By default, the DSCP field is not rewritten.
Default
If not set, the DSCP byte is not rewritten.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
Usage Guidelines
Use this command to direct the system to rewrite the Differentiated Services Code Point
(DSCP) field of packets in the default traffic class to a specific value.
Rewriting the DSCP field can be a way to specify forwarding behavior of a network for
packets to allow classification of traffic into service classes, and traffic conditioning such
as metering, policing, and shaping.
The following table shows the standard semantics for DSCP values, as specified by RFC
2474.
Table 18-2
Binary
Value
Configured
Value
Drop
Rate
Meaning
101 110
46
N/A
000 000
N/A
001 010
10
Low
001 100
12
Medium
001 110
14
High
010 010
18
Low
010 100
20
Medium
010 110
22
High
011 010
26
Low
011 100
28
Medium
011 110
30
High
100 010
34
Low
100 100
36
Medium
100 110
38
High
Use the set form of this command to rewrite DSCP values of packets in the default traffic
class.
Use the delete form of this command to stop DSCP values in the default traffic class from
being rewritten.
Use the show form of this command to display DSCP rewrite configuration for the default
traffic class.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
Syntax
set qos-policy traffic-shaper policy-name description desc
delete qos-policy traffic-shaper policy-name description
show qos-policy traffic-shaper policy-name description
Command Mode
Configuration mode.
Configuration Statement
qos-policy {
traffic-shaper text {
description: text
}
}
Parameters
policy-name
desc
Default
None.
Usage Guidelines
Use this command to record a description for a traffic shaper policy.
Use the set form of this command to specify a description for a traffic shaper policy.
Use the delete form of this command to remove a description from a traffic shaper policy.
Use the show form of this command to display description configuration for a traffic shaper
policy.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
1445
This chapter lists the commands for setting up Network Address Translation
(NAT) on the Vyatta system.
This chapter contains the following commands.
Command
Description
144
Command
Description
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
clear nat counters
Command Mode
Operational mode.
Parameters
None.
Default
None.
Usage Guidelines
Use this command to reset counters for NAT translation rules. Counters are reset for all
rules.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
Command Mode
Operational mode.
Syntax
clear nat translations
Parameters
None.
Default
None.
Usage Guidelines
Use this rule to clear state information associated with all NAT rules.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
service nat
service nat
Enables NAT on the system.
Syntax
set service nat
delete service nat
show service nat
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to enable Network Address Translation (NAT) on the Vyatta system.
Use the set form of this command to create and modify NAT configuration.
Use the delete form of this command to remove NAT configuration and disable NAT on
the system.
Use the show form of this command to view NAT configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
144
Syntax
set service nat rule rule-num
delete service nat rule [rule-num]
show service nat rule [rule-num]
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
}
}
}
Parameters
rule-num
Default
None.
Usage Guidelines
Use this command to specify a NAT rule configuration.
NAT rules are executed in numeric order. Note that the identifier of a NAT rule (its number)
cannot be changed after configuration. To allow insertion of more rules in the future,
choose rule numbers with space between; for example, number your initial rule set 10, 20,
30, 40, and so on.
Use the set form of this command to create or modify a NAT rule.
Use the delete form of this command to remove a NAT rule.
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Use the show form of this command to view NAT rule configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Syntax
set service nat rule rule-num destination [address address | port port]
delete service nat rule rule-num destination [address | port]
show service nat rule rule-num destination [address | port]
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
destination {
address: text
port: text
}
}
}
}
Parameters
rule-num
Command Reference
Rel VC4.1 v. 03
Vyatta
145
address
port
Default
None.
Usage Guidelines
Use this command to specify the destination to match in a NAT rule.
Note that you should take care in using more than one exclusion rule (that is, a rule using
the negation operation (!) in combination. NAT rules are evaluated sequentially, and a
sequence of exclusion rules could result in unexpected behavior.
Use the set form of this command to create a NAT destination.
Use the delete form of this command to remove a NAT destination configuration.
Use the show form of this command to view NAT destination onfiguration.
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Syntax
set service nat rule rule-num exclude
delete service nat rule rule-num exclude
show service nat rule rule-num
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
exclude
}
}
}
Parameters
rule-num
Default
None.
Usage Guidelines
Use this command to specify that packets matching this rule are to be excluded from
address translation. Exclusion can be used in scenarios where certain types of traffic (for
example VPN traffic) should not be translated.
Use the set form of this command to specify that packets matching this rule will be
excluded from NAT.
Use the delete form of this command to remove the configuration
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Syntax
set service nat rule rule-num inbound-interface interface
delete service nat rule rule-num inbound-interface
show service nat rule rule-num inbound-interface
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
inbound-interface: text
}
}
}
Parameters
rule-num
interface
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Usage Guidelines
Use this command to specify the inbound Ethernet or serial interface at which destination
NAT (DNAT) traffic will be received. inbound Ethernet or serial interface. Destination
NAT will be performed on traffic received on this interface.
This command can only be used on destination NAT rules (that is, NAT rules with a type
of destination). It is not applicable to rules with a type of source or masquerade.
Use the set form of this command to specify inbound interface configuration
Use the delete form of this command to remove inbound interface configuration.
Use the show form of this command to view inbound interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Syntax
set service nat rule rule-num inside-address [address address | port port]
delete service nat rule rule-num inside-address [address address | port port]
show service nat rule rule-num inside-address [address address | port port]
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
inside-address {
address: text
port: text
}
}
}
}
Parameters
rule-num
address
Command Reference
Rel VC4.1 v. 03
Vyatta
145
port
Default
None.
Usage Guidelines
Use this command to defines the inside IP address for a destination NAT (DNAT) rule.
Defining an inside address is mandatory for destination rules. Inside address is not used
with source or masquerade rules.
Destination rules ingress from the untrusted to the trusted network. The inside address
defines the IP address of the host on the trusted network. This is the address that will be
substituted for the original destination IP address on packets sent to the system.
Use the set form of this command to create an inside address configuration for a
Destination NAT (DNAT) rule.
Use the delete form of this command to remove the configuration.
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
145
Syntax
set service nat rule rule-num outbound-interface interface
delete service nat rule rule-num outbound-interface
show service nat rule rule-num outbound-interface
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
outbound-interface: text
}
}
}
Parameters
rule-num
interface
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Default
None.
Usage Guidelines
Use this command to specify the outbound serial or Ethernet interface from which Source
NAT (SNAT) or masquerade traffic is to be transmitted. Source NAT (SNAT) or
masquerade will be performed on traffic transmitted from this interface.
Configuring an outbound interface is optional for source rules and mandatory for
masquerade rules. Outbound address cannot be configured for destination rules.
Use the set form of this command to specify the outbound interface.
Use the delete form of this command to remove outbound interface configuration.
Use the show form of this command to view outbound interface configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Syntax
set service nat rule rule-num outside-address [address address | port port]
delete service nat rule rule-num outside-address [address | port]
show service nat rule rule-num outside-address [address | port]
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
outside-address {
address: text
port: text
}
}
}
}
Parameters
rule-num
address
Command Reference
Rel VC4.1 v. 03
Vyatta
146
port
Default
None.
Usage Guidelines
Use this command to set the outside IP address for a source NAT (SNAT) rule.
Setting the outside address is mandatory for source NAT rules. Setting the outside address
is not allowed with destination NAT rules or masquerade rules; for masquerade rules,
the primary address of the interface is always used.
Use the set form of this command to create an outside address configuration for a Source
NAT (SNAT) rule.
Use the delete form of this command to remove the configuration.
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Syntax
set service nat rule rule-num protocol protocol
delete service nat rule rule-num protocol
show service nat rule rule-num protocol
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
protocol: text
}
}
}
Parameters
rule-num
protocol
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Usage Guidelines
Use this command to specify the protocol(s) on which to perform NAT.
Note that you should take care in using more than one exclusion rule (that is, a rule using
the negation operation (!) in combination. NAT rules are evaluated sequentially, and a
sequence of exclusion rules could result in unexpected behavior.
Use the set form of this command to specify the protocol(s) on which to perform NAT.
Use the delete form of this command to remove the configuration
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Syntax
set service nat rule rule-num source [address address | port port]
delete service nat rule rule-num source [address | port]
show service nat rule rule-num source [address | port]
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
source {
address: text
port: text
}
}
}
}
Parameters
rule-num
Command Reference
Rel VC4.1 v. 03
Vyatta
146
address
port
Default
None.
Usage Guidelines
Use this command to specify the source to match in a NAT rule.
Note that you should take care in using more than one exclusion rule (that is, a rule using
the negation operation (!) in combination. NAT rules are evaluated sequentially, and a
sequence of exclusion rules could result in unexpected behavior.
Use the set form of this command to create a NAT source.
Use the delete form of this command to remove a NAT source.
Use the show form of this command to view NAT source configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Syntax
set service nat rule rule-num type type
delete service nat rule rule-num type
show service nat rule rule-num type
Command Mode
Configuration mode.
Configuration Statement
service {
nat {
rule 1-1024 {
type: [source|destination|masquerade]
}
}
}
Parameters
rule-num
type
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Default
None.
Usage Guidelines
Use this command to specify whether the rule is translating the source or destination IP
address.
You must create explicit NAT rules for each direction of traffic. For example, if you
configure a one-to-one source NAT rule and you want inbound traffic to match the NAT
rule, you must explicitly create a matching destination NAT rule.
Source rules egress from the trusted to the untrusted network. For source NAT rules, the
outside address defines the IP address that faces the untrusted network. This is the address
that will be substituted in for the original source IP address in packets egressing to the
An outside address is not required for rules with a type of masquerade, because for
masquerade rules the original source IP address is replaced with the IP address of the
outbound interface. In fact, if you configure a NAT rule with a type of masquerade, you
cannot define the outside IP address, because the system uses the primary address of the
outbound interface. If you want to use one of the other IP addresses you have assigned to
the interface, change the type from masquerade to source. Then you will be able to define
an outside address.
outbound address:Optional for source rules; mandatory for masquerade rules. Not
configurable for destination rules. The outbound Ethernet or serial interface. Source NAT
(SNAT) or masquerade will be performed on traffic transmitted from this interface.
Use the set form of this command to specify whether the rule is translating the source or
destination IP address.
Use the delete form of this command to remove the configuration
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
146
Syntax
show nat rules
Command Mode
Operational mode.
Parameters
None.
Usage Guidelines
Use this command to display the NAT rules you have configured. You can use this
command for troubleshooting, to confirm whether traffic is matching the NAT rules as
expected.
Command Reference
Rel VC4.1 v. 03
Vyatta
147
Syntax
show nat statistics
Command Mode
Operational mode.
Parameters
None.
Usage Guidelines
Use this command to display current statistics for NAT.
Command Reference
Rel VC4.1 v. 03
Vyatta
147
1472
147
Command
Description
Configuration Commands
system syslog
Operational Commands
delete log file
show log
Command Reference
Rel VC4.1 v. 03
Vyatta
Syntax
delete log file file-name
Command Mode
Operational mode.
Parameters
file-name
Usage Guidelines
Use this command to delete a log file.
Log files are created in the /var/log directory. When you issue this command, the specified
file and all associated archive files are deleted from this directory.
Note that deleting the log file does not stop the system from logging events. If you use this
command while the system is logging events, old log events will be deleted, but events after
the delete operation will be recorded in the new file. To delete the file altogether, first
disable logging to the file using the show log tail command (see page 1477), and then
delete it.
Command Reference
Rel VC4.1 v. 03
Vyatta
147
show log
show log
Displays the contents of the specified log file.
Syntax
show log [all | file file-name]
Command Mode
Operational mode.
Parameters
all
file file-name
Usage Guidelines
Use this command to view the contents of a log file or files.
When used with no option, this command displays the contents of the main system log,
which is the default log to which the system writes syslog messages.
When the file file-name is specified, this command displays the contents of the specified
user-defined log file.
Command Reference
Rel VC4.1 v. 03
Vyatta
147
Syntax
show log directory
Command Mode
Operational mode.
Parameters
None.
Usage Guidelines
Use this command to list the log files that have been defined by system users.
The directory displayed is the directory where user-defined log files are stored. Syslog
messages can be written to these or to the main system log file. User-specified log files are
defined using the system syslog file <filename> facility <facility> level <level>
command (see page 1485).
Command Reference
Rel VC4.1 v. 03
Vyatta
147
Syntax
show log tail [lines]
Command Mode
Operational mode.
Parameters
lines
Usage Guidelines
Use this command to display the last lines of the messages file..
When used with no option, the last ten lines are displayed and then will continue to display
the messages as they are added to the file.
When the lines is specified, the last lines lines of the messages file are displayed.
Command Reference
Rel VC4.1 v. 03
Vyatta
147
system syslog
system syslog
Configures the systems syslog utility.
Syntax
set system syslog
delete system syslog
show system syslog
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to configure the systems syslog utility.
Using this command, you can set the destinations for log messages from different routing
components (facilities) and specify what severity of message should be reported for each
facility.
Log messages generated by the Vyatta system will be associated with one of the following
levels of severity.
Table 20-1 Syslog message severities
Command Reference
Severity
Meaning
emerg
alert
Rel VC4.1 v. 03
Vyatta
147
system syslog
err
warning
notice
info
debug
The Vyatta system supports standard syslog facilities. These are as follows:
Table 20-2 Syslog facilities
Command Reference
Facility
Description
auth
authpriv
Non-system authorization
cron
Cron daemon
daemon
System daemons
kern
Kernel
lpr
Mail subsystem
mark
Timestamp
news
USENET subsystem
security
Security subsystem
syslog
System logging
user
Application processes
uucp
UUCP subsystem
Rel VC4.1 v. 03
Vyatta
147
system syslog
Local facility 0
local1
Local facility 1
local2
Local facility 2
local3
Local facility 3
local4
Local facility 4
local5
Local facility 5
local6
Local facility 6
local7
Local facility 7
all
Messages are written either to the main log file (the default) or to a file that you specify.
User-defined log files are written to the /var/log/user directory, under the user-specified
file name.
The system uses standard UNIX log rotation to prevent the file system from filling up with
log files. When log messages are written to a file, the system will write up to 500 KB of log
messages into the file logfile, where logfile is either the main log file or a name you have
assigned to a user-defined file. When logfile reaches its maximum size, the system closes
it and compresses it into an archive file. The archive file is named logfile.0.gz.
At this point, the logging utility opens a new logfile file and begins to write system
messages to it. When the new log file is full, the first archive file is renamed logfile.1.gz
and the new archive file is named logfile.0.gz.
The system archives log files in this way until a maximum number of log files exists. By
default, the maximum number of archived files is 10 (that is, up to logfile.9.gz), where
logfile.0.gz always represents the most recent file. After this, the oldest log archive file is
deleted as it is overwritten by the next oldest file.
To change the properties of log file archiving, configure the system syslog archive node:
Use the size parameter to specify the maximum size of each archived log file.
Use the files parameter to specify the maximum number of archive files to be
maintained.
Use the set form of this command to create the syslog configuration.
Use the delete form of this command to remove the syslog configuration.
Use the show form of this command to view the syslog configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Syntax
set system syslog console facility facility level level
delete system syslog console facility [facility [level]]
show system syslog console facility [facility [level]]
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
console {
facility text {
level: text
}
}
}
}
Parameters
facility
level
Default
None.
Usage Guidelines
Use this command to specify which messages are sent to the console.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Use the set form of this command to specify which messages are sent to the console.
Use the delete form of this command to restore the default console message configuration.
Use the show form of this command to view the console message configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Syntax
set system syslog file filename archive {files files | size size}
delete system syslog file filename archive {files | size}
show system syslog file filename archive {files | size}
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
file text{
archive {
files: u32
size: u32
}
}
}
}
Parameters
filename
files
Sets the maximum number of archive files that will be maintained for
this log file. After the maximum has been reached, logs will be rotated
with the oldest file overwritten. The default is 10.
size
Sets the maximum size in bytes of archive files for this log file. After the
maximum has been reached, the file will be closed and archived in
compressed format. The default is 1 MB.
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Usage Guidelines
Use this command to specify the settings for log file archiving of the user-defined log file.
Use the set form of this command to specify the settings for log file archiving of the
user-defined log file.
Use the delete form of this command to restore the default user-defined log file archiving
configuration.
Use the show form of this command to view the user-defined log file archiving
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Syntax
set system syslog file filename facility facility level level
delete system syslog file filename facility [facility [level]]
show system syslog file filename facility [facility [level]]
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
file text {
facility text {
level: text
}
}
}
}
Parameters
filename
facility
Command Reference
Rel VC4.1 v. 03
Vyatta
148
level
The Vyatta system supports sending log messages to the main system log file, to the
console, to a remote host, to a user-specified file, or to a user account.
Default
None.
Usage Guidelines
Use this command to specify which messages are sent to the user-defined log file.
Use the set form of this command to specify which messages are sent to the user-defined
log file.
Use the delete form of this command to restore the default user-defined log file message
configuration.
Use the show form of this command to view the user-defined log file message
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Syntax
set system syslog global archive {files files | size size}
delete system syslog global archive {files | size}
show system syslog global archive {files | size}
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
global {
archive {
files: u32
size: u32
}
}
}
}
Parameters
files
Sets the maximum number of archive files that will be maintained for
the main system log file. After the maximum has been reached, logs will
be rotated with the oldest file overwritten. The default is 10.
size
Sets the maximum size in bytes of archive files for the main system log
file. After the maximum has been reached, the file will be closed and
archived in compressed format. The default is 1 MB.
Default
None.
Usage Guidelines
Use this command to specify the settings for log file archiving of the main system log file.
Use the set form of this command to specify the settings for log file archiving of the main
system log file.
Use the delete form of this command to restore the default log file archiving configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Use the show form of this command to view the log file archiving configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Syntax
set system syslog global facility facility level level
delete system syslog global facility [facility [level]]
show system syslog global facility [facility [level]]
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
global {
facility text {
level: text
}
}
}
}
Parameters
facility
Multi-node. The kinds of messages that will be sent to the main system
log file. Please see the Usage Guidelines in the system syslog command
(see page 1478) for supported facilities.
You can send the log messages of multiple facilities to the main system
log file by creating multiple facility configuration nodes within the
global node.
level
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
148
Usage Guidelines
Use this command to specify which messages are sent to the main system log file.
Use the set form of this command to specify which messages are sent to the main system
log file.
Use the delete form of this command to restore the default log file message configuration.
Use the show form of this command to view the log file message configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
Syntax
set system syslog host hostname facility facility level level
delete system syslog file hostname facility [facility [level]]
show system syslog file hostname facility [facility [level]]
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
host text {
facility text {
level: text
}
}
}
}
Parameters
hostname
Multi-node. Sends the specified log messages to a host. The host must
be running the syslog protocol. The hostname can be an IP addresse or
a host name. Host names can include numbers, letters, and hyphens
(-).
You can send log messages to multiple hosts by creating multiple host
configuration nodes.
facility
Multi-node. The kinds of messages that will be sent to the host. Please
see the Usage Guidelines in the system syslog command (see
page 1478) for supported logging facilities.
You can send the log messages of multiple facilities to a host by creating
multiple facility configuration nodes within the host configuration
node.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
level
Default
None.
Usage Guidelines
Use this command to specify which messages are sent to the remote syslog server.
Use the set form of this command to specify which messages are sent to the remote syslog
server.
Use the delete form of this command to restore the default remote syslog server log file
message configuration.
Use the show form of this command to view the remote syslog server log file message
configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
Syntax
set system syslog user userid facility facility level level
delete system syslog user userid facility [facility [level]]
show system syslog user userid facility [facility [level]]
Command Mode
Configuration mode.
Configuration Statement
system {
syslog {
user text {
facility text {
level: text
}
}
}
}
Parameters
userid
facility
Multi-node. The kinds of messages that will be sent to the user. Please
see the Usage Guidelines in the system syslog command (see
page 1478) for supported logging facilities.
You can send the log messages of multiple facilities to a user account by
creating multiple facility configuration nodes within the user
configuration node.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
level
The minimum severity of log message that will be reported to the user.
Supported values are emerg, alert, crit, err, warning, notice, info,
debug. Please see the Usage Guidelines in the system syslog command
(see page 1478) for the meanings of these levels.
By default, messages of err severity are logged to specified users.
Default
None.
Usage Guidelines
Use this command to specify which messages are sent to the specified users terminal.
Use the set form of this command to specify which messages are sent to the specified users
terminal.
Use the delete form of this command to restore the default user terminal message
configuration.
Use the show form of this command to view the user terminal message configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
1495
This chapter lists the commands for setting up the Simple Network Management
Protocol on the Vyatta system.
149
Command
Description
Configuration Commands
protocols snmp
Command Reference
Rel VC4.1 v. 03
Vyatta
protocols snmp
protocols snmp
Defines SNMP community and trap information for the Vyatta system.
Syntax
set protocols snmp
delete protocols snmp
show protocols snmp
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to specify information about which SNMP communities this router
should respond to, about the routers location and contact information, and about
destinations for SNMP traps.
Use the set form of this command to define SNMP settings.
Use the delete form of this command to remove all SNMP configuration.
Use the show form of this command to view SNMP configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
Syntax
set protocols snmp community community
delete protocols snmp community community
show protocols snmp community community
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
community: text
}
}
Parameters
community
Default
By default, no community string is defined.
Usage Guidelines
Use this command to specify an SNMP community.
Use the set form of this command to specify an SNMP community.
Use the delete form of this command to remove an SNMP community configuration.
Use the show form of this command to view an SNMP community configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
149
Syntax
set protocols snmp community community authorization auth
delete protocols snmp community community authorization
show protocols snmp community community authorization
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
community: text
authorization: [ro|rw]
}
}
Parameters
community
auth
Command Reference
Rel VC4.1 v. 03
Vyatta
149
Default
The default authorization privilege is ro.
Usage Guidelines
Use this command to specify the privileges this community will have.
Use the set form of this command to specify SNMP community privileges.
Use the delete form of this command to restore default SNMP community privileges.
Use the show form of this command to view SNMP community privilege configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Syntax
set protocols snmp community community client ipv4
delete protocols snmp community community client ipv4
show protocols snmp community community client
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
community: text
client: ipv4
}
}
Parameters
community
ipv4
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Default
None.
Usage Guidelines
Use this command to specify the SNMP clients in this community that are authorized to
access the system.
Use the set form of this command to specify the SNMP clients in this community that are
authorized to access the system.
Use the delete form of this command to remove SNMP clients in this community that are
authorized to access the system.
Use the show form of this command to view SNMP clients in this community that are
authorized to access the system.
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Syntax
set protocols snmp community community network ipv4net
delete protocols snmp community community network ipv4net
show protocols snmp community community network
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
community: text
network: ipv4net
}
}
Parameters
community
ipv4net
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Default
None.
Usage Guidelines
Use this command to specify a network of SNMP clients in this community that are
authorized to access the server.
Use the set form of this command to specify a network of SNMP clients in this community
that are authorized to access the server.
Use the delete form of this command to remove a network of SNMP clients in this
community that are authorized to access the server.
Use the show form of this command to view a network of SNMP clients in this community
that are authorized to access the server.
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Syntax
set protocols snmp contact contact
delete protocols snmp contact
show protocols snmp contact
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
contact: text
}
}
Parameters
contact
Default
None.
Usage Guidelines
Use this command to specify contact information for the system.
Use the set form of this command to specify contact information for the system.
Use the delete form of this command to remove contact information for the system.
Use the show form of this command to view contact information for the system.
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Syntax
set protocols snmp description desc
delete protocols snmp description
show protocols snmp description
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
description: text
}
}
Parameters
desc
Default
None.
Usage Guidelines
Use this command to specify a brief description of the system.
Use the set form of this command to specify a brief descriptionof the system.
Use the delete form of this command to remove the system description.
Use the show form of this command to view the system description
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Syntax
set protocols snmp location location
delete protocols snmp location
show protocols snmp location
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
description: text
}
}
Parameters
location
Default
None.
Usage Guidelines
Use this command to specify the location of the system.
Use the set form of this command to specify the location of the system.
Use the delete form of this command to remove the system location.
Use the show form of this command to view the system location.
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Syntax
set protocols snmp trap-target ipv4
delete protocols snmp trap-target ipv4
show protocols snmp trap-target
Command Mode
Configuration mode.
Configuration Statement
protocols {
snmp {
trap-target: ipv4
}
}
Parameters
ipv4
Default
None.
Usage Guidelines
Use this command to specify the IP address of the destination for SNMP traps.
Use the set form of this command to specify the IP address of the destination for SNMP
traps.
Use the delete form of this command to remove a trap-target address.
Use the show form of this command to view the trap-target addresses.
Command Reference
Rel VC4.1 v. 03
Vyatta
150
Command Reference
Rel VC4.1 v. 03
Vyatta
150
1510
This chapter lists supported commands that can be used for diagnostics and
debugging.
The UNIX operating system implements a number of commands (such as ping,
traceroute, and so on) that can be used for debugging and diagnostic purposes.
Users with an admin role have access to these (via command mode), but users with
an operator role do not. For operator users, the Vyatta CLI provides an
implementation of certain diagnostic commands in operational mode. This chapter
documents the Vyatta implementation of these commands.
151
Description
Operational Commands
Command Reference
ping <host>
reboot
show tech-support
show version
traceroute <host>
Rel VC4.1 v. 03
Vyatta
ping <host>
ping <host>
Sends ICMP ECHO_REQUEST packets to IPv4 network hosts.
Syntax
ping host
Command Mode
Operational mode
Parameters
host
The host being pinged. Can be specified either as name (if DNS is
being used on the network) or as an IPv4 address.
Usage Guidelines
The ping command is used to test whether a network host is reachable or not.
The ping command uses the ICMP protocols mandatory ECHO_REQUEST datagram to
elicit an ICMP ECHO_RESPONSE from a host or gateway. ECHO_REQUEST datagrams
(pings) have an IP and ICMP header, followed by a struct timeval and then an
arbitrary number of pad bytes used to fill out the packet.
To interrupt the ping command, press <Ctrl>+c.
When using ping for fault isolation, it should first be run on the local host, to verify that the
local network interface is up and running. Then, hosts and gateways further and further
away should be pinged. Round-trip times and packet loss statistics are computed.
If duplicate packets are received, they are not included in the packet loss calculation,
although the round-trip time of these packets is used in calculating the
minimum/average/maximum round-trip time numbers. When the specified number of
packets have been sent (and received) or if the program is terminated, a brief summary is
displayed.
Examples
Example 22-1 shows sample output of the ping command:
Example 22-1 Sample output of ping
vyatta@vyatta:~$ ping 10.3.0.2
PING 10.3.0.2 (10.3.0.2): 56 data bytes
Command Reference
Rel VC4.1 v. 03
Vyatta
151
ping <host>
Command Reference
icmp
icmp
icmp
icmp
seq=0
seq=1
seq=2
seq=3
Rel VC4.1 v. 03
ttl=64
ttl=64
ttl=64
ttl=64
time=0.281
time=0.244
time=0.302
time=0.275
ms
ms
ms
ms
Vyatta
151
traceroute <host>
traceroute <host>
Displays the route packets take to an IPv4 network host.
Syntax
traceroute host
Command Mode
Operational mode
Parameters
host
The host that is the destination for the packets. Can be specified
either as name (if DNS is being used on the network) or as an IPv4
address.
Usage Guidelines
Traceroute utilizes the IP protocol time to live (ttl) field and attempts to elicit an ICMP
TIME_EXCEEDED response from each gateway along the path to some host to track the
route a set of packets follows.It attempts to trace the route an IP packet would follow to
some internet host by launching UDP probe packets with a small ttl then listening for an
ICMP time exceeded reply from a gateway.
Examples
Example 22-2 shows sample output of the traceroute command:
Example 22-2 Sample output of traceroute
vyatta@vyatta:~$ traceroute 10.0.0.30
Command Reference
Rel VC4.1 v. 03
Vyatta
151
1515
This chapter lists commands for using the Vyatta systems software upgrade
mechanism.
This chapter contains the following commands.
Command
Description
Configuration Commands
system package
system package
system package
Specifies the information needed for automatic software updates.
Syntax
set system package
delete system package
show system package
Command Mode
Configuration mode.
Configuration Statement
system {
package {
}
}
Parameters
None.
Default
None.
Usage Guidelines
Use this command to specify the information needed to obtain software updates from the
Vyatta software archive.
Vyatta system packages are stored in the Vyatta software repository. Access to this
repository is available with a support contract.
Use the set form of this command to specify the information needed for automatic software
updates.
Use the delete form of this command to remove the automatic software update
configuration.
Use the show form of this command to view the automatic software update configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
151
Syntax
set system package auto-sync days
delete system package auto-sync
show system package auto-sync
Command Mode
Configuration mode.
Configuration Statement
system {
package {
auto-sync: 1-4294967296
}
}
Parameters
days
Default
The default is 1.
Usage Guidelines
Use this command to specify how often the repository cache should be updated.
Use the set form of this command to specify how often the repository cache should be
updated.
Use the delete form of this command to restore the configuration to the default.
Use the show form of this command to view the configuration.
Command Reference
Rel VC4.1 v. 03
Vyatta
151
Syntax
set system package repository repository
delete system package repository repository
show system package repository repository
Command Mode
Configuration mode.
Configuration Statement
system {
package {
repository text {
}
}
}
Parameters
repository
Default
None.
Usage Guidelines
Use this command to specify the information about the repository
Use the set form of this command to specify the information about the repository
Use the delete form of this command to remove the repository information.
Use the show form of this command to view the repository information.
Command Reference
Rel VC4.1 v. 03
Vyatta
151
Syntax
set system package repository repository components component
delete system package repository repository components component
show system package repository repository components
Command Mode
Configuration mode.
Configuration Statement
system {
package {
repository text {
components: text
}
}
}
Parameters
repository
component
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
151
Usage Guidelines
Use this command to specify a repository component name.
Use the set form of this command to specify a repository component name.
Use the delete form of this command to remove the component name.
Use the show form of this command to view the components.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
Syntax
set system package repository repository description desc
delete system package repository repository description
show system package repository repository description
Command Mode
Configuration mode.
Configuration Statement
system {
package {
repository text {
description: text
}
}
}
Parameters
repository
desc
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
Usage Guidelines
Use this command to specify a repository component name.
Use the set form of this command to specify a brief description for the repository.
Use the delete form of this command to remove the description.
Use the show form of this command to view the description.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
Syntax
set system package repository repository distribution dist
delete system package repository repository distribution
show system package repository repository distribution
Command Mode
Configuration mode.
Configuration Statement
system {
package {
repository text {
distribution: text
}
}
}
Parameters
repository
dist
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
Usage Guidelines
Use this command to specify a distribution name.
Use the set form of this command to specify a distribution name.
Use the delete form of this command to remove the distribution name.
Use the show form of this command to view the distribution name.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
Syntax
set system package repository repository url url
delete system package repository repository url
show system package repository repository url
Command Mode
Configuration mode.
Configuration Statement
system {
package {
repository text {
url: text
}
}
}
Parameters
repository
url
Default
None.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
Usage Guidelines
Use this command to specify the URL of the server hosting the repository.
Use the set form of this command to specify the URL of the server hosting the repository.
Use the delete form of this command to remove the URL.
Use the show form of this command to view the URL.
Command Reference
Rel VC4.1 v. 03
Vyatta
152
1527
This appendix lists the standard MIBs and traps supported by the Vyatta system.
152
Table A-1 shows the IETF-standard management information bases (MIBs) supported by
the Vyatta system.
Table A-1 Supported Standard MIBs
MIB Name
Document Title
Notes
BGP4-MIB
IF-MIB
OSPF2-MIB
OSPF Trap
RIP
SNMPv2-MIB
Command Reference
Rel VC4.1 v. 03
Vyatta
1529
This appendix lists the ICMP types defined by the Internet Assigned Numbers
Authority (IANA).
153
The Internet Assigned Numbers Authority (IANA) has developed a standard that maps a
set of integers and standard literal strings onto ICMP types.Table B-1 lists the ICMP types
defined by the IANA.
Table B-1 ICMP types
Command Reference
ICMP Type
Literal
echo-reply
unreachable
source-quench
redirect
alternate-address
echo
router-advertisement
10
router-solicitation
11
time-exceeded
12
parameter-problem
13
timestamp-reply
14
timestamp-request
15
information-request
16
information-reply
17
mask-request
18
mask-reply
31
conversion-error
32
mobile-redirect
33
where-are-you
34
i-am-here
35
mobile-regist-request
36
mobile-regist-response
37
domainname-request
Rel VC4.1 v. 03
Vyatta
153
Command Reference
ICMP Type
Literal
38
domainname-response
39
skip
40
photuris
Rel VC4.1 v. 03
Vyatta
Command Reference
153
Rel VC4.1 v. 03
Vyatta
1533
This appendix describes the regular expressions that can be recognized by the
Vyatta system.
153
Command Reference
Meaning
Matches any single character. Note that the dot does not match a newline
character. For example:
.at matches aat, bat, cat, and so on.
[]
Matches any single character included within the brackets. You can also
specify a range of characters using the hyphen. Individual characters can
be mixed with ranges. For example:
Examples:
[abc] matches either a, b, or c. It does not match ab or
abc.
[a-d] matches a, b, c, or d.
[a-dqrs] matches a, b, c, d, q, r, or s, and so does
[a-dq-s].
If you want to match the hyphen character itself (-), position it as either
the very first or the very last character in the list; for example:
[-abc] or [abc-] matches -, a, b, or c.
Otherwise, it is interpreted as a range separator.
If you want to match the square brackets themselves, place the right
(closing) square bracket first in the list, followed by the left (opening)
square bracket, as follows:
[ ] [ab] matches [, ], a, or b.
[^]
Matches any single character that is NOT included within the brackets.
Individual characters can be mixed with ranges.
Examples:
[^abc] matches any single character OTHER than a, b, or c.
[^a-z] matches any single character that is not a lowercase letter.
[^] matches all expressions matching .at except bat.
\ ( \)
Rel VC4.1 v. 03
Vyatta
153
Meaning
Command Reference
Class
Equivalent to:
[:upper:]
[:lower:]
[:alpha:]
Rel VC4.1 v. 03
Vyatta
153
Command Reference
Class
Equivalent to:
[:digit:]
[0-9] Digits.
[:alnum:]
[:xdigit:]
[:punct:]
[.,!?:...] Punctuation.
[:blank:]
[:space:]
[:cntrl:]
Control characters.
[:graph:]
[:print:]
Rel VC4.1 v. 03
Vyatta
153
Glossary of Acronyms
ACL
ADSL
AS
autonomous system
ARP
BGP
CHAP
CLI
command-line interface
DHCP
DLCI
DMI
DNS
DSCP
DSL
eBGP
external BGP
EGP
ECMP
equal-cost multipath
ESP
FIB
FTP
GRE
153
Command Reference
HDLC
ICMP
IDS
IGP
IPS
IKE
IP
Internet Protocol
IPOA
IP over ATM
IPsec
IP security
IPv4
IP Version 4
IPv6
IP Version 6
IS-IS
L2TP
LAN
MAC
MIB
MLPPP
multilink PPP
MPLS
MPLS EXP
MPLS experimental
MPLS TE
MRRU
MTU
NAT
NIC
NTP
OSPF
OSPFv2
OSPF Version 2
Rel VC4.1 v. 03
Vyatta
153
Command Reference
OSPFv3
OSPF Version 3
PAM
PAP
PCI
PKI
PPP
Point-to-Point Protocol
PPPoA
PPPoE
PPTP
PVC
QoS
quality of service
RADIUS
RIB
RIP
RIPng
Rx
receive
SNMP
SONET
SSH
Secure Shell
TACACS+
TCP
ToS
Type of Service
Tx
transmit
UDP
VLAN
virtual LAN
VPN
VRRP
Rel VC4.1 v. 03
Vyatta
154
WAN
Command Reference
Rel VC4.1 v. 03
Vyatta