Title

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

Quick Reference to Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv

Quick List of Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xliv
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xlviii
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xlix
Organization of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xlix
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . li
Advisory Paragraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . li
Typographic Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . lii
Vyatta Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . liii

Chapter 1 Using the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
The Vyatta CLI and the System Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
User Privilege Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Admin Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
OperatorRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
The Root User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Command Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Command Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Using Special Characters in Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Command Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Command History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Command Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Displaying Long Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Filtering Command Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Working with Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

iv

Entering and Exiting Configuration Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Configuration Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Navigating in Configuration Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Viewing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Adding or Modifying Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Deleting Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Committing Configuration Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Discarding Configuration Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Saving Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Loading a Saved Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Booting from a Saved Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Running an Operational Command from Configuration Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Displaying Configuration from Operational Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 2 Basic CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
discard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
show configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Chapter 3 System Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

clear arp address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
clear arp interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
clear console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
clear interfaces counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
full-upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
init-floppy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
install-system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
set date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
show arp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
show date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
show files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Command Reference

Rel VC4.1 v. 03

Vyatta

show hardware cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

show hardware dmi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
show hardware mem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
show hardware pci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
show host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
show interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
show license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
show system boot-messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
show system connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
show system kernel-messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
show system memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
show system processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
show system storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
show system uptime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
show tech-support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
show version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
system domain-name <domain> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
system domain-search domain <domain> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
system gateway-address <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
system host-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
system name-server <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
system ntp-server <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
system options reboot-on-panic <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
system static-host-mapping host-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
system time-zone <zone> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Chapter 4 User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

system login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
system login radius-server <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
system login user <user> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
system login user <user> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
system login user <user> full-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
system login user <user> level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
show users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Chapter 5 Basic Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

clear dhcp client process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
clear dhcp lease ip <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
clear dhcp leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
service dhcp-relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
service dhcp-relay interface <interface> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Command Reference

Rel VC4.1 v. 03

Vyatta

vi

service dhcp-relay relay-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

service dhcp-relay server <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
service dhcp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
service dhcp-server disabled <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
service dhcp-server shared-network-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
service dhcp-server shared-network-name <name> subnet <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
service dhcp-server shared-network-name <name> subnet <ipv4net> authoritative <state> . . . . . . . . . . . . . . . . 151
service dhcp-server shared-network-name <name> subnet <ipv4net> bootfile-name <bootfile> . . . . . . . . . . . . . 153
service dhcp-server shared-network-name <name> subnet <ipv4net> client-prefix-length <prefix> . . . . . . . . . . . 155
service dhcp-server shared-network-name <name> subnet <ipv4net> default-router <ipv4> . . . . . . . . . . . . . . . . 157
service dhcp-server shared-network-name <name> subnet <ipv4net> dns-server <ipv4> . . . . . . . . . . . . . . . . . . . 159
service dhcp-server shared-network-name <name> subnet <ipv4net> domain-name <domain-name> . . . . . . . . 161
service dhcp-server shared-network-name <name> subnet <ipv4net> exclude <ipv4> . . . . . . . . . . . . . . . . . . . . . 163
service dhcp-server shared-network-name <name> subnet <ipv4net> failover . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
service dhcp-server shared-network-name <name> subnet <ipv4net> failover local-address <ipv4> . . . . . . . . . . . 167
service dhcp-server shared-network-name <name> subnet <ipv4net> failover name <peer-name> . . . . . . . . . . . 169
service dhcp-server shared-network-name <name> subnet <ipv4net> failover peer-address <ipv4> . . . . . . . . . . . 171
service dhcp-server shared-network-name <name> subnet <ipv4net> failover status <status> . . . . . . . . . . . . . . . 173
service dhcp-server shared-network-name <name> subnet <ipv4net> ip-forwarding enable <state> . . . . . . . . . . 175
service dhcp-server shared-network-name <name> subnet <ipv4net> lease <seconds> . . . . . . . . . . . . . . . . . . . . 177
service dhcp-server shared-network-name <name> subnet <ipv4net> ntp-server <ipv4> . . . . . . . . . . . . . . . . . . . 179
service dhcp-server shared-network-name <name> subnet <ipv4net> pop-server <ipv4> . . . . . . . . . . . . . . . . . . . 181
service dhcp-server shared-network-name <name> subnet <ipv4net> server-identifier <ipv4> . . . . . . . . . . . . . . . 183
service dhcp-server shared-network-name <name> subnet <ipv4net> smtp-server <ipv4> . . . . . . . . . . . . . . . . . . 185
service dhcp-server shared-network-name <name> subnet <ipv4net> start <ipv4> stop <ipv4> . . . . . . . . . . . . . . 187
service dhcp-server shared-network-name <name> subnet <ipv4net> static-mapping . . . . . . . . . . . . . . . . . . . . . 189
service dhcp-server shared-network-name <name> subnet <ipv4net> static-route destination-subnet <ipv4net> . 191
service dhcp-server shared-network-name <name> subnet <ipv4net> static-route router <ipv4> . . . . . . . . . . . . . 193
service dhcp-server shared-network-name <name> subnet <ipv4net> tftp-server-name <servername> . . . . . . . . 195
service dhcp-server shared-network-name <name> subnet <ipv4net> time-offset <seconds> . . . . . . . . . . . . . . . 197
service dhcp-server shared-network-name <name> subnet <ipv4net> time-server <ipv4> . . . . . . . . . . . . . . . . . . 199
service dhcp-server shared-network-name <name> subnet <ipv4net> wins-server <ipv4> . . . . . . . . . . . . . . . . . . 201
service dhcp-server shared-network-name <name> subnet <ipv4net> wpad-url <url> . . . . . . . . . . . . . . . . . . . . . 203
service ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
service ssh allow-root <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
service ssh port <port> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
service ssh protocol-version <version> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
service telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
service telnet allow-root <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
service telnet port <port> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
show dhcp client leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
show dhcp leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
show dhcp statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
telnet <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

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

Chapter 7 Serial Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

clear interfaces serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
interfaces serial <wanx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
interfaces serial <wanx> cisco-hdlc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
interfaces serial <wanx> cisco-hdlc keepalives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
interfaces serial <wanx> cisco-hdlc mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
interfaces serial <wanx> cisco-hdlc mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
interfaces serial <wanx> cisco-hdlc vif 1 address local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Command Reference

Rel VC4.1 v. 03

Vyatta

viii

interfaces serial <wanx> cisco-hdlc vif 1 address prefix-length <prefix> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

interfaces serial <wanx> cisco-hdlc vif 1 address remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
interfaces serial <wanx> cisco-hdlc vif 1 description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
interfaces serial <wanx> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
interfaces serial <wanx> e1-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
interfaces serial <wanx> e1-options clock <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
interfaces serial <wanx> e1-options framing <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
interfaces serial <wanx> e1-options mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
interfaces serial <wanx> e1-options mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
interfaces serial <wanx> e1-options timeslots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
interfaces serial <wanx> e3-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
interfaces serial <wanx> e3-options clock <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
interfaces serial <wanx> e3-options framing <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
interfaces serial <wanx> e3-options line-coding <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
interfaces serial <wanx> encapsulation <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
interfaces serial <wanx> frame-relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
interfaces serial <wanx> frame-relay mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
interfaces serial <wanx> frame-relay mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
interfaces serial <wanx> frame-relay signaling <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
interfaces serial <wanx> frame-relay signaling-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
interfaces serial <wanx> frame-relay vif <dlci> address local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
interfaces serial <wanx> frame-relay vif <dlci> address prefix-length <prefix> . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
interfaces serial <wanx> frame-relay vif <dlci> address remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . 338
interfaces serial <wanx> frame-relay vif <dlci> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
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> 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

Command Reference

Rel VC4.1 v. 03

Vyatta

ix

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
interfaces serial <wanx> t3-options line-coding <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
show interfaces serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

Chapter 8 Multilink Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

clear interfaces multilink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
interfaces multilink <mlx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
interfaces multilink <mlx> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
interfaces multilink <mlx> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
interfaces multilink <mlx> lcp-echo-failure <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
interfaces multilink <mlx> lcp-echo-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
interfaces multilink <mlx> logging <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
interfaces multilink <mlx> mrru <mrru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
interfaces multilink <mlx> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
interfaces multilink <mlx> vif 1 address local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
interfaces multilink <mlx> vif 1 address prefix-length <prefix> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
interfaces multilink <mlx> vif 1 address remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
interfaces multilink <mlx> vif 1 description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
show interfaces multilink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

Chapter 9 Tunnel Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

clear interfaces tunnel counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
interfaces tunnel <tunx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
interfaces tunnel <tunx> address <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
interfaces tunnel <tunx> description <descr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
interfaces tunnel <tunx> disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
interfaces tunnel <tunx> encapsulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
interfaces tunnel <tunx> key <key> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
interfaces tunnel <tunx> local-ip <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
interfaces tunnel <tunx> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
interfaces tunnel <tunx> remote-ip <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
interfaces tunnel <tunx> tos <tos> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
interfaces tunnel <tunx> ttl <ttl> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
show interfaces tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

Chapter 10 PPPoE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

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

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

Chapter 11 Forwarding and Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

clear ip prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
clear ip route cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
show ip forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
show ip route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
show ip route <ipv4net> longer-prefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
show ip route cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
show ip route connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
show ip route forward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
show ip route kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
show ip route static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
show ip route supernets-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
show table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

Chapter 12 Bridging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

clear interfaces bridge counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
interfaces bridge <brx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

Command Reference

Rel VC4.1 v. 03

Vyatta

xi

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
interfaces bridge <brx> max-age <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
interfaces bridge <brx> priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
interfaces bridge <brx> stp <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
interfaces ethernet <ethx> bridge-group bridge <group-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
interfaces ethernet <ethx> bridge-group cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
interfaces ethernet <ethx> bridge-group priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
interfaces ethernet <ethx> vif <vlan-id> bridge-group bridge <group-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
interfaces ethernet <ethx> vif <vlan-id> bridge-group cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
interfaces ethernet <ethx> vif <vlan-id> bridge-group priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
show bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
show interfaces bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563

Chapter 13 Static Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564

protocols static interface-route <subnet> next-hop-interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
protocols static route <subnet> blackhole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
protocols static route <subnet> next-hop <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

Chapter 14 RIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571

debug rip events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
debug rip packet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
debug rip zebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip split-horizon <param> . . . . . . . . . . . . . . . . . . . . . . . . . . 584
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> 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 ethernet <ethx> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
interfaces ethernet <ethx> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
interfaces ethernet <ethx> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
interfaces ethernet <ethx> pppoe <num> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
interfaces ethernet <ethx> pppoe <num> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
interfaces ethernet <ethx> pppoe <num> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
interfaces ethernet <ethx> vif <vlan-id> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611

Command Reference

Rel VC4.1 v. 03

Vyatta

xii

interfaces ethernet <ethx> vif <vlan-id> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

interfaces ethernet <ethx> vif <vlan-id> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
interfaces loopback lo ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
interfaces loopback lo ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
interfaces loopback lo ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
interfaces multilink <mlx> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
interfaces multilink <mlx> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
interfaces multilink <mlx> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
interfaces serial <wanx> cisco-hdlc vif 1 ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
interfaces serial <wanx> cisco-hdlc vif 1 ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
interfaces serial <wanx> cisco-hdlc vif 1 ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
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> 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 tunnel <tunx> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
interfaces tunnel <tunx> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
interfaces tunnel <tunx> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
protocols rip default-distance <distance> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
protocols rip default-information originate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
protocols rip default-metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
protocols rip distribute-list access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
protocols rip distribute-list interface <ethx> access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
protocols rip distribute-list interface <ethx> prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
protocols rip distribute-list prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
protocols rip interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
protocols rip neighbor <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
protocols rip network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
protocols rip network-distance <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
protocols rip passive-interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
protocols rip redistribute bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
protocols rip redistribute connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
protocols rip redistribute kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
protocols rip redistribute ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
protocols rip redistribute static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
protocols rip route <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
protocols rip timers garbage-collection <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
protocols rip timers timeout <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
protocols rip timers update <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
show debugging rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
show ip route rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
show ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686

Command Reference

Rel VC4.1 v. 03

Vyatta

xiii

Chapter 15 OSPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688

debug ospf event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
debug ospf ism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
debug ospf lsa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
debug ospf nsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
debug ospf nssa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
debug ospf packet all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
debug ospf packet dd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
debug ospf packet hello . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
debug ospf packet ls-ack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
debug ospf packet ls-request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
debug ospf packet ls-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
debug ospf zebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . 717
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . 722
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . 724
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . 732
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . 734
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . 741
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
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> 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

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

interfaces loopback lo ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871

interfaces multilink <mlx> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
interfaces multilink <mlx> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
interfaces multilink <mlx> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
interfaces multilink <mlx> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
interfaces multilink <mlx> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
interfaces multilink <mlx> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
interfaces multilink <mlx> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
interfaces multilink <mlx> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
interfaces multilink <mlx> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
interfaces multilink <mlx> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
interfaces multilink <mlx> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
interfaces serial <wanx> frame-relay vif <dlci> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
interfaces serial <wanx> frame-relay vif <dlci> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
interfaces serial <wanx> frame-relay vif <dlci> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . 924
interfaces serial <wanx> frame-relay vif <dlci> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
interfaces serial <wanx> frame-relay vif <dlci> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 929
interfaces serial <wanx> frame-relay vif <dlci> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . 931
interfaces serial <wanx> frame-relay vif <dlci> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
interfaces serial <wanx> frame-relay vif <dlci> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
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> 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

Command Reference

Rel VC4.1 v. 03

Vyatta

xvi

interfaces serial <wanx> ppp vif 1 ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965

interfaces tunnel <tunx> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
interfaces tunnel <tunx> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
interfaces tunnel <tunx> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
interfaces tunnel <tunx> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
interfaces tunnel <tunx> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
interfaces tunnel <tunx> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
interfaces tunnel <tunx> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
interfaces tunnel <tunx> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
interfaces tunnel <tunx> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
interfaces tunnel <tunx> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
interfaces tunnel <tunx> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
protocols ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
protocols ospf access-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
protocols ospf area <area-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
protocols ospf area <area-id> area-type normal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
protocols ospf area <area-id> area-type nssa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
protocols ospf area <area-id> area-type stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
protocols ospf area <area-id> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
protocols ospf area <area-id> network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
protocols ospf area <area-id> range <ip4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
protocols ospf area <area-id> shortcut <mode> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
protocols ospf area <area-id> virtual-link <ipv4> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
protocols ospf area <area-id> virtual-link <ipv4> dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
protocols ospf area <area-id> virtual-link <ipv4> hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
protocols ospf area <area-id> virtual-link <ipv4> retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . 1012
protocols ospf area <area-id> virtual-link <ipv4> transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
protocols ospf auto-cost reference-bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
protocols ospf default-information originate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
protocols ospf default-metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
protocols ospf distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
protocols ospf log-adjacency-changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
protocols ospf max-metric router-lsa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
protocols ospf mpls-te . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
protocols ospf neighbor <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
protocols ospf parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
protocols ospf passive-interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
protocols ospf redistribute bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
protocols ospf redistribute connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
protocols ospf redistribute kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
protocols ospf redistribute rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
protocols ospf redistribute static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
protocols ospf refresh timers <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
protocols ospf timers throttle spf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045

Command Reference

Rel VC4.1 v. 03

Vyatta

xvii

show debugging ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1047

show ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
show ip ospf border-routers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
show ip ospf database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
show ip ospf interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053
show ip ospf neighbor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
show ip ospf route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
show ip route ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059

Chapter 16 BGP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060

clear ip bgp <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
clear ip bgp <address> ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1070
clear ip bgp dampening . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
clear ip bgp external . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
clear ip bgp external ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075
clear ip bgp peer-group <group-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077
clear ip bgp peer-group <group-name> ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079
clear ip bgp view <view-name> <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081
clear ip bgp view <view-name> <address> ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083
debug bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1085
debug bgp events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086
debug bgp filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087
debug bgp fsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1088
debug bgp keepalives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
debug bgp updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
debug bgp zebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
no debug all bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
protocols bgp <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093
protocols bgp <asn> aggregate-address <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095
protocols bgp <asn> neighbor <id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1097
protocols bgp <asn> neighbor <id> advertisement-interval <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
protocols bgp <asn> neighbor <id> allowas-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
protocols bgp <asn> neighbor <id> attribute-unchanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1103
protocols bgp <asn> neighbor <id> capability dynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1105
protocols bgp <asn> neighbor <id> capability orf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1107
protocols bgp <asn> neighbor <id> default-originate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1109
protocols bgp <asn> neighbor <id> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1111
protocols bgp <asn> neighbor <id> disable-capability-negotiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1113
protocols bgp <asn> neighbor <id> disable-connected-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
protocols bgp <asn> neighbor <id> disable-send-community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
protocols bgp <asn> neighbor <id> distribute-list import <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1119
protocols bgp <asn> neighbor <id> distribute-list export <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121
protocols bgp <asn> neighbor <id> ebgp-multihop <ttl> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123
protocols bgp <asn> neighbor <id> filter-list import <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125

Command Reference

Rel VC4.1 v. 03

Vyatta

xvii

protocols bgp <asn> neighbor <id> filter-list export <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127

protocols bgp <asn> neighbor <id> local-as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
protocols bgp <asn> neighbor <id> maximum-prefix <max-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
protocols bgp <asn> neighbor <id> nexthop-self . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133
protocols bgp <asn> neighbor <id> override-capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
protocols bgp <asn> neighbor <id> passive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1137
protocols bgp <asn> neighbor <id> peer-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1139
protocols bgp <asn> neighbor <id> port <port-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
protocols bgp <asn> neighbor <id> prefix-list import <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1143
protocols bgp <asn> neighbor <id> prefix-list export <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1145
protocols bgp <asn> neighbor <id> remote-as <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
protocols bgp <asn> neighbor <id> remove-private-as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1149
protocols bgp <asn> neighbor <id> route-map import <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1151
protocols bgp <asn> neighbor <id> route-map export <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1153
protocols bgp <asn> neighbor <id> route-reflector-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1155
protocols bgp <asn> neighbor <id> route-server-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1157
protocols bgp <asn> neighbor <id> shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
protocols bgp <asn> neighbor <id> soft-reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1161
protocols bgp <asn> neighbor <id> strict-capability-match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163
protocols bgp <asn> neighbor <id> timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1165
protocols bgp <asn> neighbor <id> unsuppress-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167
protocols bgp <asn> neighbor <id> update-source <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169
protocols bgp <asn> neighbor <id> weight <weight> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1171
protocols bgp <asn> network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
protocols bgp <asn> parameters always-compare-med . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175
protocols bgp <asn> parameters bestpath as-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177
protocols bgp <asn> parameters bestpath compare-routerid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1179
protocols bgp <asn> parameters bestpath med . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1181
protocols bgp <asn> parameters cluster-id <id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
protocols bgp <asn> parameters confederation identifier <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
protocols bgp <asn> parameters confederation peers <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
protocols bgp <asn> parameters dampening . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1189
protocols bgp <asn> parameters default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1191
protocols bgp <asn> parameters deterministic-med . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1193
protocols bgp <asn> parameters disable-network-import-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
protocols bgp <asn> parameters enforce-first-as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196
protocols bgp <asn> parameters graceful-restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1198
protocols bgp <asn> parameters log-neighbor-changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
protocols bgp <asn> parameters no-client-to-client-reflection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
protocols bgp <asn> parameters no-fast-external-failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1204
protocols bgp <asn> parameters router-id <id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206
protocols bgp <asn> parameters scan-time <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208
protocols bgp <asn> redistribute connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1210
protocols bgp <asn> redistribute kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1212

Command Reference

Rel VC4.1 v. 03

Vyatta

xix

protocols bgp <asn> redistribute ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1214

protocols bgp <asn> redistribute rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216
protocols bgp <asn> redistribute static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218
protocols bgp <asn> timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
show debugging bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
show ip bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
show ip bgp attribute-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
show ip bgp cidr-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
show ip bgp community-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
show ip bgp community <community> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
show ip bgp community-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
show ip bgp dampened-paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1229
show ip bgp filter-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
show ip bgp flap-statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
show ip bgp flap-statistics cidr-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1232
show ip bgp flap-statistics filter-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
show ip bgp flap-statistics prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
show ip bgp flap-statistics regexp <expr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
show ip bgp flap-statistics route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236
show ip bgp ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
show ip bgp ipv4 unicast cidr-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1238
show ip bgp ipv4 unicast community <community> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1239
show ip bgp ipv4 unicast community-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1240
show ip bgp ipv4 unicast filter-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
show ip bgp ipv4 unicast neighbors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242
show ip bgp ipv4 unicast neighbors <ipv4> advertised-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1243
show ip bgp ipv4 unicast neighbors <ipv4> prefix-counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244
show ip bgp ipv4 unicast neighbors <ipv4> received prefix-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
show ip bgp ipv4 unicast neighbors <ipv4> received-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
show ip bgp ipv4 unicast neighbors <ipv4> routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
show ip bgp ipv4 unicast paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1248
show ip bgp ipv4 unicast prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
show ip bgp ipv4 unicast regexp <regexp> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1250
show ip bgp ipv4 unicast route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
show ip bgp ipv4 unicast rsclient summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
show ip bgp ipv4 unicast statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
show ip bgp memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1254
show ip bgp neighbors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
show ip bgp neighbors <ipv4> advertised-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
show ip bgp neighbors <ipv4> dampened-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
show ip bgp neighbors <ipv4> flap-statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
show ip bgp neighbors <ipv4> prefix-counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
show ip bgp neighbors <ipv4> received prefix-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1260
show ip bgp neighbors <ipv4> received-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261

Command Reference

Rel VC4.1 v. 03

Vyatta

xx

show ip bgp neighbors <ipv4> routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262

show ip bgp paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
show ip bgp prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1264
show ip bgp regexp <regexp> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1265
show ip bgp route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1266
show ip bgp rsclient <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
show ip bgp scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
show ip bgp view <view-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1269
show ip bgp view <view-name> ipv4 unicast rsclient summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
show ip bgp view <view-name> ipv4 unicast summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271
show ip bgp view <view-name> neighbors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1272
show ip bgp view <view-name> rsclient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273
show ip route bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274

Chapter 17 Routing Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1276

policy access-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1281
policy access-list <list-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1282
policy access-list <list-num> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1283
policy access-list <list-num> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284
policy access-list <list-num> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1286
policy access-list <list-num> rule <rule-num> destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1287
policy access-list <list-num> rule <rule-num> source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1289
policy as-path-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1291
policy as-path-list <list-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1292
policy as-path-list <list-name> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293
policy as-path-list <list-name> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
policy as-path-list <list-name> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296
policy as-path-list <list-name> rule <rule-num> regex <regex> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1297
policy community-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1299
policy community-list <list-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
policy community-list <list-num> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
policy community-list <list-num> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
policy community-list <list-num> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1304
policy community-list <list-num> rule <rule-num> regex <regex> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1305
policy prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1307
policy prefix-list <list-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
policy prefix-list <list-name> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
policy prefix-list <list-name> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
policy prefix-list <list-name> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1312
policy prefix-list <list-name> rule <rule-num> ge <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313
policy prefix-list <list-name> rule <rule-num> le <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1315
policy prefix-list <list-name> rule <rule-num> prefix <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317
policy route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1319
policy route-map <map-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320

Command Reference

Rel VC4.1 v. 03

Vyatta

xxi

policy route-map <map-name> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321

policy route-map <map-name> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1322
policy route-map <map-name> rule <rule-num> call <target> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
policy route-map <map-name> rule <rule-num> continue <target-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1325
policy route-map <map-name> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
policy route-map <map-name> rule <rule-num> match as-path <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
policy route-map <map-name> rule <rule-num> match community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1329
policy route-map <map-name> rule <rule-num> match interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
policy route-map <map-name> rule <rule-num> match ip address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
policy route-map <map-name> rule <rule-num> match ip nexthop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
policy route-map <map-name> rule <rule-num> match ip route-source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
policy route-map <map-name> rule <rule-num> match metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
policy route-map <map-name> rule <rule-num> match origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1341
policy route-map <map-name> rule <rule-num> match peer <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
policy route-map <map-name> rule <rule-num> match tag <tag> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
policy route-map <map-name> rule <rule-num> on-match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1347
policy route-map <map-name> rule <rule-num> set aggregator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
policy route-map <map-name> rule <rule-num> set as-path-prepend <prepend> . . . . . . . . . . . . . . . . . . . . . . . 1351
policy route-map <map-name> rule <rule-num> set atomic-aggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352
policy route-map <map-name> rule <rule-num> set comm-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1353
policy route-map <map-name> rule <rule-num> set community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1355
policy route-map <map-name> rule <rule-num> set ip-next-hop <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
policy route-map <map-name> rule <rule-num> set local-preference <local-pref> . . . . . . . . . . . . . . . . . . . . . . . 1358
policy route-map <map-name> rule <rule-num> set metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1359
policy route-map <map-name> rule <rule-num> set metric-type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
policy route-map <map-name> rule <rule-num> set origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1362
policy route-map <map-name> rule <rule-num> set originator-id <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
policy route-map <map-name> rule <rule-num> set tag <tag> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
policy route-map <map-name> rule <rule-num> set weight <weight> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
show ip access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
show ip as-path-access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
show ip community-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
show ip extcommunity-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370
show ip prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
show ip protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
show route-map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375

Chapter 18 Quality of Service Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377

interfaces ethernet <ethx> qos-policy out <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1380
interfaces ethernet <ethx> vif <vlan-id> qos-policy out <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
qos-policy fair-queue <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384
qos-policy fair-queue <policy-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386
qos-policy fair-queue <policy-name> hash-interval <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1387
qos-policy fair-queue <policy-name> queue-limit <limit> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389

Command Reference

Rel VC4.1 v. 03

Vyatta

xxii

qos-policy traffic-shaper <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1391

qos-policy traffic-shaper <policy-name> bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
qos-policy traffic-shaper <policy-name> class <class> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
qos-policy traffic-shaper <policy-name> class <class> bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1397
qos-policy traffic-shaper <policy-name> class <class> burst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1399
qos-policy traffic-shaper <policy-name> class <class> ceiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1401
qos-policy traffic-shaper <policy-name> class <class> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
qos-policy traffic-shaper <policy-name> class <class> match <match-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405
qos-policy traffic-shaper <policy-name> class <class> match <match-name> description <desc> . . . . . . . . . . . . 1407
qos-policy traffic-shaper <policy-name> class <class> match <match-name> interface <interface> . . . . . . . . . . 1409
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip destination . . . . . . . . . . . . . . . . 1411
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip dscp <value> . . . . . . . . . . . . . . 1413
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip protocol <proto> . . . . . . . . . . . 1415
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip source . . . . . . . . . . . . . . . . . . . 1417
qos-policy traffic-shaper <policy-name> class <class> match <match-name> vif <vlan-id> . . . . . . . . . . . . . . . . . 1419
qos-policy traffic-shaper <policy-name> class <class> priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1421
qos-policy traffic-shaper <policy-name> class <class> queue-limit <limit> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1423
qos-policy traffic-shaper <policy-name> class <class> queue-type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425
qos-policy traffic-shaper <policy-name> class <class> set-dscp <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
qos-policy traffic-shaper <policy-name> default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
qos-policy traffic-shaper <policy-name> default bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430
qos-policy traffic-shaper <policy-name> default burst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
qos-policy traffic-shaper <policy-name> default ceiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1434
qos-policy traffic-shaper <policy-name> default priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
qos-policy traffic-shaper <policy-name> default queue-limit <limit> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1438
qos-policy traffic-shaper <policy-name> default queue-type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
qos-policy traffic-shaper <policy-name> default set-dscp <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
qos-policy traffic-shaper <policy-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444

Chapter 19 NAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445

clear nat counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447
clear nat translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
service nat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
service nat rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1450
service nat rule <rule-num> destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1452
service nat rule <rule-num> exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1454
service nat rule <rule-num> inbound-interface <interface> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1456
service nat rule <rule-num> inside-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1458
service nat rule <rule-num> outbound-interface <interface> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1460
service nat rule <rule-num> outside-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1462
service nat rule <rule-num> protocol <protocol> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1464
service nat rule <rule-num> source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1466
service nat rule <rule-num> type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1468
show nat rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470

Command Reference

Rel VC4.1 v. 03

Vyatta

xxii

show nat statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1471

Chapter 20 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1472

delete log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474
show log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1475
show log directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
show log tail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
system syslog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
system syslog console facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1481
system syslog file <filename> archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1483
system syslog file <filename> facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
system syslog global archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1487
system syslog global facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1489
system syslog host <hostname> facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491
system syslog user <userid> facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1493

Chapter 21 SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1495

protocols snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
protocols snmp community <community> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
protocols snmp community <community> authorization <auth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1499
protocols snmp community <community> client <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1501
protocols snmp community <community> network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1503
protocols snmp contact <contact> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
protocols snmp description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506
protocols snmp location <location> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1507
protocols snmp trap-target <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1508

Chapter 22 Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1510

ping <host> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1512
traceroute <host> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514

Chapter 23 Software Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1515

system package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516
system package auto-sync <days> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
system package repository <repository> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518
system package repository <repository> components <component> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1519
system package repository <repository> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1521
system package repository <repository> distribution <dist> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1523
system package repository <repository> url <url> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1525

Command Reference

Rel VC4.1 v. 03

Vyatta

xxi

Appendix A SNMP MIB Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1527

Appendix B ICMP Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1529
Appendix C Regular Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1533
Glossary of Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537

Command Reference

Rel VC4.1 v. 03

Vyatta

xxv

Quick Reference to Commands

Use this section to help you quickly locate a command.

clear arp address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
clear arp interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
clear console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
clear dhcp client process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
clear dhcp lease ip <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
clear dhcp leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
clear interfaces bridge counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
clear interfaces counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
clear interfaces ethernet counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
clear interfaces loopback counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
clear interfaces multilink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
clear interfaces serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
clear interfaces tunnel counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
clear ip bgp <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
clear ip bgp <address> ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1070
clear ip bgp dampening . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
clear ip bgp external . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
clear ip bgp external ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075
clear ip bgp peer-group <group-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077
clear ip bgp peer-group <group-name> ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079
clear ip bgp view <view-name> <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081
clear ip bgp view <view-name> <address> ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083
clear ip prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
clear ip route cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
clear nat counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447
clear nat translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
debug bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1085
debug bgp events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086
debug bgp filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087
debug bgp fsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1088

xxv

debug bgp keepalives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089

debug bgp updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
debug bgp zebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
debug ospf event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
debug ospf ism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
debug ospf lsa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
debug ospf nsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
debug ospf nssa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
debug ospf packet all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
debug ospf packet dd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
debug ospf packet hello . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
debug ospf packet ls-ack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
debug ospf packet ls-request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
debug ospf packet ls-update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
debug ospf zebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
debug rip events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
debug rip packet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
debug rip zebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
delete log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474
discard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
full-upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
init-floppy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
install-system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . 717
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . 732
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip split-horizon <param> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . 741
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743

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

interfaces bridge <brx> max-age <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545

interfaces bridge <brx> priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
interfaces bridge <brx> stp <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
interfaces ethernet <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
interfaces ethernet <ethx> address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
interfaces ethernet <ethx> bridge-group bridge <group-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
interfaces ethernet <ethx> bridge-group cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
interfaces ethernet <ethx> bridge-group priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
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> 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> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
interfaces ethernet <ethx> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
interfaces ethernet <ethx> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
interfaces ethernet <ethx> mac <mac-addr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
interfaces ethernet <ethx> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
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> 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

Command Reference

Rel VC4.1 v. 03

Vyatta

xxi

interfaces ethernet <ethx> pppoe <num> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828

interfaces ethernet <ethx> pppoe <num> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
interfaces ethernet <ethx> pppoe <num> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
interfaces ethernet <ethx> pppoe <num> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
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
interfaces ethernet <ethx> qos-policy out <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1380
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> bridge-group bridge <group-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
interfaces ethernet <ethx> vif <vlan-id> bridge-group cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
interfaces ethernet <ethx> vif <vlan-id> bridge-group priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
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 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 ethernet <ethx> vif <vlan-id> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
interfaces ethernet <ethx> vif <vlan-id> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
interfaces ethernet <ethx> vif <vlan-id> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
interfaces ethernet <ethx> vif <vlan-id> qos-policy out <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
interfaces loopback lo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
interfaces loopback lo address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
interfaces loopback lo description <descr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
interfaces loopback lo ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
interfaces loopback lo ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
interfaces loopback lo ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

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
interfaces loopback lo ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
interfaces loopback lo ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
interfaces loopback lo ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
interfaces loopback lo ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
interfaces multilink <mlx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
interfaces multilink <mlx> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
interfaces multilink <mlx> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
interfaces multilink <mlx> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
interfaces multilink <mlx> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
interfaces multilink <mlx> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
interfaces multilink <mlx> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
interfaces multilink <mlx> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
interfaces multilink <mlx> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
interfaces multilink <mlx> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
interfaces multilink <mlx> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
interfaces multilink <mlx> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
interfaces multilink <mlx> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
interfaces multilink <mlx> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
interfaces multilink <mlx> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
interfaces multilink <mlx> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
interfaces multilink <mlx> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
interfaces multilink <mlx> lcp-echo-failure <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
interfaces multilink <mlx> lcp-echo-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
interfaces multilink <mlx> logging <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
interfaces multilink <mlx> mrru <mrru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
interfaces multilink <mlx> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
interfaces multilink <mlx> vif 1 address local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
interfaces multilink <mlx> vif 1 address prefix-length <prefix> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
interfaces multilink <mlx> vif 1 address remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
interfaces multilink <mlx> vif 1 description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
interfaces serial <wanx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
interfaces serial <wanx> cisco-hdlc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
interfaces serial <wanx> cisco-hdlc keepalives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
interfaces serial <wanx> cisco-hdlc mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
interfaces serial <wanx> cisco-hdlc mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
interfaces serial <wanx> cisco-hdlc vif 1 address local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
interfaces serial <wanx> cisco-hdlc vif 1 address prefix-length <prefix> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
interfaces serial <wanx> cisco-hdlc vif 1 address remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

interfaces serial <wanx> cisco-hdlc vif 1 description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
interfaces serial <wanx> cisco-hdlc vif 1 ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
interfaces serial <wanx> cisco-hdlc vif 1 ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
interfaces serial <wanx> cisco-hdlc vif 1 ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
interfaces serial <wanx> cisco-hdlc vif 1 ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
interfaces serial <wanx> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
interfaces serial <wanx> e1-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
interfaces serial <wanx> e1-options clock <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
interfaces serial <wanx> e1-options framing <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
interfaces serial <wanx> e1-options mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
interfaces serial <wanx> e1-options mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
interfaces serial <wanx> e1-options timeslots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
interfaces serial <wanx> e3-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
interfaces serial <wanx> e3-options clock <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
interfaces serial <wanx> e3-options framing <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
interfaces serial <wanx> e3-options line-coding <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
interfaces serial <wanx> encapsulation <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
interfaces serial <wanx> frame-relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
interfaces serial <wanx> frame-relay mru <mru> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
interfaces serial <wanx> frame-relay mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
interfaces serial <wanx> frame-relay signaling <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
interfaces serial <wanx> frame-relay signaling-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
interfaces serial <wanx> frame-relay vif <dlci> address local-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
interfaces serial <wanx> frame-relay vif <dlci> address prefix-length <prefix> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
interfaces serial <wanx> frame-relay vif <dlci> address remote-address <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
interfaces serial <wanx> frame-relay vif <dlci> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
interfaces serial <wanx> frame-relay vif <dlci> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
interfaces serial <wanx> frame-relay vif <dlci> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
interfaces serial <wanx> frame-relay vif <dlci> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
interfaces serial <wanx> frame-relay vif <dlci> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
interfaces serial <wanx> frame-relay vif <dlci> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
interfaces serial <wanx> frame-relay vif <dlci> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
interfaces serial <wanx> frame-relay vif <dlci> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
interfaces serial <wanx> frame-relay vif <dlci> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935

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

interfaces serial <wanx> t3-options line-coding <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

interfaces tunnel <tunx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
interfaces tunnel <tunx> address <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
interfaces tunnel <tunx> description <descr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
interfaces tunnel <tunx> disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
interfaces tunnel <tunx> encapsulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
interfaces tunnel <tunx> ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
interfaces tunnel <tunx> ip ospf authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
interfaces tunnel <tunx> ip ospf bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
interfaces tunnel <tunx> ip ospf cost <cost> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
interfaces tunnel <tunx> ip ospf dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
interfaces tunnel <tunx> ip ospf hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
interfaces tunnel <tunx> ip ospf mtu-ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
interfaces tunnel <tunx> ip ospf network <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
interfaces tunnel <tunx> ip ospf priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
interfaces tunnel <tunx> ip ospf retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
interfaces tunnel <tunx> ip ospf transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
interfaces tunnel <tunx> ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
interfaces tunnel <tunx> ip rip authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
interfaces tunnel <tunx> ip rip split-horizon poison-reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
interfaces tunnel <tunx> key <key> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
interfaces tunnel <tunx> local-ip <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
interfaces tunnel <tunx> mtu <mtu> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
interfaces tunnel <tunx> remote-ip <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
interfaces tunnel <tunx> tos <tos> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
interfaces tunnel <tunx> ttl <ttl> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
no debug all bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
ping <host> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1512
policy access-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1281
policy access-list <list-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1282
policy access-list <list-num> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1283
policy access-list <list-num> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284
policy access-list <list-num> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1286
policy access-list <list-num> rule <rule-num> destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1287
policy access-list <list-num> rule <rule-num> source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1289
policy as-path-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1291
policy as-path-list <list-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1292
policy as-path-list <list-name> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293
policy as-path-list <list-name> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
policy as-path-list <list-name> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296
policy as-path-list <list-name> rule <rule-num> regex <regex> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1297
policy community-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1299
policy community-list <list-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

policy community-list <list-num> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301

policy community-list <list-num> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
policy community-list <list-num> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1304
policy community-list <list-num> rule <rule-num> regex <regex> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1305
policy prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1307
policy prefix-list <list-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
policy prefix-list <list-name> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
policy prefix-list <list-name> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
policy prefix-list <list-name> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1312
policy prefix-list <list-name> rule <rule-num> ge <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313
policy prefix-list <list-name> rule <rule-num> le <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1315
policy prefix-list <list-name> rule <rule-num> prefix <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317
policy route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1319
policy route-map <map-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
policy route-map <map-name> rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
policy route-map <map-name> rule <rule-num> action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1322
policy route-map <map-name> rule <rule-num> call <target> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
policy route-map <map-name> rule <rule-num> continue <target-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1325
policy route-map <map-name> rule <rule-num> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
policy route-map <map-name> rule <rule-num> match as-path <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
policy route-map <map-name> rule <rule-num> match community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1329
policy route-map <map-name> rule <rule-num> match interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
policy route-map <map-name> rule <rule-num> match ip address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
policy route-map <map-name> rule <rule-num> match ip nexthop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
policy route-map <map-name> rule <rule-num> match ip route-source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
policy route-map <map-name> rule <rule-num> match metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
policy route-map <map-name> rule <rule-num> match origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1341
policy route-map <map-name> rule <rule-num> match peer <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
policy route-map <map-name> rule <rule-num> match tag <tag> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
policy route-map <map-name> rule <rule-num> on-match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1347
policy route-map <map-name> rule <rule-num> set aggregator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
policy route-map <map-name> rule <rule-num> set as-path-prepend <prepend> . . . . . . . . . . . . . . . . . . . . . . . . . . . 1351
policy route-map <map-name> rule <rule-num> set atomic-aggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352
policy route-map <map-name> rule <rule-num> set comm-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1353
policy route-map <map-name> rule <rule-num> set community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1355
policy route-map <map-name> rule <rule-num> set ip-next-hop <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
policy route-map <map-name> rule <rule-num> set local-preference <local-pref> . . . . . . . . . . . . . . . . . . . . . . . . . . 1358
policy route-map <map-name> rule <rule-num> set metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1359
policy route-map <map-name> rule <rule-num> set metric-type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
policy route-map <map-name> rule <rule-num> set origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1362
policy route-map <map-name> rule <rule-num> set originator-id <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
policy route-map <map-name> rule <rule-num> set tag <tag> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
policy route-map <map-name> rule <rule-num> set weight <weight> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
protocols bgp <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

protocols bgp <asn> aggregate-address <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095

protocols bgp <asn> neighbor <id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1097
protocols bgp <asn> neighbor <id> advertisement-interval <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
protocols bgp <asn> neighbor <id> allowas-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
protocols bgp <asn> neighbor <id> attribute-unchanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1103
protocols bgp <asn> neighbor <id> capability dynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1105
protocols bgp <asn> neighbor <id> capability orf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1107
protocols bgp <asn> neighbor <id> default-originate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1109
protocols bgp <asn> neighbor <id> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1111
protocols bgp <asn> neighbor <id> disable-capability-negotiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1113
protocols bgp <asn> neighbor <id> disable-connected-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
protocols bgp <asn> neighbor <id> disable-send-community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
protocols bgp <asn> neighbor <id> distribute-list export <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121
protocols bgp <asn> neighbor <id> distribute-list import <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1119
protocols bgp <asn> neighbor <id> ebgp-multihop <ttl> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123
protocols bgp <asn> neighbor <id> filter-list export <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
protocols bgp <asn> neighbor <id> filter-list import <acl-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
protocols bgp <asn> neighbor <id> local-as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
protocols bgp <asn> neighbor <id> maximum-prefix <max-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
protocols bgp <asn> neighbor <id> nexthop-self . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133
protocols bgp <asn> neighbor <id> override-capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
protocols bgp <asn> neighbor <id> passive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1137
protocols bgp <asn> neighbor <id> peer-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1139
protocols bgp <asn> neighbor <id> port <port-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
protocols bgp <asn> neighbor <id> prefix-list export <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1145
protocols bgp <asn> neighbor <id> prefix-list import <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1143
protocols bgp <asn> neighbor <id> remote-as <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
protocols bgp <asn> neighbor <id> remove-private-as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1149
protocols bgp <asn> neighbor <id> route-map export <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1153
protocols bgp <asn> neighbor <id> route-map import <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1151
protocols bgp <asn> neighbor <id> route-reflector-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1155
protocols bgp <asn> neighbor <id> route-server-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1157
protocols bgp <asn> neighbor <id> shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
protocols bgp <asn> neighbor <id> soft-reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1161
protocols bgp <asn> neighbor <id> strict-capability-match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163
protocols bgp <asn> neighbor <id> timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1165
protocols bgp <asn> neighbor <id> unsuppress-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167
protocols bgp <asn> neighbor <id> update-source <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169
protocols bgp <asn> neighbor <id> weight <weight> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1171
protocols bgp <asn> network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
protocols bgp <asn> parameters always-compare-med . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175
protocols bgp <asn> parameters bestpath as-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177
protocols bgp <asn> parameters bestpath compare-routerid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1179
protocols bgp <asn> parameters bestpath med . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1181

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

protocols bgp <asn> parameters cluster-id <id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183

protocols bgp <asn> parameters confederation identifier <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
protocols bgp <asn> parameters confederation peers <asn> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
protocols bgp <asn> parameters dampening . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1189
protocols bgp <asn> parameters default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1191
protocols bgp <asn> parameters deterministic-med . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1193
protocols bgp <asn> parameters disable-network-import-check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
protocols bgp <asn> parameters enforce-first-as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196
protocols bgp <asn> parameters graceful-restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1198
protocols bgp <asn> parameters log-neighbor-changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
protocols bgp <asn> parameters no-client-to-client-reflection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
protocols bgp <asn> parameters no-fast-external-failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1204
protocols bgp <asn> parameters router-id <id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206
protocols bgp <asn> parameters scan-time <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208
protocols bgp <asn> redistribute connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1210
protocols bgp <asn> redistribute kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1212
protocols bgp <asn> redistribute ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1214
protocols bgp <asn> redistribute rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216
protocols bgp <asn> redistribute static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218
protocols bgp <asn> timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
protocols ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
protocols ospf access-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
protocols ospf area <area-id> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
protocols ospf area <area-id> area-type normal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
protocols ospf area <area-id> area-type nssa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
protocols ospf area <area-id> area-type stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
protocols ospf area <area-id> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
protocols ospf area <area-id> network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
protocols ospf area <area-id> range <ip4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
protocols ospf area <area-id> shortcut <mode> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
protocols ospf area <area-id> virtual-link <ipv4> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
protocols ospf area <area-id> virtual-link <ipv4> dead-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
protocols ospf area <area-id> virtual-link <ipv4> hello-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
protocols ospf area <area-id> virtual-link <ipv4> retransmit-interval <interval> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
protocols ospf area <area-id> virtual-link <ipv4> transmit-delay <delay> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
protocols ospf auto-cost reference-bandwidth <bandwidth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
protocols ospf default-information originate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
protocols ospf default-metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
protocols ospf distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
protocols ospf log-adjacency-changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
protocols ospf max-metric router-lsa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
protocols ospf mpls-te . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
protocols ospf neighbor <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
protocols ospf parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

protocols ospf passive-interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032

protocols ospf redistribute bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
protocols ospf redistribute connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
protocols ospf redistribute kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
protocols ospf redistribute rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
protocols ospf redistribute static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
protocols ospf refresh timers <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
protocols ospf timers throttle spf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
protocols rip default-distance <distance> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
protocols rip default-information originate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
protocols rip default-metric <metric> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
protocols rip distribute-list access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
protocols rip distribute-list interface <ethx> access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
protocols rip distribute-list interface <ethx> prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
protocols rip distribute-list prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
protocols rip interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
protocols rip neighbor <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
protocols rip network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
protocols rip network-distance <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
protocols rip passive-interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
protocols rip redistribute bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
protocols rip redistribute connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
protocols rip redistribute kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
protocols rip redistribute ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
protocols rip redistribute static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
protocols rip route <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
protocols rip timers garbage-collection <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
protocols rip timers timeout <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
protocols rip timers update <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
protocols snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
protocols snmp community <community> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
protocols snmp community <community> authorization <auth> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1499
protocols snmp community <community> client <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1501
protocols snmp community <community> network <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1503
protocols snmp contact <contact> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
protocols snmp description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506
protocols snmp location <location> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1507
protocols snmp trap-target <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1508
protocols static interface-route <subnet> next-hop-interface <ethx> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
protocols static route <subnet> blackhole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
protocols static route <subnet> next-hop <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
qos-policy fair-queue <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384
qos-policy fair-queue <policy-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386
qos-policy fair-queue <policy-name> hash-interval <seconds> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1387

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

qos-policy fair-queue <policy-name> queue-limit <limit> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389

qos-policy traffic-shaper <policy-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1391
qos-policy traffic-shaper <policy-name> bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
qos-policy traffic-shaper <policy-name> class <class> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
qos-policy traffic-shaper <policy-name> class <class> bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1397
qos-policy traffic-shaper <policy-name> class <class> burst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1399
qos-policy traffic-shaper <policy-name> class <class> ceiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1401
qos-policy traffic-shaper <policy-name> class <class> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
qos-policy traffic-shaper <policy-name> class <class> match <match-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405
qos-policy traffic-shaper <policy-name> class <class> match <match-name> description <desc> . . . . . . . . . . . . . . . . 1407
qos-policy traffic-shaper <policy-name> class <class> match <match-name> interface <interface> . . . . . . . . . . . . . . 1409
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip destination . . . . . . . . . . . . . . . . . . . . 1411
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip dscp <value> . . . . . . . . . . . . . . . . . . 1413
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip protocol <proto> . . . . . . . . . . . . . . . 1415
qos-policy traffic-shaper <policy-name> class <class> match <match-name> ip source . . . . . . . . . . . . . . . . . . . . . . . 1417
qos-policy traffic-shaper <policy-name> class <class> match <match-name> vif <vlan-id> . . . . . . . . . . . . . . . . . . . . 1419
qos-policy traffic-shaper <policy-name> class <class> priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1421
qos-policy traffic-shaper <policy-name> class <class> queue-limit <limit> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1423
qos-policy traffic-shaper <policy-name> class <class> queue-type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425
qos-policy traffic-shaper <policy-name> class <class> set-dscp <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
qos-policy traffic-shaper <policy-name> default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
qos-policy traffic-shaper <policy-name> default bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430
qos-policy traffic-shaper <policy-name> default burst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
qos-policy traffic-shaper <policy-name> default ceiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1434
qos-policy traffic-shaper <policy-name> default priority <priority> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
qos-policy traffic-shaper <policy-name> default queue-limit <limit> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1438
qos-policy traffic-shaper <policy-name> default queue-type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
qos-policy traffic-shaper <policy-name> default set-dscp <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
qos-policy traffic-shaper <policy-name> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444
reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
service dhcp-relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
service dhcp-relay interface <interface> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
service dhcp-relay relay-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
service dhcp-relay server <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
service dhcp-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
service dhcp-server disabled <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
service dhcp-server shared-network-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
service dhcp-server shared-network-name <name> subnet <ipv4net> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
service dhcp-server shared-network-name <name> subnet <ipv4net> authoritative <state> . . . . . . . . . . . . . . . . . . . . 151
service dhcp-server shared-network-name <name> subnet <ipv4net> bootfile-name <bootfile> . . . . . . . . . . . . . . . . . 153
service dhcp-server shared-network-name <name> subnet <ipv4net> client-prefix-length <prefix> . . . . . . . . . . . . . . . 155
service dhcp-server shared-network-name <name> subnet <ipv4net> default-router <ipv4> . . . . . . . . . . . . . . . . . . . . 157

Command Reference

Rel VC4.1 v. 03

Vyatta

xxx

service dhcp-server shared-network-name <name> subnet <ipv4net> dns-server <ipv4> . . . . . . . . . . . . . . . . . . . . . . 159

service dhcp-server shared-network-name <name> subnet <ipv4net> domain-name <domain-name> . . . . . . . . . . . . 161
service dhcp-server shared-network-name <name> subnet <ipv4net> exclude <ipv4> . . . . . . . . . . . . . . . . . . . . . . . . 163
service dhcp-server shared-network-name <name> subnet <ipv4net> failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
service dhcp-server shared-network-name <name> subnet <ipv4net> failover local-address <ipv4> . . . . . . . . . . . . . . 167
service dhcp-server shared-network-name <name> subnet <ipv4net> failover name <peer-name> . . . . . . . . . . . . . . . 169
service dhcp-server shared-network-name <name> subnet <ipv4net> failover peer-address <ipv4> . . . . . . . . . . . . . . 171
service dhcp-server shared-network-name <name> subnet <ipv4net> failover status <status> . . . . . . . . . . . . . . . . . . 173
service dhcp-server shared-network-name <name> subnet <ipv4net> ip-forwarding enable <state> . . . . . . . . . . . . . . 175
service dhcp-server shared-network-name <name> subnet <ipv4net> lease <seconds> . . . . . . . . . . . . . . . . . . . . . . . . 177
service dhcp-server shared-network-name <name> subnet <ipv4net> ntp-server <ipv4> . . . . . . . . . . . . . . . . . . . . . . . 179
service dhcp-server shared-network-name <name> subnet <ipv4net> pop-server <ipv4> . . . . . . . . . . . . . . . . . . . . . . 181
service dhcp-server shared-network-name <name> subnet <ipv4net> server-identifier <ipv4> . . . . . . . . . . . . . . . . . . 183
service dhcp-server shared-network-name <name> subnet <ipv4net> smtp-server <ipv4> . . . . . . . . . . . . . . . . . . . . . 185
service dhcp-server shared-network-name <name> subnet <ipv4net> start <ipv4> stop <ipv4> . . . . . . . . . . . . . . . . . 187
service dhcp-server shared-network-name <name> subnet <ipv4net> static-mapping . . . . . . . . . . . . . . . . . . . . . . . . . 189
service dhcp-server shared-network-name <name> subnet <ipv4net> static-route destination-subnet <ipv4net> . . . . 191
service dhcp-server shared-network-name <name> subnet <ipv4net> static-route router <ipv4> . . . . . . . . . . . . . . . . 193
service dhcp-server shared-network-name <name> subnet <ipv4net> tftp-server-name <servername> . . . . . . . . . . . . 195
service dhcp-server shared-network-name <name> subnet <ipv4net> time-offset <seconds> . . . . . . . . . . . . . . . . . . . 197
service dhcp-server shared-network-name <name> subnet <ipv4net> time-server <ipv4> . . . . . . . . . . . . . . . . . . . . . . 199
service dhcp-server shared-network-name <name> subnet <ipv4net> wins-server <ipv4> . . . . . . . . . . . . . . . . . . . . . . 201
service dhcp-server shared-network-name <name> subnet <ipv4net> wpad-url <url> . . . . . . . . . . . . . . . . . . . . . . . . . 203
service nat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
service nat rule <rule-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1450
service nat rule <rule-num> destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1452
service nat rule <rule-num> exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1454
service nat rule <rule-num> inbound-interface <interface> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1456
service nat rule <rule-num> inside-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1458
service nat rule <rule-num> outbound-interface <interface> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1460
service nat rule <rule-num> outside-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1462
service nat rule <rule-num> protocol <protocol> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1464
service nat rule <rule-num> source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1466
service nat rule <rule-num> type <type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1468
service ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
service ssh allow-root <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
service ssh port <port> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
service ssh protocol-version <version> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
service telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
service telnet allow-root <state> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
service telnet port <port> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
set date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
set interface pppoe <num> down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

Command Reference

Rel VC4.1 v. 03

Vyatta

xl

set interface pppoe <num> up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
show arp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
show bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
show configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
show date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
show debugging bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
show debugging ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1047
show debugging rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
show dhcp client leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
show dhcp leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
show dhcp statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
show files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
show hardware cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
show hardware dmi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
show hardware mem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
show hardware pci . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
show host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
show interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
show interfaces bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
show interfaces ethernet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
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 ethernet detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
show interfaces loopback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
show interfaces loopback detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
show interfaces loopback lo brief . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
show interfaces multilink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
show interfaces pppoe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
show interfaces serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
show interfaces tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
show ip access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
show ip as-path-access-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
show ip bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
show ip bgp attribute-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
show ip bgp cidr-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
show ip bgp community <community> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
show ip bgp community-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
show ip bgp community-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228

Command Reference

Rel VC4.1 v. 03

Vyatta

xli

show ip bgp dampened-paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1229

show ip bgp filter-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
show ip bgp flap-statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
show ip bgp flap-statistics cidr-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1232
show ip bgp flap-statistics filter-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
show ip bgp flap-statistics prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
show ip bgp flap-statistics regexp <expr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
show ip bgp flap-statistics route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236
show ip bgp ipv4 unicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
show ip bgp ipv4 unicast cidr-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1238
show ip bgp ipv4 unicast community <community> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1239
show ip bgp ipv4 unicast community-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1240
show ip bgp ipv4 unicast filter-list <list-num> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
show ip bgp ipv4 unicast neighbors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242
show ip bgp ipv4 unicast neighbors <ipv4> advertised-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1243
show ip bgp ipv4 unicast neighbors <ipv4> prefix-counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244
show ip bgp ipv4 unicast neighbors <ipv4> received prefix-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
show ip bgp ipv4 unicast neighbors <ipv4> received-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
show ip bgp ipv4 unicast neighbors <ipv4> routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
show ip bgp ipv4 unicast paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1248
show ip bgp ipv4 unicast prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
show ip bgp ipv4 unicast regexp <regexp> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1250
show ip bgp ipv4 unicast route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
show ip bgp ipv4 unicast rsclient summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
show ip bgp ipv4 unicast statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
show ip bgp memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1254
show ip bgp neighbors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
show ip bgp neighbors <ipv4> advertised-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
show ip bgp neighbors <ipv4> dampened-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
show ip bgp neighbors <ipv4> flap-statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
show ip bgp neighbors <ipv4> prefix-counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
show ip bgp neighbors <ipv4> received prefix-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1260
show ip bgp neighbors <ipv4> received-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261
show ip bgp neighbors <ipv4> routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262
show ip bgp paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
show ip bgp prefix-list <list-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1264
show ip bgp regexp <regexp> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1265
show ip bgp route-map <map-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1266
show ip bgp rsclient <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
show ip bgp scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
show ip bgp view <view-name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1269
show ip bgp view <view-name> ipv4 unicast rsclient summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
show ip bgp view <view-name> ipv4 unicast summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271
show ip bgp view <view-name> neighbors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1272

Command Reference

Rel VC4.1 v. 03

Vyatta

xlii

show ip bgp view <view-name> rsclient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273

show ip community-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
show ip extcommunity-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370
show ip forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
show ip ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
show ip ospf border-routers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
show ip ospf database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
show ip ospf interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053
show ip ospf neighbor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
show ip ospf route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
show ip prefix-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
show ip protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
show ip rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
show ip route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
show ip route <ipv4net> longer-prefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
show ip route bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274
show ip route cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
show ip route connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
show ip route forward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
show ip route kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
show ip route ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
show ip route rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
show ip route static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
show ip route supernets-only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
show license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
show log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1475
show log directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
show log tail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
show nat rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470
show nat statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1471
show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
show route-map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
show system boot-messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
show system connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
show system kernel-messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
show system memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
show system processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
show system storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
show system uptime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
show table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
show tech-support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
show users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
show version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
system domain-name <domain> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Command Reference

Rel VC4.1 v. 03

Vyatta

xliii

system domain-search domain <domain> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

system gateway-address <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
system host-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
system login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
system login radius-server <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
system login user <user> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
system login user <user> authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
system login user <user> full-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
system login user <user> level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
system name-server <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
system ntp-server <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
system options reboot-on-panic <value> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
system package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516
system package auto-sync <days> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
system package repository <repository> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518
system package repository <repository> components <component> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1519
system package repository <repository> description <desc> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1521
system package repository <repository> distribution <dist> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1523
system package repository <repository> url <url> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1525
system static-host-mapping host-name <name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
system syslog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
system syslog console facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1481
system syslog file <filename> archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1483
system syslog file <filename> facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
system syslog global archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1487
system syslog global facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1489
system syslog host <hostname> facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491
system syslog user <userid> facility <facility> level <level> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1493
system time-zone <zone> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
telnet <address> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
traceroute <host> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514
up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Command Reference

Rel VC4.1 v. 03

Vyatta

xliv

Quick List of Examples

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

Example 3-11 show hardware mem: Showing memory information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Example 3-12 show hardware pci: Showing PCI bus information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Example 3-13 show host: Looking up network hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Example 3-14 show host name: Showing network host names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Example 3-15 show host name: Showing the system date and time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Example 3-16 show host os: Showing operating system information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Example 3-17 show interfaces: Displaying interface information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Example 3-18 show license: Displaying license information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Example 3-19 show ntp: Showing configured NTP servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Example 3-20 show system boot-messages: Displaying startup messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Example 3-21 show system connections: Displaying active connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Example 3-22 show system kernel-messages: Displaying messages from the kernel . . . . . . . . . . . . . . . . . . . . . . . . . 89
Example 3-23 show system memory: Displaying information about memory usage . . . . . . . . . . . . . . . . . . . . . . . . . 91
Example 3-24 show system processes: Displaying process information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Example 3-25 show system storage: Displaying file system and storage information . . . . . . . . . . . . . . . . . . . . . . . . 94
Example 3-26 show system storage: Displaying file system and storage information . . . . . . . . . . . . . . . . . . . . . . . . 95
Example 3-27 show tech-support Displaying consolidated system information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Example 3-28 show version: Displaying a summary of version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Example 3-29 show version all: Displaying software package version information . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Example 3-30 show version added: Displaying information about added software packages . . . . . . . . . . . . . . . . . 100
Example 5-1 show dhcp leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Example 5-2 show dhcp statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Example 5-3 telnet 192.168.1.77: Displaying the Telnet session being established . . . . . . . . . . . . . . . . . . . . . . . . . 216
Example 6-1 show interfaces ethernet: Displaying Ethernet interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Example 6-2 show interfaces ethernet <ethx>: Displaying information for an Ethernet interface . . . . . . . . . . . . . . 259
Example 6-3 show interfaces ethernet detail: Displaying detailed information about Ethernet interfaces . . . . . . . 260
Example 6-4 show interfaces ethernet <ethx> brief: Displaying brief status for an Ethernet interface. . . . . . . . . . . 262
Example 6-5 show interfaces ethernet ethX identify: Blinks LEDs on an Ethernet interface. . . . . . . . . . . . . . . . . . . 263
Example 6-6 show interfaces ethernet ethX physical: Displaying physical line characteristics for an Ethernet interface. .
264
Example 6-7 show interfaces ethernet ethX queue: Displaying Ethernet queue information . . . . . . . . . . . . . . . . . 266
Example 6-8 show interfaces ethernet <ethX> vif <vlan-id>: Displaying Ethernet vif information . . . . . . . . . . . . . 267
Example 6-9 show interfaces ethernet <ethx> vif <vlan-id> brief: Displaying brief status for a vif. . . . . . . . . . . . . . 269
Example 6-10 show interfaces ethernet <ethx> vif <vlan-id> queue: Displaying vif queue information . . . . . . . . . 270
Example 6-11 show interfaces loopback: Displaying loopback interface status information. . . . . . . . . . . . . . . . . . . 271

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

Example 15-7 show ip route ospf: Displaying routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059

Example 16-1 show ip route bgp: Displaying BGP routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274
Example 17-1 show ip access-list: Displaying IP access lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
Example 17-2 show ip as-path-access-list: Displaying as-path access lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
Example 17-3 show ip community-list: Displaying community lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
Example 17-4 show ip extcommunity-list: Displaying extended IP community lists . . . . . . . . . . . . . . . . . . . . . . . . 1370
Example 17-5 show ip prefix-list: Displaying prefix lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
Example 17-6 show ip protocol: Displaying IP route maps by protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
Example 17-7 show route-map: Displaying route map information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
Example 22-1 Sample output of ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1512
Example 22-2 Sample output of traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514

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

Organization of This Guide

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:

Networking and data communications

TCP/IP protocols

General router configuration

Routing protocols

Network administration

Network security

Organization of This Guide

This guide has the following aid to help you find the information you are looking for:

Quick List of Examples

Use this list to help you locate examples youd like to try or look at.

This guide has the following chapters and appendixes:

Command Reference

Chapter

Description

Chapter 1: Using the CLI

This chapter provides an overview of the Vyatta

command-line interface (CLI), which is the
primary user interface to the Vyatta system.

Chapter 2: Basic CLI Commands

This chapter describes the basic commands for

using the CLI.

22

Chapter 3: System Management

This chapter describes commands required for

basic system management tasks.

49

Chapter 4: User Management

This chapter lists the commands available for

setting up user accounts and user
authentication.

117

Chapter 5: Basic Services

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.

132

Chapter 6: Ethernet Interfaces,

VLAN Interfaces, and the
Loopback Interface

This chapter lists the commands for configuring

Ethernet interfaces, the loopback interface, and
VLAN interfaces.

218

Rel VC4.1 v. 03

Page

Vyatta

xlix

Organization of This Guide

Command Reference

Chapter 7: Serial Interfaces

This chapter lists the commands for configuring

serial interfaces.

275

Chapter 8: Multilink Interfaces

This chapter lists the commands for configuring

multilink interfaces.

398

Chapter 9: Tunnel Interfaces

This chapter lists the commands for configuring

GRE and IP-in-IP routable tunnel interfaces.

430

Chapter 10: PPPoE

This chapter lists the commands for setting up

the Point-to-Point Protocol over Ethernet
(PPPoE) protocol on the Vyatta system.

455

Chapter 11: Forwarding and

Routing

This chapter lists commands for enabling and

disabling forwarding, and for displaying
general routing information.

513

Chapter 12: Bridging

This chapter lists the commands used for

Spanning Tree Protocol and bridging.

530

Chapter 13: Static Routes

This chapter lists the commands for configuring

static routes on the Vyatta system.

564

Chapter 14: RIP

This chapter lists the commands for setting up

the Routing Information Protocol (RIP) on the
Vyatta system.

571

Chapter 15: OSPF

This chapter lists the commands for configuring

OSPF on the Vyatta system.

688

Chapter 16: BGP

This chapter lists the commands for setting up

the Border Gateway Protocol on the Vyatta
system.

1060

Chapter 17: Routing Policies

This chapter lists the commands you can use to

create routing policies.

1276

Chapter 18: Quality of Service

Policies

This chapter lists the commands for defining

Quality of Service (QoS) policies to manage
traffic on your networkVyatta system.

1377

Chapter 19: NAT

This chapter lists the commands for setting up

Network Address Translation (NAT) on the
Vyatta system.

1445

Chapter 20: Logging

This chapter lists the commands used for

system logging.

1472

Chapter 21: SNMP

This chapter lists the commands for setting up

the Simple Network Management Protocol on
the Vyatta system.

1495

Chapter 22: Diagnostics

This chapter lists supported commands that can

be used for diagnostics and debugging.

1510

Rel VC4.1 v. 03

Vyatta

Document Conventions

Chapter 23: Software Upgrades

This chapter lists commands for using the

Vyatta systems software upgrade mechanism.

1515

Appendix A: SNMP MIB Support

This appendix lists the standard MIBs and traps

supported by the Vyatta system.

1529

Appendix B: ICMP Types

This appendix lists the ICMP types defined by

the Internet Assigned Numbers Authority
(IANA).

1529

Appendix C: Regular Expressions

This appendix describes the regular expressions

that can be recognized by the Vyatta system.

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

Courier font is used in command syntax sections and in examples.

boldface
Courier

Boldface Courier font is used to show something you enter at a

command line.

boldface

Boldface font is used to represent commands and keywords, and file

names within a paragraph of ordinary text.

italics

Italic font is used to show arguments and variables, where you

supply the value.

<key>

Angle brackets are used to indicate a key on your keyboard.

Combinations of keys are joined by plus signs (+). An example is
<Ctrl>+<Alt>+<Del>.

[ arg1 | arg2]

Square brackets enclose enumerated options for completing a

syntax. The options are separated by a vertical bar. An example is
[enable | disable].

num1numN

The typographic convention at left indicates a range of numbers. An

example is 165535, which means 1 through 65535 inclusive.

arg1..argN

The typographic convention at left indicates a range of enumerated

values. An example is eth0..eth23, which means eth1, eth2, eth3,
and so on through eth23.

arg [arg ...]

arg, [arg, ...]

The typographic convention at left indicates a value that can

optionally represent a list of elements (a space-separated list in the
first case, and a comma-separated list in the second case).

Rel VC4.1 v. 03

Vyatta

lii

Vyatta Publications

Vyatta Publications
The Vyatta technical library includes the following publications:

Command Reference

Vyatta 514 Hardware Installation

Guide

Explains how to install and set up Vyatta 514

hardware.

Vyatta System Quick Start Guide

Explains how to install the system software, and

provides some basic configuration to get you
started.

Vyatta Security Reference Guide

Provides command reference material and

configuration examples for features providing
network security, such as IPsec site-to-site VPN,
remote access VPN, firewall, Intrusion Protection
System, and anti-virus.

Vyatta High Availability Reference

Guide

Provides command reference material and

configuration examples for features providing high
availability, such as WAN load balancing, clustering,
and VRRP.

Vyatta System Command

Reference

Provides command reference material for all Vyatta

commands not documented in other reference
guides.

Rel VC4.1 v. 03

Vyatta

liii

Chapter 1: Using the CLI

This chapter provides an overview of the Vyatta command-line interface (CLI),

which is the primary user interface to the Vyatta system.
It explains the basic concepts of the CLI and how to use it.
This chapter presents the following topics:

Accessing the CLI

The Vyatta CLI and the System Shell

User Privilege Levels

Command Modes

Command Prompts

Using Special Characters in Commands

Command Completion

Command History

Command Editing

Displaying Long Output

Filtering Command Output

Chapter 1: Using the CLI

Accessing the CLI

Working with Configuration

Running an Operational Command from Configuration Mode

Displaying Configuration from Operational Mode

Accessing the CLI

To access the command-line interface (CLI), you log on to the Vyatta system, either directly
through the console port, or remotely using an SSH or Telnet session.

From the routers console.

Remotely, using SSH or Telnet

After the startup messages complete, the login prompt appears:

vyatta login:

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

Chapter 1: Using the CLI

The Vyatta CLI and the System Shell

The Vyatta CLI and the System Shell

The CLI of the Vyatta system includes two kinds of commands:

Vyatta-specific commands for operating and configuring the Vyatta system.

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.

User Privilege Levels

The Vyatta system supports two user roles:

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

The Root User

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

Chapter 1: Using the CLI

User Privilege Levels

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

Chapter 1: Using the CLI

Command Modes

The Root User

The Vyatta system supports a special user named root.
The root user is an admin user who has full access to the system. In addition, the root user
has an expanded view of the operating system shell commands and constructs: when the
root user queries the system for available commands using command completion, all
operating system shell commands and constructs are displayed along with Vyatta CLI
commands.
The root user is predefined by default and cannot be deleted from the system. The privilege
level of the root user cannot be changed: any level setting configured for the root user is
ignored.

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.

Configuration provides access to commands for creating, modifying, deleting,

committing and showing configuration information, as well as commands for
navigating through the configuration hierarchy.

When you log on to the system, the system is in operational mode.

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

Chapter 1: Using the CLI

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

And means 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

Using Special Characters in Commands

The Vyatta FusionCLI management interface is based on the GNU Bash shell. When
entering a command at the command prompt, keep in mind that some characters have
special meaning to the shell. For example, one such special character is the space character,
which denotes the end of a token in a command, as shown below
prompt> show interfaces ethernet

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

Chapter 1: Using the CLI

Using Special Characters in Commands

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 (,)

left parenthesis (()

right parenthesis ())

left angle bracket (<)

right angle bracket (>)

backslash (\)

pound sign (#)

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

Chapter 1: Using the CLI

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.

Pressing the question mark key (?) also generates command

completion. To enter a literal question mark, first enter <Ctrl>+v,
then the question mark.

<Tab>
<Alt>-?

For non-root users, displays all available Vyatta commands and

provides command completion. For the root user, displays all
available Vyatta and operating system shell commands and provides
command completion.

The following example finds all available commands.

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

Chapter 1: Using the CLI

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

Move to the previous command.

<Down-Arrow>
<Control>-n

Move to the next command.

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

Move backward in the command line.

Rel VC4.1 v. 03

Vyatta

Chapter 1: Using the CLI

Displaying Long Output

Table 1-4 Command-Line Editing Keystrokes

Type this

To do this

<Right-Arrow>
<Control>-f

Move forward in the command line.

<Control>-a

Move to the beginning of the command line.

<Control>-e

Move the end of the command line.

<Control>-d

Delete the character directly under the cursor.

<Control>-t

Toggle (swap) the character under the cursor with the character
immediately preceding it.

<Control>-<Space>

Mark the current cursor position.

<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.

Displaying Long Output

If the information being displayed is too long for your screen, the screen will show the
More indication where the information breaks.
Table 1-5 shows the keystrokes for controlling the display of information in a More
screen.
Table 1-5 Display options within a More screen
To do this

Press this

Exit More

q
Q

Scroll down one whole screen.

<Space>
f
<Ctrl>+f

Scroll up one whole screen

b
<Ctrl>+b

Command Reference

Rel VC4.1 v. 03

Vyatta

10

Chapter 1: Using the CLI

Filtering Command Output

Table 1-5 Display options within a More screen

Scroll down one-half screen.

d
<Ctrl>+d

Scroll up one-half screen

u
<Ctrl>+u

Scroll down one line.

<Enter>

e
<Ctrl>+e
<Down Arrow>
Scroll up one line.

y
<Ctrl>+y
<Up Arrow>

Scroll down to the bottom of the output.

Scroll up to the top of the output.

Display detailed help for More.

Filtering Command Output

The Vyatta system can pipe the output of commands into selected operating system shell
commands to filter what is displayed on the console. Commands are piped into the filters
using the vertical bar pipe operator (|).
Table 1-6 shows the pipe commands implemented for the Vyatta system.
Table 1-6 Pipe filter commands

Command Reference

Type this

To do this

count

Count occurrences.

match pattern

Show only text that matches the specified pattern.

more

Paginate output

no-match pattern

Show only text that does not match the specified pattern.

no-more

Don't paginate output.

Rel VC4.1 v. 03

Vyatta

11

Chapter 1: Using the CLI

Working with Configuration

Working with Configuration

This section presents the following topics:

Entering and Exiting Configuration Mode

Configuration Hierarchy

Navigating in Configuration Mode

Viewing Configuration

Adding or Modifying Configuration

Deleting Configuration

Committing Configuration Changes

Discarding Configuration Changes

Saving Configuration

Loading a Saved Configuration

Booting from a Saved Configuration

Entering and Exiting Configuration Mode

To enter configuration mode, use the configure command in operational mode.
Example 1-1 Entering configuration mode

vyatta@vyatta:~$ configure
[edit]
vyatta@vyatta#

Once in configuration mode, the command prompt changes from this:

user@host:~$

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

Chapter 1: Using the CLI

Working with Configuration

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:

Configuration nodes. These can be either:

Single nodes (just one instance can be created; for example, the rip protocol node)
Multi-nodes (more than one instance can be created; for example, address nodes)

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 {}

or non-empty, as in the following example:

ssh {
port: 165534
protocol-version: [v1|v2|all]
}

Navigating in Configuration Mode

You can tell where you are in the configuration tree by the [edit] prompt, which is
context-sensitive.
At the top of the configuration tree, the [edit] prompt displays like this:
[edit]

Command Reference

Rel VC4.1 v. 03

Vyatta

13

Chapter 1: Using the CLI

Working with Configuration

When you are in another location, the edit prompt displays your location by showing the
node hierarchy in order, like this:
[edit protocols bgp]

Table 1-5 shows the commands for navigating in configuration mode.

Table 1-7 Commands for navigating in configuration mode
Command

Result

edit config-node

Navigates to the specified configuration node for editing.

The node must already be created the the configuration committed.

exit

Jumps to the top of the configuration tree.

If you are already at the top of the configuration tree, exit from
configuration mode and return to operational mode.

top

Jumps to the top of the configuration tree.

up

Moves up one node in the configuration tree.

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.

vyatta@R1# edit interfaces ethernet eth2

[edit interfaces ethernet eth2]
vyatta@R1# show
hw-id: 00:13:46:e6:f6:87
[edit interfaces ethernet eth2]
vyatta@R1#

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.

user@host# show interfaces

ethernet eth0 {

Command Reference

Rel VC4.1 v. 03

Vyatta

14

Chapter 1: Using the CLI

Working with Configuration

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.

vyatta@R1# show interfaces ethernet eth0

address "10.1.0.62/24"
hw-id: 00:40:63:e2:e4:00

When the display is too large for one screen, it stops with one screen displayed. In this case:

Press <Enter> to display the next line.

Press <space> to display the next screen.

Press q to interrupt the display and return to the command prompt.

Adding or Modifying Configuration

Add new configuration by creating a configuration node, using the set command in
configuration mode. Modify existing configuration using the set command in configuration
mode. For example:

vyatta@R1# set interfaces ethernet eth2 address 192.168.1.100/24

[edit]
vyatta@R1#

Then use the show command to see the change:

Command Reference

Rel VC4.1 v. 03

Vyatta

15

Chapter 1: Using the CLI

Working with Configuration

vyatta@R1# show interfaces ethernet eth2

+address "192.168.1.100/24"
hw-id: 00:13:46:e6:f6:87
[edit]
vyatta@R1#

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:

vyatta@R1# delete interfaces ethernet eth2 address

192.168.1.100/24
[edit]

Then use the show command to see the change:

vyatta@R1# show interfaces ethernet eth2

-address "192.168.1.100/24"
hw-id: 00:13:46:e6:f6:87
[edit]

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

Chapter 1: Using the CLI

Working with Configuration

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.

Committing Configuration Changes

In the Vyatta system, configuration changes do not take effect until you commit them using
the commit command.

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# show interfaces ethernet eth2

-address "192.168.1.100/24"
hw-id: 00:13:46:e6:f6:87
[edit]
vyatta@R1# commit
[edit]
vyatta@R1# show interfaces ethernet eth2
hw-id: 00:13:46:e6:f6:87
[edit]

Discarding Configuration Changes

You cannot exit from configuration mode with uncommitted configuration changes; you
must either commit the changes or discard them. If you dont want to commit the changes,
you can discard them using the exit discard command.

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

Chapter 1: Using the CLI

Working with Configuration

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.

For hard disk installs the configuration directory is /opt/vyatta/etc/config

For installations running off LiveCD, the configuration directory is is

/media/floppy/config.

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.

vyatta#R1 save testconfig

Saving configuration to '/opt/vyatta/etc/config/testconfig'...
Done
[edit]
vyatta@R1#

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

Use standard UNIX file specification.

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

Chapter 1: Using the CLI

Working with Configuration

Table 1-8 Specifying locations for the configuration file

Location

Specification

TFTP server

Use the following syntax for file-name:

tftp://ip-address/config-file
where ip-address is the IP address of the TFTP server, and
config-file is the configuration file, including the path relative to
the TFTP root directory.

FTP server

Use the following syntax for file-name:

ftp://ip-address/config-file
where ip-address is the IP address of the FTP server, and
config-file is the configuration file, including the path.
If you use FTP, you will be prompted for a user name and
password.

HTTP server

Use the following syntax for file-name:

http://ip-address/config-file
where ip-address is the IP address of the HTTP server, and
config-file is the configuration file, including the path.

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.

Loading a Saved Configuration

To load a previously saved configuration use the load command in configuration mode. By
default, the system reads the file from the standard configuration directory. By default this
is /opt/vyatta/etc/config.,

vyatta@R1# load testconfig

Loading config file /opt/vyatta/etc/config/testconfig...
Done
[edit]
vyatta@R1#

A loaded configuration is automatically committed and becomes the active configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

19

Chapter 1: Using the CLI

Running an Operational Command from Configuration Mode

Booting from a Saved Configuration

If you want the file to be automatically read the next time the system starts, you must save
it as config.boot in the standard configuration directory. By default

For hard disk installs the configuration directory is /opt/vyatta/etc/config

For installations running off LiveCD, the configuration directory is is

/media/floppy/config.

Running an Operational Command from

Configuration Mode
You can run an operational command without leaving configuration mode using the run
command, as in the following example:

vyatta@R1# run show system processes summary

20:45:46 up 1 day, 10:16, 3 users, load average: 0.00, 0.00,
0.00
[edit]
vyatta@R1#

Displaying Configuration from Operational

Mode
You can display configuration information without leaving operational mode using the
show configuration command, as in the following example:

vyatta@R1:~$ show configuration system

system {
login {
user root {
authentication {
encrypted-password: "$1$$Ht7gBYnxI1xCdO/JOnodh."
}
}
user vyatta {
authentication {

Command Reference

Rel VC4.1 v. 03

Vyatta

20

Chapter 1: Using the CLI

Displaying Configuration from Operational Mode

encrypted-password: "$1$$Ht7gBYnxI1xCdO/JOnodh."
}
}
}
ntp-server "69.59.150.135"
}
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

21

22

Chapter 2: Basic CLI Commands

This chapter describes the basic commands for using the CLI.
This chapter contains the following commands.
Command

Description

Basic CLI Configuration Commands

commit

Applies any uncommitted configuration changes.

delete

Deletes a configuration node.

discard

Discards any uncommitted configuration changes.

edit

Navigates to a subnode in the configuration tree for editing.

exit

Navigates up one level of use.

load

Loads a saved configuration.

run

Runs an operational command without leaving configuration mode.

save

Saves the running configuration to a file.

set

Creates a new configuration node, or modifies a value in an existing

configuration node.

show

Displays configuration information in configuration mode.

Chapter 2: Basic CLI Commands

23

Command

Description

top

Exits to the top level of configuration mode.

up

Navigates up one level in the configuration tree.

Basic CLI Operational Commands

configure

Enters configuration mode.

exit

Navigates up one level of use.

init-floppy

Formats a floppy diskette and prepares it to receive a configuration file.

See page 58 in Chapter 3: System Management.

show arp

Displays the systems ARP cache. See page 64 in Chapter 3: System

Management

show configuration

Displays system configuration from operational mode.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 2: Basic CLI Commands

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

Chapter 2: Basic CLI Commands

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

vyatta@vyatta# show interfaces ethernet eth2

-address "192.168.1.100/24"
hw-id: 00:13:46:e6:f6:87
[edit]
vyatta@vyatta# commit
[edit]
vyatta@vyatta# show interfaces ethernet eth2
hw-id: 00:13:46:e6:f6:87
[edit]

Command Reference

Rel VC4.1 v. 03

Vyatta

25

Chapter 2: Basic CLI Commands

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

Chapter 2: Basic CLI Commands

delete

delete
Deletes a configuration node.

Syntax
delete config-node

Command Mode
Configuration mode.

Configuration Statement
None.

Parameters

config-node

The configuration node to be deleted, including the full path, separated

by spaces, through the configuration hierarchy to the 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

Chapter 2: Basic CLI Commands

delete

Examples
Example 2-3 deletes a DNS server from system configuration.
Example 2-3 delete: Deleting configuration

vyatta@vyatta# show system name-server <Tab>

10.0.0.30 10.0.0.31 10.0.0.32
[edit]
vyatta@vyatta# show system name-server 10.0.0.3
vyatta@vyatta# delete system name-server 10.0.0.32
[edit]
vyatta@vyatta# show system name-server <Tab>
10.0.0.30 10.0.0.31
vyatta@vyatta# show system name-server
[edit]

Command Reference

Rel VC4.1 v. 03

Vyatta

28

Chapter 2: Basic CLI Commands

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

vyatta@vyatta# show interfaces ethernet eth2

-address "192.168.1.100/24"
+address "192.168.1.101/24"
hw-id: 00:13:46:e6:f6:87
[edit]
vyatta@vyatta# discard
Changes have been discarded
[edit]

Command Reference

Rel VC4.1 v. 03

Vyatta

29

Chapter 2: Basic CLI Commands

discard

vyatta@vyatta# show interfaces ethernet eth2

hw-id: 00:13:46:e6:f6:87
[edit]

Command Reference

Rel VC4.1 v. 03

Vyatta

30

Chapter 2: Basic CLI Commands

edit

edit
Navigates to a subnode in the configuration tree for editing.

Syntax
edit path

Command Mode
Configuration mode.

Configuration Statement
None.

Parameters

path

The path to the node of configuration tree you want to edit.

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

Chapter 2: Basic CLI Commands

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

Chapter 2: Basic CLI Commands

exit

exit
Navigates up one level of use.

From a configuration subnode, jumps to the top of the configuration tree.

From the top of the configuration tree, exits to operational mode.

From operational mode, exits the system.

Syntax
exit [discard]

Command Mode
Configuration mode.
Operational mode.

Configuration Statement
None.

Parameters

discard

Applies when exiting from configuration mode to operational mode with

uncommitted configuration changes. Allows you to exit from
configuration mode by discarding all configuration changes.

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

Chapter 2: Basic CLI Commands

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

Chapter 2: Basic CLI Commands

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

Use standard UNIX file specification.

Rel VC4.1 v. 03

Vyatta

35

Chapter 2: Basic CLI Commands

load

Table 2-1
Location

Specification

A relative path

Specify the path name relative to the default configuration

directory.

TFTP server

Use the following syntax for file-name:

tftp://ip-address/config-file
where ip-address is the IP address of the TFTP server, and
config-file is the configuration file, including the path relative to
the TFTP root directory.

FTP server

Use the following syntax for file-name:

ftp://ip-address/config-file
where ip-address is the IP address of the FTP server, and
config-file is the configuration file, including the path.
If you use FTP, you will be prompted for a user name and
password.

HTTP server

use the following syntax for file-name:

http://ip-address/config-file
where ip-address is the IP address of the HTTP server, and
config-file is the configuration file, including the path.

Examples
Example 2-6 loads the configuration file testconfig from the default configuration
directory.
Example 2-6 Loading configuration from a file

vyatta@vyatta# load testconfig

Loading config file /opt/vyatta/etc/config/testconfig...
Done
[edit]
vyatta@vyatta#

Command Reference

Rel VC4.1 v. 03

Vyatta

36

Chapter 2: Basic CLI Commands

run

run
Runs an operational command without leaving configuration mode.

Syntax
run command

Command Mode
Configuration mode.

Configuration Statement
None.

Parameters

command

The operational command to be executed.

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

vyatta@vyatta# run show date

Sun Dec 16 23:34:06 GMT 2007
[edit]
vyatta@vyatta#

Command Reference

Rel VC4.1 v. 03

Vyatta

37

Chapter 2: Basic CLI Commands

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

Use standard UNIX file specification.

A relative path

Specify the path name relative to the default configuration

directory.

Rel VC4.1 v. 03

Vyatta

38

Chapter 2: Basic CLI Commands

save

Table 2-2
Location

Specification

TFTP server

Use the following syntax for file-name:

tftp://ip-address/config-file
where ip-address is the IP address of the TFTP server, and
config-file is the configuration file, including the path relative to
the TFTP root directory.

FTP server

Use the following syntax for file-name:

ftp://ip-address/config-file
where ip-address is the IP address of the FTP server, and
config-file is the configuration file, including the path.
If you use FTP, you will be prompted for a user name and
password.

HTTP server

use the following syntax for file-name:

http://ip-address/config-file
where ip-address is the IP address of the HTTP server, and
config-file is the configuration file, including the path.

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

Chapter 2: Basic CLI Commands

save

-rw-rw-r-- 1 vyatta xorp 2.8K Nov 27 21:50 my-config~

vyatta@vyatta:~$

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

vyatta@vyatta# save tftp://10.1.0.35/my-config

Saving configuration to 'tftp://10.1.0.35/my-config'...
Done
[edit]
vyatta@vyatta#

Command Reference

Rel VC4.1 v. 03

Vyatta

40

Chapter 2: Basic CLI Commands

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

The configuration node to be created or modified, including the full

path, separated by spaces, through the configuration hierarchy to the
node.

identifier

The identifier of the configuration node. Mandatory if the configuration

node has an identifier; forbidden otherwise.

attribute

The configuration attribute or property to be set. If the attribute

statement does not exist, it is created. If the attribute statement already
exists, the value is set to the new value.

value

The new value of the attribute. Mandatory if the attribute statement

requires a value; forbidden otherwise.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

41

Chapter 2: Basic CLI Commands

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

vyatta@vyatta# set interfaces ethernet eth1 address

192.150.187.108/24
[edit]
vyatta@vyatta# commit
[edit]

Command Reference

Rel VC4.1 v. 03

Vyatta

42

Chapter 2: Basic CLI Commands

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

Includes default information in the displayed information.

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

Chapter 2: Basic CLI Commands

show

In addition to this command, there are a number of show commands available in

operational mode. For a list of these commands, please see the Quick Reference to
Commands, which begins on page xxv.

Examples
Example 2-11 shows the service node displayed using the show command in configuration
mode.
Example 2-11 show: Displaying configuration information

vyatta@vyatta# show service

dhcp-server {
}
dhcp {
}
webgui {
}
ssh {
}
telnet {
}
[edit]
vyatta@vyatta#

Command Reference

Rel VC4.1 v. 03

Vyatta

44

Chapter 2: Basic CLI Commands

show configuration

show configuration
Displays system configuration from operational mode.

Syntax
show [-all] configuration

Command Mode
Operational mode.

Parameters

Table 2-3

-all

Displays all configuration, including default values that would not

normally be displayed.

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

vyatta@vyatta:~$ show configuration firewall

log-martians: "enable"
send-redirects: "disable"
receive-redirects: "disable"

Command Reference

Rel VC4.1 v. 03

Vyatta

45

Chapter 2: Basic CLI Commands

show configuration

ip-src-route: "disable"
broadcast-ping: "disable"
syn-cookies: "enable"
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

46

Chapter 2: Basic CLI Commands

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

vyatta@vyatta# edit protocols rip interface eth0

[edit protocols/rip/interface/eth0]
vyatta@vyatta# top
[edit]
vyatta@vyatta#

Command Reference

Rel VC4.1 v. 03

Vyatta

47

Chapter 2: Basic CLI Commands

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

vyatta@vyatta# edit protocols rip interface eth0

[edit protocols/rip/interface/eth0]
vyatta@vyatta# up
[edit protocols/rip/interface]
vyatta@vyatta# up
[edit protocols/rip/]

Command Reference

Rel VC4.1 v. 03

Vyatta

48

49

Chapter 3: System Management

This chapter describes commands required for basic system management tasks.
This chapter contains the following commands.
Command

Description

System Management Configuration Commands

system domain-name <domain>

Sets the systems domain.

system domain-search domain <domain>

Defines a set of domains for domain completion.

system gateway-address <address>

Specifies the default gateway for the router.

system host-name <name>

Sets the host name for the router.

system login

Creates a user account. See page 118 in Chapter 4:

User Management.

system name-server <address>

Specifies the DNS name servers available to the router.

system ntp-server <name>

Specifies the NTP servers to use when synchronizing the

routers clock.

system options reboot-on-panic <value>

Allows you set system behavior on system panic.

Chapter 3: System Management

50

Command

Description

system package

Specifies the information needed for automatic software

updates. See page 1516 in Chapter 23: Software
Upgrades.

system static-host-mapping host-name <name>

Defines a static mapping between a host name and an IP

address.

system syslog

Configures the systems syslog utility. See page 1478 in

Chapter 20: Logging.

system time-zone <zone>

Sets the time zone for the local system clock.

System Management Operational Commands

clear arp address <ipv4>

Clears the systems ARP cache for the specified IP

address.

clear arp interface <ethx>

Clears the systems ARP cache for the specified interface.

clear console

Clears the users console.

clear interfaces counters

Clears interface counters for all interfaces.

full-upgrade

Upgrades Vyatta system software.

init-floppy

Formats a floppy diskette and prepares it to receive a

configuration file.

install-system

Installs Vyatta system software to a persistent device.

reboot

Reboots the system.

set date

Sets the system date and time directly or specifies an

NTP server to acquire it from.

show arp

Displays the systems ARP cache.

show date

Displays the system date and time.

show files

Displays file information.

show hardware cpu

Displays information about the systems processor.

show hardware dmi

Displays information about the systems DMI.

show hardware mem

Displays information about the systems memory.

show hardware pci

Displays information about the systems PCI bus.

show host

Displays host information for hosts reachable by the

system.

show interfaces

Displays information about system interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 3: System Management

51

Command

Description

show license

Displays Vyatta license information.

show ntp

Shows the status of configured NTP servers.

show system boot-messages

Displays boot messages generated by the kernel.

show system connections

Displays active network connections on the system.

show system kernel-messages

Displays messages in the kernel ring buffer.

show system memory

Displays system memory usage.

show system processes

Displays active system processes.

show system storage

Displays system file system usage and available storage

space.

show system uptime

Displays information on how long the system has been

running.

show tech-support

Provides a consolidated report of system information.

show version

Displays information about the version of router

software.

terminal

Controls behaviors of the system terminal.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 3: System Management

clear arp address <ipv4>

clear arp address <ipv4>

Clears the systems ARP cache for the specified IP address.

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

Chapter 3: System Management

clear arp interface <ethx>

clear arp interface <ethx>

Clears the systems ARP cache for the specified interface.

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

Chapter 3: System Management

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

Chapter 3: System Management

clear interfaces counters

clear interfaces counters

Clears interface counters for all interfaces.

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

Chapter 3: System Management

full-upgrade

full-upgrade
Upgrades Vyatta system software.

Syntax
full-upgrade [-h | -i | -k ]

Command Mode
Operational mode.

Parameters

-h

Help - Displays help for the full-upgrade command.

-i

Interactive upgrade - Provides prompts generated by the various

packages during an upgrade. It should only be run on the local console
(i.e. not via a telnet or ssh session) and is for expert users only.

-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

Chapter 3: System Management

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

Chapter 3: System Management

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

Chapter 3: System Management

init-floppy

vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

59

Chapter 3: System Management

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

Chapter 3: System Management

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

Chapter 3: System Management

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

Specifies a Network Time Protocol (NTP) to acquire the current

time from. You can specify either an IPv4 address or a
hostname to identify the NTP server.

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

Chapter 3: System Management

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

vyatta@R1:~$ set date 051522552008

Thu May 15 22:55:00 PDT 2008
vyatta@R1:~$

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

vyatta@R1:~$ set date ntp 69.59.150.135

15 May 23:00:00 ntpdate[7038]: step time server 69.59.150.135
offset 425.819267 sec
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

63

Chapter 3: System Management

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

Address resolution is currently being preformed on this neighbor

entry.

reachable

Indicates that the neighbor is reachable. Positive confirmation has

been received and the path to this neighbor is operational.

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

Neighbor reachability state detection failed.

Rel VC4.1 v. 03

Vyatta

64

Chapter 3: System Management

show arp

Table 3-1 ARP states

State

Description

noarp

This is a pseudo-state, indicating that ARP is not used for this

neighbor entry.

permanent

This is a pseudo-state indicating that this entry should not be cleared

from the cache.

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

Chapter 3: System Management

show date

show date
Displays the system date and time.

Syntax
show date [utc]

Command Mode
Operational mode.

Parameters

utc

Show the date and time in Coordinated Universal Time.

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

vyatta@R1:~$ show date

Tue May 20 17:27:07 PDT 2008
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

66

Chapter 3: System Management

show files

show files
Displays file information.

Syntax
show files directory

Command Mode
Operational mode.

Parameters

directory

Mandatory. The absolute path to the file to be shown. Note that

the root directory (/) itself cannot be shown.

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

vyatta@R1:~$ show files /opt/vyatta/etc/config

total 8.0K
-rw-rw---- 1 root vyattacfg 777 May 20 10:13 config.boot
-rw-r----- 1 root root
712 May 20 10:13
config.boot.2008-05-20-1713.pre-migration
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

67

Chapter 3: System Management

show hardware cpu

show hardware cpu

Displays information about the systems processor.

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

vyatta@R1:~$ show hardware cpu

processor
: 0
vendor_id
: GenuineIntel
cpu family
: 6
model
: 15
model name
: Intel(R) Xeon(R) CPU
stepping
: 8
cpu MHz
: 1595.101
cache size
: 4096 KB
fdiv_bug
: no
hlt_bug
: no
f00f_bug
: no
coma_bug
: no
fpu
: yes

Command Reference

Rel VC4.1 v. 03

E5310

@ 1.60GHz

Vyatta

68

Chapter 3: System Management

show hardware cpu

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

Chapter 3: System Management

show hardware dmi

show hardware dmi

Displays information about the systems DMI.

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

vyatta@R1:~$ show hardware dmi

bios_date: 04/17/2006
bios_vendor: Phoenix Technologies LTD
bios_version: 6.00
board_asset_tag:
board_name: 440BX Desktop Reference Platform
board_vendor: Intel Corporation
board_version: None
chassis_asset_tag: No Asset Tag
chassis_type: 1
chassis_vendor: No Enclosure
chassis_version: N/A
product_name: VMware Virtual Platform
product_version: None

Command Reference

Rel VC4.1 v. 03

Vyatta

70

Chapter 3: System Management

show hardware dmi

sys_vendor: VMware, Inc.

vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

71

Chapter 3: System Management

show hardware mem

show hardware mem

Displays information about the systems memory.

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

vyatta@R1:~$ show hardware mem

MemTotal:
515972 kB
MemFree:
341468 kB
Buffers:
28772 kB
Cached:
116712 kB
SwapCached:
0 kB
Active:
35912 kB
Inactive:
117272 kB
HighTotal:
0 kB
HighFree:
0 kB
LowTotal:
515972 kB
LowFree:
341468 kB
SwapTotal:
0 kB
SwapFree:
0 kB
Dirty:
0 kB

Command Reference

Rel VC4.1 v. 03

Vyatta

72

Chapter 3: System Management

Writeback:
AnonPages:
Mapped:
Slab:
SReclaimable:
SUnreclaim:
PageTables:
NFS_Unstable:
Bounce:
CommitLimit:
Committed_AS:
VmallocTotal:
VmallocUsed:
VmallocChunk:
vyatta@R1:~$

Command Reference

show hardware mem

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

Chapter 3: System Management

show hardware pci

show hardware pci

Displays information about the systems PCI bus.

Syntax
show hardware pci [detailed]

Command Mode
Operational mode.

Parameters

detailed

Shows detailed information about the PCI bus.

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

vyatta@R1:~$ show hardware pci

00:00.0 Host bridge: Intel Corporation 440BX/ZX/DX 82443BX/ZX/DX Host bridge (rev 01)
00:01.0 PCI bridge: Intel Corporation 440BX/ZX/DX 82443BX/ZX/DX AGP bridge (rev 01)
00:07.0 ISA bridge: Intel Corporation 82371AB/EB/MB PIIX4 ISA
(rev 08)
00:07.1 IDE interface: Intel Corporation 82371AB/EB/MB PIIX4 IDE
(rev 01)
00:07.3 Bridge: Intel Corporation 82371AB/EB/MB PIIX4 ACPI (rev
08)

Command Reference

Rel VC4.1 v. 03

Vyatta

74

Chapter 3: System Management

show hardware pci

00:0f.0 VGA compatible controller: VMware Inc Abstract SVGA II

Adapter
00:10.0 SCSI storage controller: LSI Logic / Symbios Logic
53c1030 PCI-X Fusion-MPT Dual Ultra320 SCSI (rev 01)
00:11.0 Ethernet controller: Advanced Micro Devices [AMD] 79c970
[PCnet32 LANCE] (rev 10)
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

75

Chapter 3: System Management

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

Shows the date and time according to the system clock.

name

Shows the name configured for this system.

os

Shows details about the systems operating system.

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

vyatta@R1:~$ show host lookup R2

R2.vyatta.com
A
10.1.0.3
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

76

Chapter 3: System Management

show host

Example 3-14 shows the name configured for router R1.

Example 3-14 show host name: Showing network host names

vyatta@R1:~$ show host name

R1
vyatta@R1:~$

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

vyatta@R1:~$ show host date

Mon Jan 21 17:28:47 PST 2008
vyatta@R1:~$

Example 3-16 shows information about the operating system.

Example 3-16 show host os: Showing operating system information

vyatta@R1:~$ show host os

Linux R1 2.6.23-1-486-vyatta #1 SMP Tue Jan 15 02:00:31 PST 2008
i686 GNU/Linux
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

77

Chapter 3: System Management

show interfaces

show interfaces
Displays information about system interfaces.

Syntax
show interfaces [detailed | system [enabled]]

Command Mode
Operational mode.

Parameters

detailed

Displays deatailed information about all the interfaces available on your

system.

system

Displays all the physical interfaces available on your system.

enabled

Shows only enabled system interfaces known to the operating system

kernel.

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

Chapter 3: System Management

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

vyatta@R1:~$ show interfaces system enabled

eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc
pfifo_fast qlen 100
link/ether 00:30:48:82:e2:0c brd ff:ff:ff:ff:ff:ff
inet 10.1.0.54/24 brd 10.1.0.255 scope global eth0
inet6 fe80::230:48ff:fe82:e20c/64 scope link
valid_lft forever preferred_lft forever
RX: bytes
348646
TX: bytes
168294

packets
4144
packets
1594

errors
0
errors
0

dropped
0
dropped
0

overrun
mcast
0
0
carrier collisions
0
0

eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc

pfifo_fast qlen 10
link/ether 00:30:48:82:e2:0d brd ff:ff:ff:ff:ff:ff
inet 172.16.215.2/24 brd 172.16.215.255 scope global eth1
inet6 fe80::230:48ff:fe82:e20d/64 scope link
valid_lft forever preferred_lft forever
RX: bytes
1384
TX: bytes
1990

packets
11
packets
18

errors
0
errors
0

dropped
0
dropped
0

overrun
mcast
0
0
carrier collisions
0
0

eth2: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc

lines 1-23

Command Reference

Rel VC4.1 v. 03

Vyatta

79

Chapter 3: System Management

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

Chapter 3: System Management

show license

Examples
Example 3-18 shows the first screen of output for show license.
Example 3-18 show license: Displaying license information

GNU GENERAL PUBLIC LICENSE

Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA
02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General
Public
License is intended to guarantee your freedom to share and change
free
software--to make sure the software is free for all its users.
This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors
commit to
using it. (Some other Free Software Foundation software is
covered by
the GNU Library General Public License instead.) You can apply
it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure
that you
have the freedom to distribute copies of free software (and
charge for
this service if you wish), that you receive source code or can
get it
if you want it, that you can change the software or use pieces
of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the
rights.
These restrictions translate to certain responsibilities for you

Command Reference

Rel VC4.1 v. 03

Vyatta

81

Chapter 3: System Management

show license

if you
distribute copies of the software, or if you modify it.

Command Reference

Rel VC4.1 v. 03

Vyatta

82

Chapter 3: System Management

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

Shows the status of the connection to the NTP server at the

specified IPv4 address.

69.59.150.135

Shows the status of the connection to the Vyatta NTP server,

specified by IP address.

ntp.vyatta.com

Shows the status of the connection to the Vyatta NTP server,

specified by Fully Qualified Domain Name (FQDN).

localhost

Shows the status of the local router, specified by its hostname.

localhost-fqdn

Shows the status of the local router, specified by its Fully

Qualified Domain Name (FQDN).

localhost

Shows the status of the NTP server on the local router.

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

Chapter 3: System Management

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

Chapter 3: System Management

show system boot-messages

show system boot-messages

Displays boot messages generated by the kernel.

Syntax
show system boot-messages [all]

Command Mode
Operational mode.

Parameters

all

Displays all kernel boot messages.

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

vyatta@R1:~$ show system boot-messages

Linux version 2.6.23-1-486-vyatta (autobuild@sydney) (gcc
version 4.2.3 20071123 (prerelease) (Debian 4.2.2-4)) #1 SMP Fri
Jan 18 07:17:50 PST 2008
BIOS-provided physical RAM map:
BIOS-e820: 0000000000000000 - 000000000009f800 (usable)
BIOS-e820: 000000000009f800 - 00000000000a0000 (reserved)
BIOS-e820: 00000000000f0000 - 0000000000100000 (reserved)
BIOS-e820: 0000000000100000 - 000000001fee0000 (usable)
BIOS-e820: 000000001fee0000 - 000000001fee3000 (ACPI NVS)
BIOS-e820: 000000001fee3000 - 000000001fef0000 (ACPI data)
BIOS-e820: 000000001fef0000 - 000000001ff00000 (reserved)
BIOS-e820: 00000000fec00000 - 0000000100000000 (reserved)

Command Reference

Rel VC4.1 v. 03

Vyatta

85

Chapter 3: System Management

show system boot-messages

0MB HIGHMEM available.

510MB LOWMEM available.
found SMP MP-table at 000f5a20
Entering add_active_range(0, 0, 130784) 0 entries of 256 used
Zone PFN ranges:
DMA
0 ->
4096
Normal
4096 ->
130784
HighMem
130784 ->
130784
Movable zone start PFN for each node
early_node_map[1] active PFN ranges
0:
0 ->
130784
On node 0 totalpages: 130784
lines 1-22

Command Reference

Rel VC4.1 v. 03

Vyatta

86

Chapter 3: System Management

show system connections

show system connections

Displays active network connections on the system.

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

vyatta@R1:~$ show system connections

Active Internet connections (servers and established)
Proto Recv-Q Send-Q Local Address
Foreign Address
State
tcp
0
0 localhost:2912
*:*
tcp
0
0 localhost:3777
*:*
tcp
0
0 localhost:2177
*:*
tcp
0
0 localhost:1700
*:*
tcp
0
0 localhost:1893
*:*
tcp
0
0 localhost:4165
*:*
tcp
0
0 localhost:4744
*:*
tcp
0
0 localhost:34281
*:*
tcp
0
0 localhost:2862
*:*
tcp
0
0 localhost:sa-msg-port
*:*
LISTEN

Command Reference

Rel VC4.1 v. 03

LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN
LISTEN

Vyatta

87

Chapter 3: System Management

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

show system connections

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

Chapter 3: System Management

show system kernel-messages

show system kernel-messages

Displays messages in the kernel ring buffer.

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

vyatta@R1:~$ show system kernel-messages

Linux version 2.6.16 (autobuild@phuket.vyatta.com) (gcc version
4.1.1) #1 Tue Dec 5 15:56:41 PST 2006
BIOS-provided physical RAM map:
BIOS-e820: 0000000000000000 - 000000000009f800 (usable)
BIOS-e820: 000000000009f800 - 00000000000a0000 (reserved)
BIOS-e820: 00000000000f0000 - 0000000000100000 (reserved)
BIOS-e820: 0000000000100000 - 000000000fee0000 (usable)
BIOS-e820: 000000000fee0000 - 000000000fee3000 (ACPI NVS)
BIOS-e820: 000000000fee3000 - 000000000fef0000 (ACPI data)
BIOS-e820: 000000000fef0000 - 000000000ff00000 (reserved)
BIOS-e820: 00000000fec00000 - 0000000100000000 (reserved)
0MB HIGHMEM available.
254MB LOWMEM available.
found SMP MP-table at 000f5a20

Command Reference

Rel VC4.1 v. 03

Vyatta

89

Chapter 3: System Management

show system kernel-messages

On node 0 totalpages: 65248

DMA zone: 4096 pages, LIFO batch:0
DMA32 zone: 0 pages, LIFO batch:0
Normal zone: 61152 pages, LIFO batch:15
HighMem zone: 0 pages, LIFO batch:0
DMI 2.3 present.
Intel MultiProcessor Specification v1.4
Virtual Wire compatibility mode.
OEM ID: OEM00000 Product ID: PROD00000000 APIC at: 0xFEE00000
lines 1-23

Command Reference

Rel VC4.1 v. 03

Vyatta

90

Chapter 3: System Management

show system memory

show system memory

Displays system memory usage.

Syntax
show system memory [quagga]

Command Mode
Operational mode.

Parameters

quagga

Displays memory usage by the Quagga subsystem.

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

vyatta@R1:~$ show system memory

total
used
free
Mem:
256280
136732
119548
Swap:
0
0
0
Total:
256280
136732
119548
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

shared
0

buffers cached
19540
65772

Vyatta

91

Chapter 3: System Management

show system processes

show system processes

Displays active system processes.

Syntax
show system processes [summary]

Command Mode
Operational mode.

Parameters

summary

Shows a summary of system usage.

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

vyatta@R1:~$ show system processes

PID TTY
STAT
TIME COMMAND
1 ?
S
0:01 init [2]
2 ?
SN
0:00 [ksoftirqd/0]
3 ?
S<
0:00 [events/0]
4 ?
S<
0:00 [khelper]
5 ?
S<
0:00 [kthread]
7 ?
S<
0:00 [kblockd/0]
10 ?
S<
0:00 [khubd]
68 ?
S
0:00 [pdflush]
69 ?
S
0:00 [pdflush]
71 ?
S<
0:00 [aio/0]

Command Reference

Rel VC4.1 v. 03

Vyatta

92

Chapter 3: System Management

70 ?
656 ?
1481 ?
1484 ?
1486 ?
1723 ?
1877 ?
2548 ?
3141 ?
3147 ?
3190 ?
[lines 1-23]

Command Reference

show system processes

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

Chapter 3: System Management

show system storage

show system storage

Displays system file system usage and available storage space.

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

vyatta@R1:~$ show system storage

Filesystem
Size Used Avail Use% Mounted on
rootfs
953M 287M 618M 32% /
udev
10M
28K
10M
1% /dev
/dev/hda1
953M 287M 618M 32% /
/dev/hda1
953M 287M 618M 32% /dev/.static/dev
tmpfs
126M 4.0K 126M
1% /dev/shm
/dev/hda2
9.7M 1.5M 7.8M 17% /opt/vyatta/etc/config
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

94

Chapter 3: System Management

show system uptime

show system uptime

Displays information on how long the system has been running.

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

vyatta@R1:~$ show system uptime

20:45:59 up 3:04, 2 users, load average: 0.00, 0.00, 0.00
vyatta@R1:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

95

Chapter 3: System Management

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

Saves the support information to a file in the

/opt/vyatta/etc/config/support directory. The file name takes the
format hostname.tech-support.timestamp,where hostname is the host
name configured for the Vyatta device and timestamp is the time the file
was saved in the format YYYY-MM-DD-hhmmss.
A rotation mechanism is used to limit the number of output files to 10;
that is, creating an eleventh file causes the oldest file to be deleted.

filename

Saves the support information to the file

filename.hostname.tech-support.timestamp,where hostname is the host
name configured for the Vyatta device and timestamp is the time the file
was saved. If an absolute path is prepended to filename, the file is saved
in that location. Otherwise, the file is saved to a location relative to the
default path, which is /opt/vyatta/etc/config/support directory.

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

Chapter 3: System Management

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

vyatta@R1:~$ show tech-support

---------------Current time
---------------Mon Jan 21 21:48:09 GMT 2008
---------------OFR Version and Package Changes
---------------Version :
3.0
Built by:
autobuild@vyatta.com
Built on:
Tue Jan 15 10:31:21 UTC 2008
Build ID:
0801151031f209cb6
Booted From: livecd
---------------Installed Packages
---------------Desired=Unknown/Install/Remove/Purge/Hold
|
Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-i
nstalled
|/ Err?=(none)/Hold/Reinst-required/X=both-problems
(Status,Err: uppercase=bad)
||/ Name
Version
Description
+++-=================================-====================-====
========================================
lines 1-23

Command Reference

Rel VC4.1 v. 03

Vyatta

97

Chapter 3: System Management

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

Show all packages that have been added, deleted, downgraded,

or upgraded since the last baseline version upgrade.

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

Shows the version of quagga code used in the system.

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

Chapter 3: System Management

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

vyatta@vyatta:~$ show version all

Version :
3.0
Built by:
autobuild@vyatta.com
Built on:
Tue Jan 15 10:31:21 UTC 2008
Build ID:
0801151031f209cb6
Booted From: livecd
ADDED:
Aii aptitude 0.4.4-4
Aii libc6 2.3.6.ds1-13
Aii libdb4.4 4.4.20-8
Aii libexpat1 1.95.8-3.4
Aii libncurses5 5.5-5
Aii libnetaddr-ip-perl 3.14-2
Aii libpam0g 0.79-4
Aii libsasl2 2.1.22.dfsg1-8
Aii libtasn1-3 0.3.6-2

Command Reference

Rel VC4.1 v. 03

Vyatta

99

Chapter 3: System Management

show version

Aii libwrap0 7.6.dbs-13

Aii snmp 5.2.3-7
Aii supported-version 2.2
:
vyatta@vyatta:~$

Example 3-30 shows sample output for the show version added command.
Example 3-30 show version added: Displaying information about added software
packages

vyatta@vyatta:~$ show version added

Version :
3.0
Built by:
autobuild@vyatta.com
Built on:
Tue Jan 15 10:31:21 UTC 2008
Build ID:
0801151031f209cb6
Booted From: livecd
ADDED:
Aii aptitude 0.4.4-4
Aii libc6 2.3.6.ds1-13
Aii libdb4.4 4.4.20-8
Aii libexpat1 1.95.8-3.4
Aii libncurses5 5.5-5
Aii libnetaddr-ip-perl 3.14-2
Aii libpam0g 0.79-4
Aii libsasl2 2.1.22.dfsg1-8
Aii libtasn1-3 0.3.6-2
Aii libwrap0 7.6.dbs-13
Aii snmp 5.2.3-7
Aii supported-version 2.2
Aii sysvinit 2.86.ds1-38
Aii tasksel 2.66
Aii vyatta-bgp 1.4-9
Aii vyatta-cli 2.1.1-9
Aii vyatta-config-migrate 2.1.1-4
Aii vyatta-dhcp-support 2.1.1-4
Aii vyatta-firewall 1.4-9
Aii vyatta-nat 2.1.1-5
Aii vyatta-nat-cli 2.1.1-4
Aii vyatta-nat-xorp 2.1.1-3
Aii vyatta-ospf 1.4-9

Command Reference

Rel VC4.1 v. 03

Vyatta

100

Chapter 3: System Management

show version

Aii vyatta-rip 1.4-9

Aii vyatta-xg 1.4-9
Aii zlib1g 1.2.3-13
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

101

Chapter 3: System Management

system domain-name <domain>

system domain-name <domain>

Sets the systems domain.

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

Mandatory. The domain where the router resides; for example,

vyatta.com. The format is a string containing letters,
numbers, hyphens (-) and one period.

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

Chapter 3: System Management

system domain-search domain <domain>

system domain-search domain <domain>

Defines a set of domains for domain completion.

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

Mandatory. Multi-node. The domain name to be added to or deleted

from the list of domains in the search order string. The format is a
string specifying a domain; for example vyatta.com. Letters,
numbers, hyphens (-) and one period (.) are allowed.
You can specify up to 6 domains by creating up to 6 domain-search
multi-nodes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

103

Chapter 3: System Management

system domain-search domain <domain>

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

Chapter 3: System Management

system gateway-address <address>

system gateway-address <address>

Specifies the default gateway for the router.

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

Mandatory. The IPv4 address of the default gateway.

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

Chapter 3: System Management

system host-name <name>

system host-name <name>

Sets the host name for the router.

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

The name you want to give the router. Letters, numbers,

and hyphens (-) only are allowed.
The default is vyatta. If you delete the host name, or if
you try to delete the system node, the host name reverts to
the default.

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

Chapter 3: System Management

system name-server <address>

system name-server <address>

Specifies the DNS name servers available to the router.

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

Chapter 3: System Management

system ntp-server <name>

system ntp-server <name>

Specifies the NTP servers to use when synchronizing the routers clock.

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

Multi-node. The IP address or host name of an NTP server. The router

will automatically obtain the system date and time from the specified
server(s).
You can specify multiple NTP servers by creating multiple instances of
the name-server configuration node.

Default
By default, the system uses the NTP server at ntp.vyatta.com.

Command Reference

Rel VC4.1 v. 03

Vyatta

108

Chapter 3: System Management

system ntp-server <name>

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

Chapter 3: System Management

system options reboot-on-panic <value>

system options reboot-on-panic <value>

Allows you set system behavior on system panic.

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

Mandatory. Indicates whether or not the system should

automatically reboot if a kernel panic occurs. Supported values
are as follows:
true: The system reboots if a kernel panic occurs.
false: The system does not reboot if a kernel panic occurs.

Default
The default is true.

Command Reference

Rel VC4.1 v. 03

Vyatta

110

Chapter 3: System Management

system options reboot-on-panic <value>

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

Chapter 3: System Management

system static-host-mapping host-name <name>

system static-host-mapping host-name <name>

Defines a static mapping between a host name and an IP address.

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

Multi-node. The Fully Qualified Domain Name (FQDN)

name being statically mapped to an IP address (for
example, router1@mydomain.com). Letters, numbers,
periods (.) and hyphens (-) only are allowed.
You can define multiple mappings by creating multiple
host-name configuration nodes.

address

Mandatory. The IPv4 address of the interface being

statically mapped to the host name.

alias

Optional. Multi-node. An alias for the interface. Letters,

numbers, and hyphens are allowed.
You can define multiple aliases for a host by creating
multiple alias configuration nodes.

Command Reference

Rel VC4.1 v. 03

Vyatta

112

Chapter 3: System Management

system static-host-mapping host-name <name>

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

Chapter 3: System Management

system time-zone <zone>

system time-zone <zone>

Sets the time zone for the local system clock.

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

A string representing the time-zone and offset from UTC, enclosed in

double quotes.
The format is GMT [{+ | -}h], where h is a number from 1 to 12
representing the hours offset from GMT (see Usage Guidelines,
below). The string must be enclosed in double quotes. The following
time zone names, enclosed in double quotes, are also accepted:
Los Angeles: Sets the time zone to Los Angeles time.
New York: Sets the time zone to New York time.
Denver: Sets the time zone to Denver time.
Chicago: Sets the time zone to Chicago time.
Anchorage: Sets the time zone to Anchorage time.
Honolulu: Sets the time zone to Honolulu time.
Phoenix: Sets the time zone to Phoenix time.

Default
The default is GMT (Greenwich Mean Time).

Command Reference

Rel VC4.1 v. 03

Vyatta

114

Chapter 3: System Management

system time-zone <zone>

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

Chapter 3: System Management

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

Sets the terminal screen length to a given number of rows.

pager

The program to use as the terminal pager. If none is specified,

the default (less) is used.

width

Sets the terminal screen width to a given number of columns.

Default
None.

Usage Guidelines
Use this command to set the terminal behavior.

Command Reference

Rel VC4.1 v. 03

Vyatta

116

117

Chapter 4: User Management

This chapter lists the commands available for setting up user accounts and user
authentication.
This chapter contains the following commands.
Command

Description

User Management Configuration Commands

system login

Creates the configuration node for user management and authentication.

system login radius-server <address>

Defines a RADIUS server for user authentication.

system login user <user>

Creates a user account.

system login user <user>

authentication

Sets an authentication password for a user.

system login user <user> full-name

<name>

Allows you to specify a users full name.

system login user <user> level

Specifies a users privilege level and system access.

User Management Operational Commands

show users

Shows which users are currently logged on to the system.

Chapter 4: User Management

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

Chapter 4: User Management

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.

Where RADIUS servers are configured, RADIUS authentication is attempted first.

RADIUS servers are queried in the order of they were configuration: if a query times out,
the next server in the list is queried. If all queries fail, the system attempts to authenticate
the user through the local Vyatta authentication database. If local authentication fails, the
access attempt is rejected.
Use the set form of this command to create the login configuration node.
Use the delete form of this command to restore default user information and authentication
information.
Use the show form of this command to view user and authentication configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

119

Chapter 4: User Management

system login radius-server <address>

system login radius-server <address>

Defines a RADIUS server for user authentication.

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

Mandatory. Multi-node. The IP address of a remote authentication

server running the RADIUS protocol. This server can be used to
authenticate multiple users.
You can define multiple RADIUS servers by creating multiple
radius-server configuration nodes.

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

Chapter 4: User Management

timeout

system login radius-server <address>

Optional. The interval, in seconds, after which, if the RADIUS server

has not responded, the next configured RADIUS server should be
queried. The default is 2.

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.

Where RADIUS servers are configured, RADIUS authentication is attempted first.

RADIUS servers are queried in the order of they were configuration: if a query times out,
the next server in the list is queried. If all queries fail, the system attempts to authenticate
the user through the local Vyatta authentication database. If local authentication fails, the
access attempt is rejected.
Where RADIUS authentication is used, some delay can be expected; this will depend on .
the cumulative timeout values configured for all RADIUS servers.
RADIUS servers only authenticate user passwords. Using RADIUS authentication does
not not affect a users configured privilege level.
The RADIUS secret is specified in plain text. RADIUS secrets are stored in plain text on
the system, and used as part of a cryptographic operation for transferring authentication
information securely over the network. When you view RADIUS secrets, they are
displayed in plain text.
Use the set form of this command to define a RADIUS server.
Use the delete form of this command to remove a RADIUS server.
Use the show form of this command to view RADIUS server configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

121

Chapter 4: User Management

Command Reference

system login radius-server <address>

Rel VC4.1 v. 03

Vyatta

122

Chapter 4: User Management

system login user <user>

system login user <user>

Creates a user account.

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

Mandatory. Multi-node. A unique user ID of up to 32 characters,

including alphanumeric characters or hyphens.
You can define multiple user accounts by creating multiple user
configuration nodes.

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

Chapter 4: User Management

system login user <user>

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

Chapter 4: User Management

system login user <user> authentication

system login user <user> authentication

Sets an authentication password for a user.

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

Mandatory. A unique user ID of up to 32 characters, including

alphanumeric characters or hyphens.

epwd

The password to be encrypted, specified in plain text.

ppwd

The users password, specified in plain text.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

125

Chapter 4: User Management

system login user <user> authentication

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

Chapter 4: User Management

system login user <user> full-name <name>

system login user <user> full-name <name>

Allows you to specify a users full name.

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

Mandatory. A unique user ID of up to 32 characters, including

alphanumeric characters or hyphens.

name

Mandatory. A string representing the users name, including

alphanumeric characters, space, and hyphens. Strings that include
spaces must be enclosed in double quotes.

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

Chapter 4: User Management

system login user <user> full-name <name>

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

Chapter 4: User Management

system login user <user> level

system login user <user> level

Specifies a users privilege level and system access.

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

Mandatory. A unique user ID of up to 32 characters, including

alphanumeric characters or hyphens.

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

Chapter 4: User Management

system login user <user> level

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

Chapter 4: User Management

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

Chapter 5: Basic Services

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

DHCP Configuration Commands

service dhcp-relay

Configures the system to relay DHCP client

messages to an off-net DHCP server.

service dhcp-relay interface <interface>

Specifies the interface to use for accepting DHCP

requests or relaying DHCP client messages.

service dhcp-relay relay-options

Specifies whether to add the Relay Agent

Information option (option 82) to the
client-to-server packet.

service dhcp-relay server <ipv4>

Sets the IP address of the DHCP server.

service dhcp-server

Enables DHCP server functionality.

service dhcp-server disabled <state>

Allows you to disable the DHCP server without

discarding configuration.

service dhcp-server shared-network-name <name>

Defines a pool of addresses for DHCP leases.

Chapter 5: Basic Services

133

Command

Description

service dhcp-server shared-network-name <name> subnet

<ipv4net>

Specifies the IPv4 network to be served by a DHCP

address pool.

service dhcp-server shared-network-name <name> subnet

<ipv4net> authoritative <state>

Specifies whether the DHCP server is authoritative.

service dhcp-server shared-network-name <name> subnet

<ipv4net> client-prefix-length <prefix>

Specifies the subnet prefix length to be assigned to

clients.

service dhcp-server shared-network-name <name> subnet

<ipv4net> default-router <ipv4>

Specifies the address of the default router for DHCP

clients on this subnet.

service dhcp-server shared-network-name <name> subnet

<ipv4net> dns-server <ipv4>

Specifies the address of a DNS server for DHCP

clients.

service dhcp-server shared-network-name <name> subnet

<ipv4net> domain-name <domain-name>

Provides the domain name for DHCP clients.

service dhcp-server shared-network-name <name> subnet

<ipv4net> exclude <ipv4>

Excludes an IP address to from a DHCP address

pool.

service dhcp-server shared-network-name <name> subnet

<ipv4net> failover

Enables DHCP failover functionality for a DHCP

address pool on a subnet.

service dhcp-server shared-network-name <name> subnet

<ipv4net> lease <seconds>

Specifies how long the address assigned by the

DHCP server will be valid.

service dhcp-server shared-network-name <name> subnet

<ipv4net> server-identifier <ipv4>

Specifies the address for the DHCP server identifier.

service dhcp-server shared-network-name <name> subnet

<ipv4net> start <ipv4> stop <ipv4>

Specifies the range of addresses that will be

assigned to DHCP clients.

service dhcp-server shared-network-name <name> subnet

<ipv4net> static-mapping

Specifies a static IP address for a specific DHCP

client.

service dhcp-server shared-network-name <name> subnet

<ipv4net> wins-server <ipv4>

Specifies the address of a WINS server that is

available to DHCP clients.

NAT Configuration Commands

service nat

NAT commands can be found in Chapter 19: NAT

SSH Configuration Commands

service ssh

Configures SSH as an access protocol on the

system.

service ssh allow-root <state>

Specifies whether or not root logins are allowed on

SSH connections.

service ssh port <port>

Specifies the port the system will use for the SSH
service.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 5: Basic Services

134

Command

Description

service ssh protocol-version <version>

Specifies which versions of SSH are enabled.

Telnet Configuration Commands

service telnet

Configures Telnet as an access protocol on the

system.

service telnet allow-root <state>

Specifies whether or not root logins are allowed on

Telnet connections.

service telnet port <port>

Specifies the port the system will use for the

Telnetservice.

Basic Services Operational Commands

clear dhcp client process

Restarts the DHCP client process.

clear dhcp lease ip <ipv4>

Removes the DHCP lease for the specified IP

address.

clear dhcp leases

Removes current DHCP leases.

show dhcp client leases

Displays DHCP client information.

show dhcp leases

Displays current DHCP lease information.

show dhcp statistics

Displays DHCP server statistics.

telnet <address>

Creates a terminal session to a Telnet server.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 5: Basic Services

clear dhcp client process

clear dhcp client process

Restarts the DHCP client process.

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

Chapter 5: Basic Services

clear dhcp lease ip <ipv4>

clear dhcp lease ip <ipv4>

Removes the DHCP lease for the specified IP address.

Syntax
clear dhcp lease ip ipv4

Command Mode
Operational mode.

Parameters

ipv4

Clears the DHCP lease for the specified IP address.

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

Chapter 5: Basic Services

clear dhcp leases

clear dhcp leases

Removes current DHCP leases.

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

Chapter 5: Basic Services

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

Chapter 5: Basic Services

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

Chapter 5: Basic Services

service dhcp-relay interface <interface>

service dhcp-relay interface <interface>

Specifies the interface to use for accepting DHCP requests or relaying DHCP client
messages.

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

Mandatory. Multi-node. The interface to use to accept DHCP requests or

relay DHCP client messages. If the interface through which requests are
received is different from the interface used to reach the DHCP server
specified in the request, both interfaces must be configured.
You can assign multiple interfaces to be used for DHCP by creating
multiple interface configuration nodes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

140

Chapter 5: Basic Services

service dhcp-relay interface <interface>

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

Chapter 5: Basic Services

service dhcp-relay relay-options

service dhcp-relay relay-options

Specifies whether to add the Relay Agent Information option (option 82) to the
client-to-server packet.

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

Optional. Sets the time-to-live, in seconds, for outgoing

relayed messages. The range is 1 to 255. The default is 10.

Rel VC4.1 v. 03

Vyatta

142

Chapter 5: Basic Services

max-size size

service dhcp-relay relay-options

Optional. Sets the maximum size of the DHCP packet to be

created after appending the relay agent information option.
If, after appending the information, the packet would
exceed this size, the packet is forwarded without appending
the information. The range is 64 to 1400. The default is
576.
If this option not configured, the router does not forward
DHCP packets that exceed the MTU of the interface on
which relaying is configured.

port port

Optional. Specifies the port on this interface to be used for

relaying DHCP client messages. The range is 1 to 65535.

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

Chapter 5: Basic Services

service dhcp-relay server <ipv4>

service dhcp-relay server <ipv4>

Sets the IP address of the DHCP server.

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

Mandatory. Multi-node. The IP address of the DHCP server.

You can relay messages to more than one DHCP server, by creating
multiple server configuration nodes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

144

Chapter 5: Basic Services

service dhcp-relay server <ipv4>

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

Chapter 5: Basic Services

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

Chapter 5: Basic Services

service dhcp-server disabled <state>

service dhcp-server disabled <state>

Allows you to disable the DHCP server without discarding configuration.

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

The administrative state of the DHCP server. Supported values are as

follows:
true: Disables DHCP server without discarding configuration.
false: Enables the DHCP server.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name>

service dhcp-server shared-network-name <name>

Defines a pool of addresses for DHCP leases.

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

Mandatory. Multi-node. The name for the DHCP address pool.

You can define multiple address pools by creating multiple
shared-network-name configuration nodes, each with a
different 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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net>

service dhcp-server shared-network-name <name>

subnet <ipv4net>
Specifies the IPv4 network to be served by a DHCP address pool.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network to be served with the

addresses defined the specified address pool. The format is
ip-addr/prefix.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

149

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net>

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>

service dhcp-server shared-network-name <name>

subnet <ipv4net> authoritative <state>
Specifies whether the DHCP server is authoritative.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

authoritative

Optional. Specifies whether the DHCP server is the

authoritative server. Supported values are as follows:
enable: Enables authoritative state.
disable: Disables authoritative state.
The default is disable.

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-

service dhcp-server shared-network-name <name>

subnet <ipv4net> bootfile-name <bootfile>
Specifies a bootstrap file from which diskless PCs can 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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

bootfile

The name of the bootstrap file to be used to boot.

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

service dhcp-server shared-network-name <name>

subnet <ipv4net> client-prefix-length <prefix>
Specifies the subnet prefix length to be assigned to clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

prefix

Optional. The subnet prefix length that will be assigned to each

client. By default, the prefix length defined in the subnet
parameter is assigned. The range is 0 to 32.

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>

service dhcp-server shared-network-name <name>

subnet <ipv4net> default-router <ipv4>
Specifies the address of the default router for DHCP clients on this subnet.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Gives the address of the default router for DHCP

clients on this subnet. The default router should be on the same
subnet as the client. The format is an IP address.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> dns-server <ipv4>

service dhcp-server shared-network-name <name>

subnet <ipv4net> dns-server <ipv4>
Specifies the address of a DNS server for DHCP clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Multi-node. The IPv4 address of the DNS server .

You can specify more than one DNS server by issuing this
statement multiple times.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

159

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> dns-server <ipv4>

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-

service dhcp-server shared-network-name <name>

subnet <ipv4net> domain-name <domain-name>
Provides the domain name for DHCP clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

domain-name

Optional. The domain name to be given to DHCP clients on this

subnet. A domain name can include letters, numbers, hyphens
(-), and one period (.). For example, vyatta.com.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> exclude <ipv4>

service dhcp-server shared-network-name <name>

subnet <ipv4net> exclude <ipv4>
Excludes an IP address to from a DHCP address pool.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Multi-node. The IP address to be excluded from the

lease range.
You can exclude more than one IP address by creating multiple
exclude configuration nodes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

163

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> exclude <ipv4>

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> failover

service dhcp-server shared-network-name <name>

subnet <ipv4net> failover
Enables DHCP failover functionality for a DHCP address pool on a subnet.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

165

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> failover

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 time on the servers must be exactly synchronized.

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

service dhcp-server shared-network-name <name>

subnet <ipv4net> failover local-address <ipv4>
Specifies the DHCP failover IP address for the local failover peer.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

The IP address for the local failover peer.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> failover name

service dhcp-server shared-network-name <name>

subnet <ipv4net> failover name <peer-name>
Specifies the DHCP failover peer name for the local peer.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

peer-name

The DHCP failover peer name for the local peer.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

169

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> failover name

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

service dhcp-server shared-network-name <name>

subnet <ipv4net> failover peer-address <ipv4>
Specifies the DHCP failover IP address for the local peer.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Specifies the IP address for the failover peer.

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-

service dhcp-server shared-network-name <name>

subnet <ipv4net> failover status <status>
Specifies the DHCP failover status for this peer.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

status

Indicates whether this peer is the primary or secondary peer in

the failover configuration. Supported values are as follows:
primary: The local system is primary peer.
secondary: The local system is the secondary peer.

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

service dhcp-server shared-network-name <name>

subnet <ipv4net> ip-forwarding enable <state>
Specifies whether the client should configure its IP layer for packet forwarding.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

Rel VC4.1 v. 03

Vyatta

175

Chapter 5: Basic Servicesservice dhcp-server shared-network-name <name> subnet <ipv4net> ip-forwarding enable

state

Specifies whether or not the client should configure its IP layer

for packet forwarding. Supported values are as follows:
true: The client should configure its IP later for packet
forwarding.
false: The client should not configure its IP later for packet
forwarding.
The default false.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> lease <seconds>

service dhcp-server shared-network-name <name>

subnet <ipv4net> lease <seconds>
Specifies how long the address assigned by the DHCP server will be valid.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

seconds

Optional. Specifies how long the address assigned by the

DHCP server will be valid, in seconds. The range is 120 to
4294967296.

Default
The default is 86400 (24 hours).

Command Reference

Rel VC4.1 v. 03

Vyatta

177

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> lease <seconds>

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> ntp-server <ipv4>

service dhcp-server shared-network-name <name>

subnet <ipv4net> ntp-server <ipv4>
Specifies the address of an NTP (Network Time Protocol) server available to clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Specifies the IP address of an NTP server available to

clients. Multiple NTP server addresses can be specified in
separate commands. The list of NTP servers should be specified
in order of preference.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

179

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> ntp-server <ipv4>

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> pop-server <ipv4>

service dhcp-server shared-network-name <name>

subnet <ipv4net> pop-server <ipv4>
Specifies the address of a POP3 (Post Office Protocol 3) server available to clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Specifies the IP address of an POP3 server available

to clients. Multiple POP3 server addresses can be specified in
separate commands. The list of POP3 servers should be
specified in order of preference.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

181

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> pop-server <ipv4>

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> server-identifier

service dhcp-server shared-network-name <name>

subnet <ipv4net> server-identifier <ipv4>
Specifies the address for the DHCP server identifier.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Specifies the address for the DHCP server identifier.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

183

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> server-identifier

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>

service dhcp-server shared-network-name <name>

subnet <ipv4net> smtp-server <ipv4>
Specifies the address of a SMTP (Simple Mail Transfer Protocol) server available to
clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Specifies the IP address of an SMTP server available

to clients. Multiple SMTP server addresses can be specified in
separate commands. The list of SMTP servers should be
specified in order of preference.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> start <ipv4> stop

service dhcp-server shared-network-name <name>

subnet <ipv4net> start <ipv4> stop <ipv4>
Specifies the range of addresses that will be assigned to DHCP clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

start

Optional. Multi-node. The start address in an address range.

This is the first address in the range that can be assigned.
You can define multiple address ranges within an address pool,
by creating multiple start configuration nodes.

Command Reference

Rel VC4.1 v. 03

Vyatta

187

Chapter 5: Basic Services

stop

service dhcp-server shared-network-name <name> subnet <ipv4net> start <ipv4> stop

Mandatory. The stop address in this address range. This is the

last address in the range that can be assigned.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> static-mapping

service dhcp-server shared-network-name <name>

subnet <ipv4net> static-mapping
Specifies a static IP address for a specific DHCP client.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

Rel VC4.1 v. 03

Vyatta

189

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> static-mapping

mapname

Optional. Multi-node. Allows you to statically map an IP

address within an address pool to the MAC address of a device
on the network.
You can define multiple static mappings of this type by creating
multiple static-mapping configuration nodes.

ipv4

Mandatory. The IP address to be statically assigned to the

device.

mac

Mandatory. The MAC address to be statically mapped to the

specified IP address.

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-

service dhcp-server shared-network-name <name>

subnet <ipv4net> static-route destination-subnet
<ipv4net>
Specifies the destination subnet of a static route for clients to store in their routing cache.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4net2

Specifies the destination IP subnet of a static route for clients to

store in their routing table.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> static-route router

service dhcp-server shared-network-name <name>

subnet <ipv4net> static-route router <ipv4>
Specifies the router for the destination of a static route for clients to store in their routing
cache.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Specifies the IP address of the router for the destination of a

static route for clients to store in their routing cache.

Rel VC4.1 v. 03

Vyatta

193

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> static-route router

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> tftp-server-name

service dhcp-server shared-network-name <name>

subnet <ipv4net> tftp-server-name <servername>
Specifies the name of a TFTP (Trivial File Transfer Protocol) server available to clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

servername

Specifies the name of a TFTP server available to clients.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

195

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> tftp-server-name

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> time-offset <sec-

service dhcp-server shared-network-name <name>

subnet <ipv4net> time-offset <seconds>
Specifies the offset of the clients subnet in seconds from UTC (Coordinated Universal
Time).

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

seconds

Specifies the offset of the clients subnet in seconds from UTC

(Coordinated Universal Time).

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

197

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> time-offset <sec-

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> time-server <ipv4>

service dhcp-server shared-network-name <name>

subnet <ipv4net> time-server <ipv4>
Specifies the address of an RFC868 time server available to clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Specifies the IP address of an RFC868 time server

available to clients. Multiple time server addresses can be
specified in separate commands. The list of time servers should
be specified in order of preference.

Rel VC4.1 v. 03

Vyatta

199

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> time-server <ipv4>

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>

service dhcp-server shared-network-name <name>

subnet <ipv4net> wins-server <ipv4>
Specifies the address of a WINS server that is available to DHCP clients.

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

ipv4

Optional. Multi-node. Gives the address of a NetBIOS

Windows Internet Naming Server (WINS) available to DHCP
clients on this subnet. The WINS server provides a name
resolution services the Microsoft DHCP clients can use to
correlate host names to IP addresses.
You can specify more than one WINS server by issuing this
statement multiple times. The format is an IP address.

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

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> wpad-url <url>

service dhcp-server shared-network-name <name>

subnet <ipv4net> wpad-url <url>
Specifies the Web Proxy Autodiscovery (WPAD) URL

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

Mandatory. The DHCP address pool.

ipv4net

Mandatory. Multi-node. The IPv4 network served by the DHCP

address pool. The format is ip-addr/prefix.

url

Optional. Specifies the Web Proxy Autodiscovery (WPAD)

URL

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

203

Chapter 5: Basic Services

service dhcp-server shared-network-name <name> subnet <ipv4net> wpad-url <url>

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

Chapter 5: Basic Services

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

Chapter 5: Basic Services

service ssh allow-root <state>

service ssh allow-root <state>

Specifies whether or not root logins are allowed on SSH connections.

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

Specifies whether or not root logins are allowed on connections

to SSH. Supported values are as follows:
true: Root logins are allowed on SSH.
false: Root logins are not allowed on SSH.

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

Chapter 5: Basic Services

service ssh port <port>

service ssh port <port>

Specifies the port the system will use for the SSH service.

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

Chapter 5: Basic Services

service ssh protocol-version <version>

service ssh protocol-version <version>

Specifies which versions of SSH are enabled.

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

Specifies which versions of SSH are enabled. Supported values

are as follows:
v1: SSH version 1 is enabled.
v2: SSH version 2 is enabled.
all: Both SSH version 1 and SSH version 2 are enabled.

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

Chapter 5: Basic Services

service ssh protocol-version <version>

Use the show form of this command to view the protocol-version configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

209

Chapter 5: Basic Services

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

Chapter 5: Basic Services

service telnet allow-root <state>

service telnet allow-root <state>

Specifies whether or not root logins are allowed on Telnet connections.

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

Specifies whether or not root logins are allowed on connections

to Telnet. Supported values are as follows:
true: Root logins are allowed on Telnet.
false: Root logins are not allowed on Telnet.

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

Chapter 5: Basic Services

service telnet port <port>

service telnet port <port>

Specifies the port the system will use for the Telnetservice.

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

Chapter 5: Basic Services

show dhcp client leases

show dhcp client leases

Displays DHCP client information.

Syntax
show dhcp client leases [interface ethx]

Command Mode
Operational mode.

Parameters

ethx

Shows client information for the specified interface.

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

Chapter 5: Basic Services

show dhcp leases

show dhcp leases

Displays current DHCP lease information.

Syntax
show dhcp leases [pool pool-name]

Command Mode
Operational mode.

Parameters

pool-name

Shows lease information for the specified address pool.

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

Chapter 5: Basic Services

show dhcp statistics

show dhcp statistics

Displays DHCP server statistics.

Syntax
show dhcp statistics [pool pool-name]

Command Mode
Operational mode.

Parameters

pool-name

Shows DHCP statistics for the specified address pool

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

Chapter 5: Basic Services

telnet <address>

telnet <address>
Creates a terminal session to a Telnet server.

Syntax
telnet address [service]

Command Mode
Operational mode.

Parameters

address

Mandatory. The IP address or hostname of the Telnet server to

connect to.

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

vyatta@R1:~$ telnet 192.168.1.77

Entering character mode
Escape character is '^]'.

Command Reference

Rel VC4.1 v. 03

Vyatta

216

Chapter 5: Basic Services

telnet <address>

Welcome to Vyatta
vyatta login:

Command Reference

Rel VC4.1 v. 03

Vyatta

217

218

Chapter 6: Ethernet Interfaces, VLAN

Interfaces, and the Loopback Interface

This chapter lists the commands for configuring Ethernet interfaces, the loopback
interface, and VLAN interfaces.
This chapter contains the following commands.
Command

Description

Ethernet Interface Configuration Commands

interfaces ethernet <ethx>

Defines an Ethernet interface.

interfaces ethernet <ethx> address

Sets an IP address and network prefix for an Ethernet

interface.

interfaces ethernet <ethx> description <descr>

Specifies a description for an Ethernet interface.

interfaces ethernet <ethx> disable

Disables an Ethernet interface without discarding

configuration.

interfaces ethernet <ethx> disable-link-detect

Directs an Ethernet interface not to detect physical

link-state changes.

interfaces ethernet <ethx> duplex <duplexity>

Sets the duplex mode for an Ethernet interface.

interfaces ethernet <ethx> hw-id <mac-addr>

Specifies the MAC address of the Ethernet interface.

interfaces ethernet <ethx> mac <mac-addr>

Sets the MAC address of the Ethernet interface.

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

Command

Description

interfaces ethernet <ethx> mtu <mtu>

Specify the Maximum Transfer Unit (MTU) for an

Ethernet interface.

interfaces ethernet <ethx> smp_affinity <mask>

Sets the SMP affinity for the interface.

interfaces ethernet <ethx> speed <speed>

Sets the speed of an Ethernet interface.

219

Ethernet Vif Configuration Commands

interfaces ethernet <ethx> vif <vlan-id>

Defines a virtual interface on an Ethernet interface.

interfaces ethernet <ethx> vif <vlan-id> address

Specifies an IP address and network prefix for an

Ethernet virtual interface.

interfaces ethernet <ethx> vif <vlan-id> description

<descr>

Sets a description for a vif on an Ethernet interface.

interfaces ethernet <ethx> vif <vlan-id> disable

Disables a virtual interface without discarding

configuration.

interfaces ethernet <ethx> vif <vlan-id>

disable-link-detect

Directs an Ethernet vif not to detect physical link-state

changes.

Loopback Interface Configuration Commands

interfaces loopback lo

Defines the loopback interface.

interfaces loopback lo address

Sets an IP address and network prefix for the loopback

interface.

interfaces loopback lo description <descr>

Specifies a description for the loopback interface.

Ethernet Interface Configuration Commands Documented in Other Chapters

interfaces bridge <brx>

All commands for configuring bridging on Ethernet

interfaces and vifs are given in Chapter 12: Bridging.

interfaces ethernet <ethx> firewall

All commands for configuring firewall on Ethernet

interfaces and vifs are given in the Vyatta Security
Reference Guide.

interfaces ethernet <ethx> ip ospf

All commands for configuring OSPF on Ethernet

interfaces and vifs are given in Chapter 15: OSPF.

interfaces ethernet <ethx> ip rip

All commands for configuring RIP on Ethernet interfaces

and vifs are given in Chapter 14: RIP.

interfaces ethernet <ethx> pppoe <num>

All commands for configuring PPPoE on Ethernet

interfaces and vifs are given in Chapter 10: PPPoE.

interfaces ethernet <ethx> qos-policy out

<policy-name>

All commands for applying QoS policies to Ethernet

interfaces and vifs are given in Chapter 18: Quality of
Service Policies.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

Command

Description

interfaces ethernet <ethx> vrrp vrrp-group <group-id>

All commands for configuring VRRP on Ethernet

interfaces and vifs are given in the Vyatta High
Availability Reference Guide.

220

Ethernet Interface Clear Commands

clear interfaces ethernet counters

Clears statistics counters for Ethernet interfaces.

Ethernet Interface Show Commands

show interfaces ethernet

Displays information and statistics about Ethernet

interfaces.

show interfaces ethernet detail

Displays detailed information about Ethernet interfaces.

show interfaces ethernet <ethx> brief

Displays a brief status for an Ethernet interface.

show interfaces ethernet <ethx> identify

Blinks the LEDs on an Ethernet interface in order to

identify it.

show interfaces ethernet <ethx> physical

Displays physical layer information for Ethernet

interfaces.

show interfaces ethernet <ethx> queue

Displays Ethernet queuing information.

show interfaces ethernet <ethx> vif <vlan-id>

Displays information about an Ethernet vif.

show interfaces ethernet <ethx> vif <vlan-id> brief

Displays a brief status for an Ethernet vif.

show interfaces ethernet <ethx> vif <vlan-id> queue

Displays vif queuing information.

Ethernet Vif Show Commands

show interfaces ethernet <ethx> vif <vlan-id>

Displays information about an Ethernet vif.

Loopback Interface Clear Commands

clear interfaces loopback counters

Clears statistics counters for loopback interfaces.

Loopback Interface Show Commands

show interfaces loopback

Displays information about the loopback interface.

show interfaces loopback detail

Displays detailed information and statistics about the

loopback interface.

show interfaces loopback lo brief

Displays brief status information for the loopback

interface.

Ethernet Interface Operational Commands Documented in Other Chapters

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

221

Command

Description

clear arp address <ipv4>

Clears the systems ARP cache for the specified IP

address. See page 52 in Chapter 3: System
Management.

clear interfaces multilink

Clears counters for multilink interfaces See page 400 in

Chapter 8: Multilink Interfaces.

clear interfaces serial

Clears counters for serial interfaces See page 280 in

Chapter 7: Serial Interfaces.

clear interfaces tunnel counters

Clears tunnel interface statistics. See page 432 in

Chapter 9: Tunnel Interfaces.

show arp

Displays the systems ARP cache. See page 64 in

Chapter 3: System Management.

show interfaces

Displays information about system interfaces. See

page 78 in Chapter 3: System Management.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

clear interfaces ethernet counters

clear interfaces ethernet counters

Clears statistics counters for Ethernet interfaces.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

clear interfaces loopback counters

clear interfaces loopback counters

Clears statistics counters for loopback interfaces.

Syntax
clear interfaces loopback [lo] counters

Command Mode
Operational mode.

Parameters

lo

Optional. Clears statistics for the loopback lo interface only.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx>

interfaces ethernet <ethx>

Defines an Ethernet interface.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx>

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> address

interfaces ethernet <ethx> address

Sets an IP address and network prefix for an Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

ipv4net

Defines an IPv4 address on this interface. The format is

ip-address/prefix (for example, 192.168.1.77/24).
You can define multiple IP addresses for a single interface, by creating
multiple address configuration nodes.

dhcp

Defines the interface as a Dynamic Host Configuration Protocol

(DHCP) client, which obtains its address and prefix from a DHCP
server.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

226

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> address

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

interfaces ethernet <ethx> description <descr>

Specifies a description for an Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

descr

A mnemonic name or description for the Ethernet interface.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> disable

interfaces ethernet <ethx> disable

Disables an Ethernet interface without discarding configuration.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> dis-

interfaces ethernet <ethx> disable-link-detect

Directs an Ethernet interface not to detect physical link-state changes.

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

Mandatory. Multi-node. An identifier for the Ethernet interface

you are defining. The range is eth0 to eth23.

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-

interfaces ethernet <ethx> duplex <duplexity>

Sets the duplex mode for an Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

duplexity

Mandatory. The duplexity of the interface. Supported values are as

follows:
auto: The router automatically negotiates the duplexity with the
interface at the other end of the link.
half: Half duplex.
full: Full duplex.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> hw-id

interfaces ethernet <ethx> hw-id <mac-addr>

Specifies the MAC address of the Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> hw-id

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> mac

interfaces ethernet <ethx> mac <mac-addr>

Sets the MAC address of the Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> mac

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>

interfaces ethernet <ethx> mtu <mtu>

Specify the Maximum Transfer Unit (MTU) for an Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

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>

Use the set form of this command to specify the MTU.

Use the delete form of this command to remove MTU value and disable fragmentation.
Use the show form of this command to view MTU configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

238

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface interfaces ethernet <ethx> smp_affinity

interfaces ethernet <ethx> smp_affinity <mask>

Sets the SMP affinity for the interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> speed

interfaces ethernet <ethx> speed <speed>

Sets the speed of an Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

speed

Sets the speed of the interface. Supported values are as follows:

auto: The router autonegotiates the speed of the interface with the
interface at the other end of the connection.
10: 10 Mbps
100: 100 Mbps
1000: 1000 Mbps

Default
Ethernet link speed is autonegotiated.

Command Reference

Rel VC4.1 v. 03

Vyatta

241

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces ethernet <ethx> speed

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>

interfaces ethernet <ethx> vif <vlan-id>

Defines a virtual interface on an Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

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>

interfaces ethernet <ethx> vif <vlan-id> address

Specifies an IP address and network prefix for an Ethernet virtual interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

vlan-id

Mandatory. Multi-node. The VLAN ID for the vif. The range is 0 to

4095.

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

Defines the interface as a Dynamic Host Configuration Protocol

(DHCP) client, which obtains its address and prefix from a DHCP
server.

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>

interfaces ethernet <ethx> vif <vlan-id> description

<descr>
Sets a description for a vif on an Ethernet interface.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

vlan-id

Mandatory. The VLAN ID for the vif. The range is 0 to 4095.

descr

The description for the vif.

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>

Use the set form of this command to set a description.

Use the delete form of this command to remove the description for a vif.
Use the show form of this command to view the vif description configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

248

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceinterfaces ethernet <ethx> vif <vlan-id>

interfaces ethernet <ethx> vif <vlan-id> disable

Disables a virtual interface without discarding configuration.

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

Mandatory. Multi-node. An identifier for the Ethernet interface you are

defining. The range is eth0 to eth23.

vlan-id

Mandatory. The VLAN ID for the vif. The range is 0 to 4095.

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>

interfaces ethernet <ethx> vif <vlan-id>

disable-link-detect
Directs an Ethernet vif not to detect physical link-state changes.

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

Mandatory. Multi-node. An identifier for the Ethernet interface

you are defining. The range is eth0 to eth23.

vlan-id

Mandatory. The VLAN ID for the vif. The range is 0 to 4095.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces loopback lo

You can simplify collection of management information by specifying the loopback

interface as the interface for sending and receiving management information such as
logs and SNMP traps.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces loopback lo address

interfaces loopback lo address

Sets an IP address and network prefix for the loopback interface.

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

Defines the interface as a Dynamic Host Configuration Protocol

(DHCP) client, which obtains its address and prefix from a DHCP
server.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

interfaces loopback lo address

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-

interfaces loopback lo description <descr>

Specifies a description for the loopback interface.

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

The description for the loopback interface.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces ethernet

show interfaces ethernet

Displays information and statistics about Ethernet interfaces.

Syntax
show interfaces ethernet [ethx]

Command Mode
Operational mode.

Parameters

ethx

Displays information for the specified Ethernet interface.

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

vyatta@vyatta:~$ show interfaces ethernet

Interface
IP Address
State
eth0
admin down
eth1
up
eth2
10.1.0.66/24
up
eth3
up

Command Reference

Rel VC4.1 v. 03

Link
down
up
up
down

Description

Vyatta

258

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces ethernet

Example 6-2 shows information for interface eth2.

Example 6-2 show interfaces ethernet <ethx>: Displaying information for an Ethernet
interface

vyatta@vyatta:~$ show interfaces ethernet eth2

eth2: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc
pfifo_fast qlen 1000
link/ether 00:13:46:e7:f8:87 brd ff:ff:ff:ff:ff:ff
inet 10.1.0.66/24 brd 10.1.0.255 scope global eth2
inet6 fe80::211:46ff:fee7:f687/64 scope link
valid_lft forever preferred_lft forever
RX: bytes
533348
TX: bytes
54412

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces ethernet detail

show interfaces ethernet detail

Displays detailed information about Ethernet interfaces.

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

eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast qlen 1000

link/ether 00:40:63:e2:e3:dd brd ff:ff:ff:ff:ff:ff
inet6 fe80::240:63ff:fee2:e3dd/64 scope link
valid_lft forever preferred_lft forever
RX:

bytes

Command Reference

packets

errors

dropped

Rel VC4.1 v. 03

overrun

mcast

Vyatta

260

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

TX:

0
bytes
468

0
packets
6

0
errors
0

0
dropped
0

show interfaces ethernet detail

0
0
carrier collisions
0
0

eth2: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast qlen 1000

link/ether 00:13:46:e7:f8:87 brd ff:ff:ff:ff:ff:ff
inet 10.1.0.66/24 brd 10.1.0.255 scope global eth2
inet6 fe80::211:46ff:fee7:f687/64 scope link
valid_lft forever preferred_lft forever
lines 1-23

Command Reference

Rel VC4.1 v. 03

Vyatta

261

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface show interfaces ethernet <ethx> brief

show interfaces ethernet <ethx> brief

Displays a brief status for an Ethernet interface.

Syntax
show interfaces ethernet ethx brief

Command Mode
Operational mode.

Parameters

ethx

The specified Ethernet interface. This may be eth0 to eth23, depending

on what Ethernet interfaces that are actually available on the system.

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.

vyatta@vyatta:~$ show interfaces ethernet eth2 brief

Interface
IP Address
State
Link
Description
eth2
10.1.0.66/24
up
up

Command Reference

Rel VC4.1 v. 03

Vyatta

262

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interfaceshow interfaces ethernet <ethx> identi-

show interfaces ethernet <ethx> identify

Blinks the LEDs on an Ethernet interface in order to identify it.

Syntax
show interfaces ethernet ethx identify

Command Mode
Operational mode.

Parameters

ethx

The specified Ethernet interface. This may be eth0 to eth23, depending

on what Ethernet interfaces that are actually available on the system.

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.

vyatta@vyatta:~$ show interfaces ethernet eth2 identify

Interface eth2 should be blinking now.
Press Enter to stop...

Command Reference

Rel VC4.1 v. 03

Vyatta

263

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface show interfaces ethernet <ethx> physi-

show interfaces ethernet <ethx> physical

Displays physical layer information for Ethernet interfaces.

Syntax
show interfaces ethernet ethx physical

Command Mode
Operational mode.

Parameters

ethx

The specified Ethernet interface. This may be eth0 to eth23, depending

on what Ethernet interfaces that are actually available on the system.

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.

vyatta@vyatta:~$ show interfaces ethernet eth0 physical

Settings for eth0:
Supported ports: [ TP MII ]
Supported link modes:
10baseT/Half 10baseT/Full
100baseT/Half 100baseT/Full
Supports auto-negotiation: Yes
Advertised link modes: 10baseT/Half 10baseT/Full
100baseT/Half 100baseT/Full
Advertised auto-negotiation: Yes
Speed: 100Mb/s

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

show interfaces ethernet <ethx> queue

Displays Ethernet queuing information.

Syntax
show interfaces ethernet ethx queue [class | filter]

Command Mode
Operational mode.

Parameters

ethx

The specified Ethernet interface. This may be eth0 to eth23, depending

on what Ethernet interfaces that are actually available on the system.

class

Display queue classes for the specified interface.

filter

Display queue filters for the specified interface.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces ethernet <ethx> vif

show interfaces ethernet <ethx> vif <vlan-id>

Displays information about an Ethernet vif.

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

Displays information for the specified vif.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

TX:

bytes
2914
vyatta@vyatta:~$

Command Reference

packets
13

errors
0

dropped
0

Rel VC4.1 v. 03

show interfaces ethernet <ethx> vif

carrier collisions
0
0

Vyatta

268

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces ethernet <ethx> vif

show interfaces ethernet <ethx> vif <vlan-id> brief

Displays a brief status for an Ethernet vif.

Syntax
show interfaces ethernet ethx vif vlan-id brief

Command Mode
Operational mode.

Parameters

ethx

The specified Ethernet interface. This may be eth0 to eth23, depending

on what Ethernet interfaces that are actually available on the system.

vlan-id

Displays information for the specified vif.

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.

vyatta@vyatta:~$ show interfaces ethernet eth2 vif 6 brief

Interface
IP Address
State
Link
Description
eth2.6
10.1.6.66/24
up
up

Command Reference

Rel VC4.1 v. 03

Vyatta

269

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces ethernet <ethx> vif

show interfaces ethernet <ethx> vif <vlan-id> queue

Displays vif queuing information.

Syntax
show interfaces ethernet ethx vif vlan-id queue [class | filter]

Command Mode
Operational mode.

Parameters

ethx

The specified Ethernet interface. This may be eth0 to eth23, depending

on what Ethernet interfaces that are actually available on the system.

vlan-id

Displays information for the specified vif.

class

Display queue classes for the specified interface.

filter

Display queue filters for the specified interface.

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces loopback

show interfaces loopback

Displays information about the loopback interface.

Syntax
show interfaces loopback [lo]

Command Mode
Operational mode.

Parameters

lo

Displays detailed statistics and configuration information for the

loopback interface.

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.

vyatta@vyatta:~$ show interfaces loopback

Interface
IP Address
State
lo
127.0.0.1/8
up

Command Reference

Rel VC4.1 v. 03

Link
up

Description

Vyatta

271

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces loopback

Example 6-12 shows detailed information for the loopback interface.

Example 6-12 show interfaces loopback lo: Displaying detailed loopback interface
information.

vyatta@vyatta:~$ show interfaces loopback lo

lo: <LOOPBACK,UP,LOWER_UP> mtu 16436 qdisc noqueue
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
inet 127.0.0.1/8 scope host lo
inet6 ::1/128 scope host
valid_lft forever preferred_lft forever
RX: bytes
0
TX: bytes
0

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces loopback detail

show interfaces loopback detail

Displays detailed information and statistics about the loopback interface.

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.

vyatta@vyatta:~$ show interfaces loopback detail

lo: <LOOPBACK,UP,LOWER_UP> mtu 16436 qdisc noqueue
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
inet 127.0.0.1/8 scope host lo
inet6 ::1/128 scope host
valid_lft forever preferred_lft forever
RX: bytes
0
TX: bytes
0

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

Chapter 6: Ethernet Interfaces, VLAN Interfaces, and the Loopback Interface

show interfaces loopback lo brief

show interfaces loopback lo brief

Displays brief status information for the loopback interface.

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.

vyatta@vyatta:~$ show interfaces loopback lo brief

Interface
IP Address
State
Link
Description
lo
127.0.0.1/8
up
up

Command Reference

Rel VC4.1 v. 03

Vyatta

274

275

Chapter 7: Serial Interfaces

This chapter lists the commands for configuring serial interfaces.

This chapter contains the following commands.
Command

Description

Serial Interface Configuration Commands

interfaces serial <wanx>

Specifies basic serial interface configuration,

including Layer 2 encapsulation characteristics.

interfaces serial <wanx> description <desc>

Specifies a description for a serial interface.

interfaces serial <wanx> encapsulation <type>

Sets the encapsulation type for a serial interface.

interfaces serial <wanx> qos-policy out <policy>

Applies a QoS policy to outbound traffic on a serial

interface.

Cisco HDLC Interface Configuration Commands

interfaces serial <wanx> cisco-hdlc

Defines the characteristics of Cisco High-Level Data

Link Control encapsulation for a serial interface.

interfaces serial <wanx> cisco-hdlc keepalives

Set the characteristics of keep-alive messages for a

Cisco HDLC serial interface.

interfaces serial <wanx> cisco-hdlc mru <mru>

Specify the Maximum Receive Unit (MRU) size for a

Cisco HDLC serial interface.

Chapter 7: Serial Interfaces

276

Command

Description

interfaces serial <wanx> cisco-hdlc mtu <mtu>

Specify the Maximum Transmit Unit (MTU) size for a

Cisco HDLC serial interface.

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>

Specifies the IP address of the remote endpoint on a

Cisco HDLC serial connection.

interfaces serial <wanx> cisco-hdlc vif 1 description <desc>

Specifies a description for a Cisco HDLC virtual

interface.

interfaces serial <wanx> cisco-hdlc vif 1 firewall

Applies a firewall instance to a Cisco

HDLCencapsulated serial interface. See the Vyatta
Security Reference Guide.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

Enables OSPF on the virtual interface of a Cisco

HDLC serial interface. See page 895 in Chapter 15:
OSPF.

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

Enables RIP on the virtual interface of a Cisco HDLC

serial interface. See page 628 in Chapter 14: RIP.

Multilink Interface Configuration Commands

interfaces multilink <mlx> ip ospf

Enables OSPF on a multilink interface. See page 873

in Chapter 15: OSPF.

interfaces multilink <mlx> ip rip

Enables RIP on a multilink interface. See page 623 in

Chapter 14: RIP.

E1 Interface Configuration Commands

interfaces serial <wanx> e1-options

Specifies the physical line characteristics for an E1

serial interface.

interfaces serial <wanx> e1-options clock <type>

Sets the timing source for an E1 serial interface.

interfaces serial <wanx> e1-options framing <type>

Sets the framing for an E1 serial interface.

interfaces serial <wanx> e1-options mru <mru>

Specifies the Maximum Receive Unit (MRU) size for

an E1 serial interface.

interfaces serial <wanx> e1-options mtu <mtu>

Specifies the Maximum Transmit Unit (MTU) size for

an E1 serial interface.

interfaces serial <wanx> e1-options timeslots

Defines timeslots for a 32-channel channelized E1

line.

E3 Interface Configuration Commands

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 7: Serial Interfaces

277

Command

Description

interfaces serial <wanx> e3-options

Specifies the physical line characteristics for an E3

serial interface.

interfaces serial <wanx> e3-options clock <type>

Specifies the timing source for an E3 serial interface.

interfaces serial <wanx> e3-options framing <type>

Specifies the framing type for an E3 serial interface.

interfaces serial <wanx> e3-options line-coding <type>

Specifies the line coding for an E3 serial interface.

Frame Relay Interface Configuration Commands

interfaces serial <wanx> frame-relay

Defines the characteristics of Frame Relay

encapsulation on a serial interface.

interfaces serial <wanx> frame-relay mru <mru>

Specifies the Maximum Receive Unit (MRU) size for

a Frame Relay serial interface.

interfaces serial <wanx> frame-relay mtu <mtu>

Specifies the Maximum Transmit Unit (MTU) size for

a Frame Relay serial interface.

interfaces serial <wanx> frame-relay signaling <value>

Specifies the signaling variant (LMI type) for a Frame

Relay serial interface.

interfaces serial <wanx> frame-relay signaling-options

Specifies the signaling options for a Frame Relay

serial interface.

interfaces serial <wanx> frame-relay vif <dlci> address

local-address <ipv4>

Sets the IP address for a Frame Relay virtual

interface.

interfaces serial <wanx> frame-relay vif <dlci> address

prefix-length <prefix>

Specifies the prefix defining the network served by a

Frame Relay virtual interface.

interfaces serial <wanx> frame-relay vif <dlci> address

remote-address <ipv4>

Sets the IP address for the remote endpoint of a

Frame Relay connection.

interfaces serial <wanx> frame-relay vif <dlci> description

<desc>

Specifies a description for a Frame Relay virtual

interface.

interfaces serial <wanx> frame-relay vif <dlci> firewall

Applies a firewall instance to a Frame

Relayencapsulated serial interface. See the Vyatta
High Availability Reference Guide.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

Enables OSPF on the virtual interface of a Frame

Relay serial interface. See page 919 in Chapter 15:
OSPF.

interfaces serial <wanx> frame-relay vif <dlci> ip rip

Enables RIP on the virtual interface of a Frame Relay

serial interface. See page 634 in Chapter 14: RIP.

interfaces serial <wanx> frame-relay vif <dlci> pvc

rx-inverse-arp

Enables or disables receiving of inverse ARP

messages on a Frame Relay virtual interface.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 7: Serial Interfaces

278

Command

Description

interfaces serial <wanx> frame-relay vif <dlci> pvc

tx-inverse-arp <value>

Specifies the number of inverse ARP messages to be

sent by a Frame Relay virtual interface.

PPP Interface Configuration Commands

interfaces serial <wanx> ppp

Defines the characteristics of Point-to-Point Protocol

encapsulation on a serial interface.

interfaces serial <wanx> ppp authentication

Specifies the authentication parameters for a PPP

interface.

interfaces serial <wanx> ppp lcp-echo-failure <value>

Specifies the LCP echo failure threshold for a PPP

serial interface.

interfaces serial <wanx> ppp lcp-echo-interval <interval>

Specifies the LCP echo interval for a PPP serial

interface.

interfaces serial <wanx> ppp logging <state>

Specifies whether to enable or disable logging of

debugging messages for the PPP process.

interfaces serial <wanx> ppp mru <mru>

Specify the Maximum Receive Unit (MRU) size for a

PPP serial interface.

interfaces serial <wanx> ppp mtu <mtu>

Specify the Maximum Transmit Unit (MTU) size for a

PPP serial interface.

interfaces serial <wanx> ppp multilink <bundle>

Assigns a PPP serial link to a multilink PPP bundle.

interfaces serial <wanx> ppp vif 1 address local-address

<ipv4>

Specify the IP address for this virtual interface.

interfaces serial <wanx> ppp vif 1 address prefix-length

<prefix>

Specifies the prefix defining the network served by a

virtual interface on a PPPP serial interface.

interfaces serial <wanx> ppp vif 1 address remote-address

<ipv4>

Specifies the IP address of the remote endpoint on a

PPP serial connection.

interfaces serial <wanx> ppp vif 1 description <desc>

Specifies a description for a virtual interface on a

PPP serial interface.

interfaces serial <wanx> ppp vif 1 firewall

Applies a firewall instance to a PPP-encapsulated

serial interface. See the Vyatta Security Reference
Guide.

interfaces serial <wanx> ppp vif 1 ip ospf

Enables OSPF on the virtual interface of a PPP serial

interface. See page 943 in Chapter 15: OSPF.

interfaces serial <wanx> ppp vif 1 ip rip

Enables RIP on the virtual interface of a PPP serial

interface. See page 640 in Chapter 14: RIP.

T1 Interface Configuration Commands

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 7: Serial Interfaces

279

Command

Description

interfaces serial <wanx> t1-options

Specifies the physical line characteristics for T1 serial

interfaces.

interfaces serial <wanx> t1-options clock <type>

Sets the timing source for a T1 serial interface.

interfaces serial <wanx> t1-options lbo <range>

Specifies the line build-out (LBO) range for a T1

serial interface.

interfaces serial <wanx> t1-options mru <mru>

Specify the Maximum Receive Unit (MRU) size for a

T1 serial interface.

interfaces serial <wanx> t1-options mtu <mtu>

Specify the Maximum Transmit Unit (MTU) size for a

T1 serial interface.

interfaces serial <wanx> t1-options timeslots

Defines timeslots for a 24-channel channelized T1

line.

T3 Interface Configuration Commands

interfaces serial <wanx> t3-options

Specifies the physical line characteristics for a T3

serial interface.

interfaces serial <wanx> t3-options clock <type>

Specifies the timing source for the circuit.

interfaces serial <wanx> t3-options framing <type>

Specifies the framing type for a T3 serial interface.

interfaces serial <wanx> t3-options line-coding <type>

Specifies the line coding for a T3 serial interface.

Serial Interface Operational Commands

clear interfaces serial

Clears counters for serial interfaces

show interfaces serial

Displays serial interface information.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 7: Serial Interfaces

clear interfaces serial

clear interfaces serial

Clears counters for serial interfaces

Syntax
clear interfaces serial [wanx counters {all | physical | cisco-hdlc | frame-relay | ppp}]

Command Mode
Operational mode.

Parameters

wanx

The identifier of a configured serial interface.

all

Clears all counters for the specified serial interface.

physical

Clears counters related to the physical line settings for the specified
interface.

cisco-hdlc

Clears counters related to Cisco HDLC settings for the specified

interface.

frame-relay

Clears counters related to Frame Relay settings for the specified

interface.

ppp

Clears counters related to Point-to-Point Protocol settings for the

specified interface.

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

vyatta@R1> clear interfaces serial

Command Reference

Rel VC4.1 v. 03

Vyatta

280

Chapter 7: Serial Interfaces

clear interfaces serial

Communication statistics flushed

Operational statistics flushed
DSU/CSU Perfomance Monitoring counters were flushed.
Performance monitoring counters flushed
PPP statistics flushed
Communication statistics flushed
Operational statistics flushed
DSU/CSU Perfomance Monitoring counters were flushed.
Performance monitoring counters flushed
PPP statistics flushed
vyatta@R1>

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.

vyatta@R1> clear interfaces serial wan0 counters cisco-hdlc

DSU/CSU Perfomance Monitoring counters were flushed.
Performance monitoring counters flushed
-------------------------------------wan0.1: SLARP STATISTICS
-------------------------------------SLARP frame transmission/reception statistics
SLARP request packets transmitted:
0
SLARP request packets received:
0
SLARP Reply packets transmitted:
0
SLARP Reply packets received:
0
SLARP keepalive packets transmitted:
0
SLARP keepalive packets received:
0
Incoming SLARP Packets with format errors
Invalid SLARP Code:
0
Replies with bad IP addr:
0
Replies with bad netmask:
0
SLARP timeout/retry statistics
SLARP Request timeouts:
0
keepalive reception timeouts:
0
Cisco Discovery Protocol frames
Transmitted:
0
Received:
0
DSU/CSU Perfomance Monitoring counters were flushed.
vyatta@R1>

Command Reference

Rel VC4.1 v. 03

Vyatta

281

Chapter 7: Serial Interfaces

interfaces serial <wanx>

interfaces serial <wanx>

Specifies basic serial interface configuration, including Layer 2 encapsulation
characteristics.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc

interfaces serial <wanx> cisco-hdlc

Defines the characteristics of Cisco High-Level Data Link Control encapsulation for a
serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc keepalives

interfaces serial <wanx> cisco-hdlc keepalives

Set the characteristics of keep-alive messages for a Cisco HDLC serial interface.

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

Specifies whether or not to require receiving keep-alive message from

the Cisco HDLC peer. Supported values are as follows:
enable: Requires keep-alive messages. If keep-alive messages are not
received, the peer interface is declared down.
disable: Does not require keep-alive messages.

timer interval

Command Reference

Specifies the interval at which keep-alive messages are to be sent. The

range is 10 to 60000. The default is 10.

Rel VC4.1 v. 03

Vyatta

286

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc keepalives

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc mru <mru>

interfaces serial <wanx> cisco-hdlc mru <mru>

Specify the Maximum Receive Unit (MRU) size for a Cisco HDLC serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc mru <mru>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc mtu <mtu>

interfaces serial <wanx> cisco-hdlc mtu <mtu>

Specify the Maximum Transmit Unit (MTU) size for a Cisco HDLC serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc mtu <mtu>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 address local-address <ipv4>

interfaces serial <wanx> cisco-hdlc vif 1 address

local-address <ipv4>
Assign an IP address to a Cisco HDLC virtual interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

ipv4

Mandatory. The IPv4 address for this vif. Each serial vif can support
exactly one IP address.

Rel VC4.1 v. 03

Vyatta

292

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 address local-address <ipv4>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 address prefix-length <prefix>

interfaces serial <wanx> cisco-hdlc vif 1 address

prefix-length <prefix>
Specifies the prefix defining the network served by a virtual interface on a Cisco HDLC
serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

prefix

Mandatory. The prefix defining the network served by this interface.

The range is 0 to 32.

Rel VC4.1 v. 03

Vyatta

294

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 address prefix-length <prefix>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 address remote-address <ipv4>

interfaces serial <wanx> cisco-hdlc vif 1 address

remote-address <ipv4>
Specifies the IP address of the remote endpoint on a Cisco HDLC serial connection.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

ipv4

Mandatory. An IP address representing the remote endpoint.

Rel VC4.1 v. 03

Vyatta

296

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 address remote-address <ipv4>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 description <desc>

interfaces serial <wanx> cisco-hdlc vif 1 description

<desc>
Specifies a description for a Cisco HDLC virtual interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

desc

Optional. A brief description for the virtual interface. If the description

contains spaces, it must be enclosed in double quotes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

298

Chapter 7: Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 description <desc>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> description <desc>

interfaces serial <wanx> description <desc>

Specifies a description for a serial interface.

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

Optional. A brief description for the serial interface. If the description

contains spaces, it must be enclosed in double quotes. By default, the
system auto-detects the card type and indicates it in the description.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

300

Chapter 7: Serial Interfaces

interfaces serial <wanx> description <desc>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options

interfaces serial <wanx> e1-options

Specifies the physical line characteristics for an E1 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options clock <type>

interfaces serial <wanx> e1-options clock <type>

Sets the timing source for an E1 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options clock <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options framing <type>

interfaces serial <wanx> e1-options framing <type>

Sets the framing for an E1 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options framing <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options mru <mru>

interfaces serial <wanx> e1-options mru <mru>

Specifies the Maximum Receive Unit (MRU) size for an E1 serial interface.

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

Optional. Sets the Maximum Receive Unit (MRU). This is the

maximum packet size that the interface is willing to receive. The range
is 8 to 8188. The default is 1500.
Note that for IPv6 connections, the MRU must be at least 1280.

Default
The MRU is 1500.

Command Reference

Rel VC4.1 v. 03

Vyatta

308

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options mru <mru>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options mtu <mtu>

interfaces serial <wanx> e1-options mtu <mtu>

Specifies the Maximum Transmit Unit (MTU) size for an E1 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options mtu <mtu>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options timeslots

interfaces serial <wanx> e1-options timeslots

Defines timeslots for a 32-channel channelized E1 line.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e1-options timeslots

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e3-options

interfaces serial <wanx> e3-options

Specifies the physical line characteristics for an E3 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e3-options clock <type>

interfaces serial <wanx> e3-options clock <type>

Specifies the timing source for an E3 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e3-options clock <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e3-options framing <type>

interfaces serial <wanx> e3-options framing <type>

Specifies the framing type for an E3 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e3-options framing <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e3-options line-coding <type>

interfaces serial <wanx> e3-options line-coding <type>

Specifies the line coding for an E3 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> e3-options line-coding <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> encapsulation <type>

interfaces serial <wanx> encapsulation <type>

Sets the encapsulation type for a serial interface.

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

Mandatory. Sets the encapsulation type for the interface. Supported

values are as follows:
ppp: Uses Point-to-Point Protocol (PPP) encapsulation for the interface.
cisco-hdlc: Uses Cisco High-Level Data Link Control (Cisco HDLC)
encapsulation on the interface.
frame-relay: Uses Frame Relay encapsulation on the interface.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

321

Chapter 7: Serial Interfaces

interfaces serial <wanx> encapsulation <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay

interfaces serial <wanx> frame-relay

Defines the characteristics of Frame Relay encapsulation on a serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay mru <mru>

interfaces serial <wanx> frame-relay mru <mru>

Specifies the Maximum Receive Unit (MRU) size for a Frame Relay serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay mru <mru>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay mtu <mtu>

interfaces serial <wanx> frame-relay mtu <mtu>

Specifies the Maximum Transmit Unit (MTU) size for a Frame Relay serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay mtu <mtu>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay signaling <value>

interfaces serial <wanx> frame-relay signaling <value>

Specifies the signaling variant (LMI type) for a Frame Relay serial interface.

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

Specifies the Frame Relay signaling variant (LMI type). Supported

values are as follows:
auto: Autonegotiates the LMI type.
ansi: Uses ANSI-617d Annex D LMI type.
q933: Uses the Q.933 (ITU-T (CCIT) Q.933 annex A) LMI type.
lmi: Uses Cisco proprietary LMI type.
The default is auto.

Command Reference

Rel VC4.1 v. 03

Vyatta

329

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay signaling <value>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay signaling-options

interfaces serial <wanx> frame-relay signaling-options

Specifies the signaling options for a Frame Relay serial interface.

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

Chapter 7: Serial Interfaces

n391dte value

interfaces serial <wanx> frame-relay signaling-options

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

Optional. Sets the DCE timer variable.This is the maximum time, in

seconds, that the DCE will wait for a keep-alive request from the DTE
interface. If this condition occurs a time-out is counted.
This value must be greater than the DTE keep-alive interval specified by
the t391dte parameter.
The range is 5 to 30. The default is 16.

Default
The default value for each parameter is used.

Command Reference

Rel VC4.1 v. 03

Vyatta

332

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay signaling-options

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> address local-address <ipv4>

interfaces serial <wanx> frame-relay vif <dlci> address

local-address <ipv4>
Sets the IP address for a Frame Relay virtual interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> address local-address <ipv4>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> address prefix-length <prefix>

interfaces serial <wanx> frame-relay vif <dlci> address

prefix-length <prefix>
Specifies the prefix defining the network served by a Frame Relay virtual interface.

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

Mandatory. The prefix defining the network served by this interface.

The range is 0 to 32.

Rel VC4.1 v. 03

Vyatta

336

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> address prefix-length <prefix>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> address remote-address <ipv4>

interfaces serial <wanx> frame-relay vif <dlci> address

remote-address <ipv4>
Sets the IP address for the remote endpoint of a Frame Relay connection.

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

Mandatory. The IP address of the remote endpoint.

Rel VC4.1 v. 03

Vyatta

338

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> address remote-address <ipv4>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> description <desc>

interfaces serial <wanx> frame-relay vif <dlci>

description <desc>
Specifies a description for a Frame Relay virtual interface.

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

Optional. A brief description for the virtual interface. If the description

contains spaces, it must be enclosed in double quotes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

340

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> description <desc>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> pvc rx-inverse-arp

interfaces serial <wanx> frame-relay vif <dlci> pvc

rx-inverse-arp
Enables or disables receiving of inverse ARP messages on a Frame Relay virtual interface.

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

Enables or disables inverse ARP on this DLCI. Supported values are as

follows:
enable: Enables inverse ARP on this DLCI.
disable: Disables inverse ARP on this DLCI.

Command Reference

Rel VC4.1 v. 03

Vyatta

342

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> pvc rx-inverse-arp

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> pvc tx-inverse-arp <value>

interfaces serial <wanx> frame-relay vif <dlci> pvc

tx-inverse-arp <value>
Specifies the number of inverse ARP messages to be sent by a Frame Relay virtual
interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> frame-relay vif <dlci> pvc tx-inverse-arp <value>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp

interfaces serial <wanx> ppp

Defines the characteristics of Point-to-Point Protocol encapsulation on a serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp authentication

interfaces serial <wanx> ppp authentication

Specifies the authentication parameters for a PPP interface.

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

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

348

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp authentication

password password

Optional. Sets the password this system will use when

authenticating itself to a peer.

peer-password password

Optional. Sets the password this system will accept from a

peer.

peer-system-name name

Optional. The system name this system will accept from a

peer.

peer-user-id user-id

Optional. The user ID this system will accept from a peer.

refuse-type type

Defines authentication types that will be refused during

authentication negotiations. Used when the Vyatta system
is acting as the client side of the communication.
none: Does not refuse any type of authentication; that is,
the system will authenticate to the peer any type of
authentication requested, including not using
authentication.
chap: Refuses CHAP authentication if offered by the
remote peer.
pap: Refuses PAP authentication if offered by the remote
peer.
papchap: Refuses PAP or CHAP authentication if offered
by the remote peer.
mschap: Refuses MS-CHAP authentication if offered by
the remote peer.
mschap-v2: Refuses MS-CHAP v2 authentication if
offered by the remote peer.
eap: Refuses EAP authentication if offered by the remote
peer.
The default is none.

system-name name

Command Reference

Optional. The system name this system will use when

authenticating itself to a peer.

Rel VC4.1 v. 03

Vyatta

349

Chapter 7: Serial Interfaces

type type

interfaces serial <wanx> ppp authentication

Optional. Sets the authentication required from the remote

peer. Used when the Vyatta system is acting as the server
side of the communication. Supported values are as
follows:
none: The remote peer is not required to authenticate itself.
chap: The remote peer must authenticate using the
Challenge Handshake Authentication Protocol (CHAP), as
defined in RFC 1994.
pap: The remote peer must authenticate using the
Password Authentication Protocol (PAP). The client
authenticates itself by sending a user ID and a password to
the server, which the server compares to the password in its
internal database.
papchap: The remote peer must authenticate using either
PAP or CHAP as the authentication method.
mschap: The remote peer must authenticate using the
Microsoft Challenge Handshake Authentication Protocol
(MS-CHAP), which is the Microsoft version of CHAP and
is an extension to RFC 1994.
mschap-v2: The remote peer must authenticate using
version 2 of MS-CHAP.
eap: The remote peer must authenticate using Extensible
Authentication Protocol (EAP), which is an authentication
framework frequently used in mobile networks and
point-to-point connections.
any: The peer is required to authenticate itself (that is, none
is refused), but any supported method of authentication
offered by the remote peer is accepted.
The default is none.

user-id user-id

Optional. The user ID this system will use when

authenticating itself to a peer.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

350

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp authentication

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp lcp-echo-failure <value>

interfaces serial <wanx> ppp lcp-echo-failure <value>

Specifies the LCP echo failure threshold for a PPP serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp lcp-echo-failure <value>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp lcp-echo-interval <interval>

interfaces serial <wanx> ppp lcp-echo-interval

<interval>
Specifies the LCP echo interval for a PPP serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp lcp-echo-interval <interval>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp logging <state>

interfaces serial <wanx> ppp logging <state>

Specifies whether to enable or disable logging of debugging messages for the PPP process.

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

Enables logging of debugging messages for the PPP process. Supported

values are as follows:
on: Enables debugging for PPP connections. Trace-level messages are
sent from the PPP process to the system log.
off: Disables debugging for PPP connections.
Note that logging creates additional system load and may degrade
performance.

Command Reference

Rel VC4.1 v. 03

Vyatta

356

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp logging <state>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp mru <mru>

interfaces serial <wanx> ppp mru <mru>

Specify the Maximum Receive Unit (MRU) size for a PPP serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp mru <mru>

Use the set form of this command to set the MRU.

Use the delete form of this command to restore the default MRU value.
Use the show form of this command to view MRU configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

359

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp mtu <mtu>

interfaces serial <wanx> ppp mtu <mtu>

Specify the Maximum Transmit Unit (MTU) size for a PPP serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp mtu <mtu>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp multilink <bundle>

interfaces serial <wanx> ppp multilink <bundle>

Assigns a PPP serial link to a multilink PPP bundle.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp multilink <bundle>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 address local-address <ipv4>

interfaces serial <wanx> ppp vif 1 address local-address

<ipv4>
Specify the IP address for this virtual interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

ipv4

Mandatory. The IPv4 address for this vif. Each serial vif can support
exactly one IP address.

Rel VC4.1 v. 03

Vyatta

364

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 address local-address <ipv4>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 address prefix-length <prefix>

interfaces serial <wanx> ppp vif 1 address prefix-length

<prefix>
Specifies the prefix defining the network served by a virtual interface on a PPPP serial
interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

prefix

Mandatory. The prefix defining the network served by this interface.

The range is 0 to 32.

Rel VC4.1 v. 03

Vyatta

366

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 address prefix-length <prefix>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 address remote-address <ipv4>

interfaces serial <wanx> ppp vif 1 address

remote-address <ipv4>
Specifies the IP address of the remote endpoint on a PPP serial connection.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

ipv4

Mandatory. The IP address of the remote endpoint.

Rel VC4.1 v. 03

Vyatta

368

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 address remote-address <ipv4>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 description <desc>

interfaces serial <wanx> ppp vif 1 description <desc>

Specifies a description for a virtual interface on a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

desc

Optional. A brief description for the virtual interface. If the description

contains spaces, it must be enclosed in double quotes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

370

Chapter 7: Serial Interfaces

interfaces serial <wanx> ppp vif 1 description <desc>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> qos-policy out <policy>

interfaces serial <wanx> qos-policy out <policy>

Applies a QoS policy to outbound traffic on a serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> qos-policy out <policy>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options

interfaces serial <wanx> t1-options

Specifies the physical line characteristics for T1 serial interfaces.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options

Currently, only bipolar 8-zero line coding is supported.

Use the set form of this command to set the physical line characteristics for a T1 serial
interfaces.
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

375

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options clock <type>

interfaces serial <wanx> t1-options clock <type>

Sets the timing source for a T1 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options clock <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options lbo <range>

interfaces serial <wanx> t1-options lbo <range>

Specifies the line build-out (LBO) range for a T1 serial interface.

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

Sets the maximum line build-out length. Supported values are as

follows:
0110ft: The line will not exceed 110 feet in length.
110220ft: The line will be between 110 and 220 feet in length.
220330ft: The line will be between 220 and 330 feet in length.
330440ft: The line will be between 330 and 440 feet in length.
440550ft: The line will be between 440 and 550 feet in length.
The default is 0-110ft.

Command Reference

Rel VC4.1 v. 03

Vyatta

378

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options lbo <range>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options mru <mru>

interfaces serial <wanx> t1-options mru <mru>

Specify the Maximum Receive Unit (MRU) size for a T1 serial interface.

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

Optional. Sets the Maximum Receive Unit (MRU). This is the

maximum packet size that the interface is willing to receive. The range
is 8 to 8188. The default is 1500.
Note that for IPv6 connections, the MRU must be at least 1280.

Default
The default is 1500.

Command Reference

Rel VC4.1 v. 03

Vyatta

380

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options mru <mru>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options mtu <mtu>

interfaces serial <wanx> t1-options mtu <mtu>

Specify the Maximum Transmit Unit (MTU) size for a T1 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options mtu <mtu>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options timeslots

interfaces serial <wanx> t1-options timeslots

Defines timeslots for a 24-channel channelized T1 line.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t1-options timeslots

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options

interfaces serial <wanx> t3-options

Specifies the physical line characteristics for a T3 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options clock <type>

interfaces serial <wanx> t3-options clock <type>

Specifies the timing source for the circuit.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options clock <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options framing <type>

interfaces serial <wanx> t3-options framing <type>

Specifies the framing type for a T3 serial interface.

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options framing <type>

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

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options line-coding <type>

interfaces serial <wanx> t3-options line-coding <type>

Specifies the line coding for a T3 serial interface.

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

Optional. Sets the T3 line coding. Supported values are as follows:

ami: Sets the line coding to alternate mark inversion (AMI).
b3zs: Sets the line coding to bipolar 3-zero substitution.
The default is b3zs.

Default
T3 serial lines use bipolar 3-zero substitution line coding.

Command Reference

Rel VC4.1 v. 03

Vyatta

392

Chapter 7: Serial Interfaces

interfaces serial <wanx> t3-options line-coding <type>

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

Chapter 7: Serial Interfaces

show interfaces serial

show interfaces serial

Displays serial interface information.

Syntax
show interfaces serial [wanx {cisco-hdlc | frame-relay [pvc | pvc-list [active]] | physical
| ppp | trace}]

Command Mode
Operational mode.

Parameters

wanx

The name of a serial interface. If an interface is specified, you must also

specify one of the cisco-hdlc, frame-relay, physical, ppp, or trace
options.

cisco-hdlc

Shows Cisco HDLC information for the specified serial interface.

frame-relay

Shows Frame Relay information for the specified serial interface.

pvc

Displays details for Frame Relay PVCs.

pvc-list

Lists of Frame Relay permanent virtual circuits (PVCs). When used with
no option, displays all configured PVCs.

active

Lists only active Frame Relay PVCs.

physical

Shows physical device information for the specified serial interface.

ppp

Shows Point-to-Point protocol information for the specified serial

interface.

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

Chapter 7: Serial Interfaces

show interfaces serial

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

vyatta@R1> show interfaces serial

wan1: <POINTOPOINT,NOARP,UP,10000> mtu 1450 qdisc pfifo_fast
qlen 100
link/ppp
RX: bytes
packets
errors
dropped
overrun
mcast
773
67
0
0
0
0
TX: bytes
packets
errors
dropped
carrier collisions
813
68
0
0
0
0
wan1.1: <POINTOPOINT,MULTICAST,NOARP,UP,10000> mtu 1340 qdisc
pfifo_fast qlen 3
link/ppp
inet 2.2.2.2 peer 1.1.1.1/32 scope global wan1.1
RX: bytes
packets
errors
dropped
overrun
mcast
72
5
0
0
0
0
TX: bytes
packets
errors
dropped
carrier collisions
78
5
0
0
0
0
wan0: <POINTOPOINT,NOARP,UP,10000> mtu 1450 qdisc pfifo_fast
qlen 100
link/ppp
RX: bytes
packets
errors
dropped
overrun
mcast
813
68
0
0
0
0
TX: bytes
packets
errors
dropped
carrier collisions
773
67
0
0
0
0
wan0.1: <POINTOPOINT,MULTICAST,NOARP,UP,10000> mtu 1350 qdisc
pfifo_fast qlen 3
link/ppp
inet 1.1.1.1 peer 2.2.2.2/32 scope global wan0.1
RX: bytes
packets
errors
dropped
overrun
mcast
78
5
0
0
0
0
TX: bytes
packets
errors
dropped
carrier collisions
72
5
0
0
0
0

Command Reference

Rel VC4.1 v. 03

Vyatta

395

Chapter 7: Serial Interfaces

show interfaces serial

Example 7-4 shows the output for show interfaces serial wanx ppp.
Example 7-4 show interfaces serial wanx ppp

vyatta@ppp> show interfaces serial wan0 ppp

---------------------------------wan0: ROUTER UP TIME
---------------------------------Router UP Time: 14 minute(s), 6 seconds
PPP data:
IN.BYTES :
IN.PACK
:
IN.VJCOMP :
IN.VJUNC :
IN.VJERR :
OUT.BYTES :
OUT.PACK :
OUT.VJCOMP:
OUT.VJUNC :
OUT.NON-VJ:

0
0
0
0
0
0
0
0
0
0

Example 7-5 shows the output for show interfaces serial wanx trace.
NOTE

The output is interrupted by pressing Ctrl-C

Example 7-5 show interfaces serial wanx trace

vyatta@ppp> show interfaces serial wan0 trace

OUTGOING
Len=14 TimeStamp=56407
Aug 22 06:31:49 314767
[1/100s]
Raw (HEX)
00 01 03 08 00 75 95 01 01 01 03 02 A7 00
FR decode

OUTGOING
[1/100s]
Raw (HEX)
FR decode

OUTGOING
[1/100s]

Command Reference

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=56407

Aug 22 06:31:49 314779

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

Aug 22 06:31:49 315013

Vyatta

396

Chapter 7: Serial Interfaces

Raw (HEX)

00 01 03 08 00 75 51 01 01 53 02 A7 00

FR decode

DLCI=0 C/R=0 EA=0 FECN=0 BECN=0 DE=0 EA=1

Signalling ANSI
Link Verification Req
Sx=0x00 Rx=0x00

INCOMING
[1/100s]
Raw (HEX)
FR decode

INCOMING
[1/100s]
FR decode

INCOMING
[1/100s]
Raw (HEX)
FR decode

Command Reference

show interfaces serial

Len=14

TimeStamp=56560

Aug 22 06:31:49 467620

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

Aug 22 06:31:49 467999

DLCI=1023 C/R=0 EA=0 FECN=0 BECN=0 DE=0 EA=1

Signalling ANSI
Link Verification Req
Sx=0x00 Rx=0x00
Len=13

TimeStamp=56561

Aug 22 06:31:49 468379

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

Chapter 8: Multilink Interfaces

This chapter lists the commands for configuring multilink interfaces.

This chapter contains the following commands.
Command

Description

Multilink Interfaces Configuration Commands

interfaces multilink <mlx>

Defines the characteristics of Point-to-Point Protocol

encapsulation on a serial interface.

interfaces multilink <mlx> authentication

Specifies the authentication parameters for a

multilink interface.

interfaces multilink <mlx> description <desc>

Specifies a description for a virtual interface on a

multilink interface.

interfaces multilink <mlx> ip ospf

All commands for configuring OSPF on multilink

interfaces are given in Chapter 15: OSPF.

interfaces multilink <mlx> ip rip

All commands for configuring OSPF on multilink

interfaces are given in Chapter 14: RIP.

interfaces multilink <mlx> lcp-echo-failure <value>

Specifies the LCP echo failure threshold for a

multilink interface.

interfaces multilink <mlx> lcp-echo-interval <interval>

Specifies the LCP echo interval for a multilink

interface.

Chapter 8: Multilink Interfaces

399

Command

Description

interfaces multilink <mlx> logging <state>

Specifies whether to enable or disable logging of

debugging messages for the multilink process.

interfaces multilink <mlx> mrru <mrru>

Specify the MRRU size for a multilink interface.

interfaces multilink <mlx> mtu <mtu>

Specify the MTU size for a multilink interface.

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>

Specifies the prefix defining the network served by a

virtual interface on a multilink interface.

interfaces multilink <mlx> vif 1 address remote-address

<ipv4>

Specifies the IP address of the remote endpoint on a

multilink connection.

interfaces multilink <mlx> vif 1 description <desc>

Sets the description for a virtual interface on a

multilink interface.

Operational Commands
clear interfaces multilink

Clears counters for multilink interfaces

show interfaces multilink

Displays information about multilink interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 8: Multilink Interfaces

clear interfaces multilink

clear interfaces multilink

Clears counters for multilink interfaces

Syntax
clear interfaces multilink [ml0..ml23]

Command Mode
Operational mode.

Parameters

ml0..ml23

Clears the statistics on the specified multilink interface.

Multilink interfaces are numbered ml0 (em ell zero) through ml23
(em ell twenty-three)

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

vyatta@R1> clear interfaces multilink

PPP statistics flushed
PPP statistics flushed
vyatta@R1>

Example 8-2 clears statistics on a specific multilink interface.

Example 8-2 clear interfaces multilink: Clearing multilink statistics on one interface

vyatta@R1> clear interfaces multilink ml0

PPP statistics flushed
vyatta@R1>

Command Reference

Rel VC4.1 v. 03

Vyatta

400

Chapter 8: Multilink Interfaces

Command Reference

clear interfaces multilink

Rel VC4.1 v. 03

Vyatta

401

Chapter 8: Multilink Interfaces

interfaces multilink <mlx>

interfaces multilink <mlx>

Defines the characteristics of Point-to-Point Protocol encapsulation on a serial interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> authentication

interfaces multilink <mlx> authentication

Specifies the authentication parameters for a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can

create up to two multilink bundles. Supported values are
ml0 (em ell zero) through ml23 (em ell twenty-three).

password password

Optional. Sets the password this system will use when

authenticating itself to a peer.

peer-password password

Optional. Sets the password this system will accept from a

peer.

Rel VC4.1 v. 03

Vyatta

404

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> authentication

peer-system-name name

Optional. The system name this system will accept from a

peer.

peer-user-id user-id

Optional. The user ID this system will accept from a peer.

refuse-type type

Defines authentication types that will be refused during

authentication negotiations. Used when the Vyatta system
is acting as the client side of the communication.
none: Does not refuse any type of authentication; that is,
the system will authenticate to the peer any type of
authentication requested, including not using
authentication.
chap: Refuses CHAP authentication if offered by the
remote peer.
pap: Refuses PAP authentication if offered by the remote
peer.
papchap: Refuses PAP or CHAP authentication if offered
by the remote peer.
mschap: Refuses MS-CHAP authentication if offered by
the remote peer.
mschap-v2: Refuses MS-CHAP v2 authentication if
offered by the remote peer.
eap: Refuses EAP authentication if offered by the remote
peer.
The default is none.

system-name name

Command Reference

Optional. The system name this system will use when

authenticating itself to a peer.

Rel VC4.1 v. 03

Vyatta

405

Chapter 8: Multilink Interfaces

type type

interfaces multilink <mlx> authentication

Optional. Sets the authentication required from the remote

peer. Used when the Vyatta system is acting as the server
side of the communication. Supported values are as
follows:
none: The remote peer is not required to authenticate itself.
chap: The remote peer must authenticate using the
Challenge Handshake Authentication Protocol (CHAP), as
defined in RFC 1994.
pap: The remote peer must authenticate using the
Password Authentication Protocol (PAP). The client
authenticates itself by sending a user ID and a password to
the server, which the server compares to the password in its
internal database.
papchap: The remote peer must authenticate using either
PAP or CHAP as the authentication method.
mschap: The remote peer must authenticate using the
Microsoft Challenge Handshake Authentication Protocol
(MS-CHAP), which is the Microsoft version of CHAP and
is an extension to RFC 1994.
mschap-v2: The remote peer must authenticate using
version 2 of MS-CHAP.
eap: The remote peer must authenticate using Extensible
Authentication Protocol (EAP), which is an authentication
framework frequently used in mobile networks and
point-to-point connections.
any: The peer is required to authenticate itself (that is, none
is refused), but any supported method of authentication
offered by the remote peer is accepted.
The default is none.

user-id user-id

Optional. The user ID this system will use when

authenticating itself to a peer.

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> authentication

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> description <desc>

interfaces multilink <mlx> description <desc>

Specifies a description for a virtual interface on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

desc

Optional. A brief description for the virtual interface. If the description

contains spaces, it must be enclosed in double quotes.

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> lcp-echo-failure <value>

interfaces multilink <mlx> lcp-echo-failure <value>

Specifies the LCP echo failure threshold for a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> lcp-echo-failure <value>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> lcp-echo-interval <interval>

interfaces multilink <mlx> lcp-echo-interval <interval>

Specifies the LCP echo interval for a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> lcp-echo-interval <interval>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> logging <state>

interfaces multilink <mlx> logging <state>

Specifies whether to enable or disable logging of debugging messages for the multilink
process.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

state

Enables logging of debugging messages for the PPP process. Supported

values are as follows:
on: Enables debugging for PPP connections. Trace-level messages are
sent from the PPP process to the system log.
off: Disables debugging for PPP connections.
Note that logging creates additional system load and may degrade
performance.

Command Reference

Rel VC4.1 v. 03

Vyatta

413

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> logging <state>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> mrru <mrru>

interfaces multilink <mlx> mrru <mrru>

Specify the MRRU size for a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

mrru

Optional. Sets the Maximum Reconstructed Receive Unit (MRRU).

This is the maximum size for a received packet on a multilink bundle,
analogous to the MRU for individual links.
The range is 8 to 8188. The default is 1600.
A value of 296 (40 bytes for the TCP/IP header + 256 bytes of data)
works well on very slow links. Note that for IPv6 connections, the
MRRU must be at least 1280.

Default
The default is 1600.

Command Reference

Rel VC4.1 v. 03

Vyatta

415

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> mrru <mrru>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> mtu <mtu>

interfaces multilink <mlx> mtu <mtu>

Specify the MTU size for a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> mtu <mtu>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> vif 1 address local-address <ipv4>

interfaces multilink <mlx> vif 1 address local-address

<ipv4>
Sets the IP address for a virtual interface on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

The identifier of the virtual interface. Currently, only one vif is

supported for multilink interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

419

Chapter 8: Multilink Interfaces

ipv4

interfaces multilink <mlx> vif 1 address local-address <ipv4>

Optional if specified on the peer; mandatory otherwise. The IPv4

address for this vif.
If multiple PPP interfaces are all endpoints for a multi-link PPP bundle,
all links in the bundle must share the same IP addresses.
If an interface is to form part of a multi-link bundle, the IP address need
not be explicitly assigned. In this case, the IP address must be received
from the remote PPP peer.

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> vif 1 address prefix-length <prefix>

interfaces multilink <mlx> vif 1 address prefix-length

<prefix>
Specifies the prefix defining the network served by a virtual interface on a multilink
interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

The identifier of the virtual interface. Currently, only one vif is

supported for multilink interfaces, and the identifier must be 1.

prefix

Optional if specified on the peer; mandatory otherwise. The prefix

defining the network served by this interface. The range is 0 to 32.

Rel VC4.1 v. 03

Vyatta

421

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> vif 1 address prefix-length <prefix>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> vif 1 address remote-address <ipv4>

interfaces multilink <mlx> vif 1 address remote-address

<ipv4>
Specifies the IP address of the remote endpoint on a multilink connection.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

The identifier of the virtual interface. Currently, only one vif is

supported for multilink interfaces, and the identifier must be 1.

ipv4

Optional if specified on the peer; mandatory otherwise. An IPv4 address

representing the network address of the remote peer.

Rel VC4.1 v. 03

Vyatta

423

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> vif 1 address remote-address <ipv4>

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

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> vif 1 description <desc>

interfaces multilink <mlx> vif 1 description <desc>

Sets the description for a virtual interface on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

The identifier of the virtual interface. Currently, only one vif is

supported for multilink interfaces, and the identifier must be 1.

desc

Optional. A brief description for the virtual interface. If the description

contains spaces, it must be enclosed in double quotes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

425

Chapter 8: Multilink Interfaces

interfaces multilink <mlx> vif 1 description <desc>

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

Chapter 8: Multilink Interfaces

show interfaces multilink

show interfaces multilink

Displays information about multilink interfaces.

Syntax
show interfaces multilink [ml0..ml23]

Command Mode
Operational mode.

Parameters

ml0..ml23

Shows detailed information for the specified multilink interface.

Supported values are ml0 (em ell zero) through ml23 (em ell
twenty-three).

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

vyatta@R1> show interfaces multilink

ml0: <POINTOPOINT,MULTICAST,NOARP,UP,10000> mtu 1540 qdisc
pfifo_fast qlen 3
link/ppp
inet 3.3.3.1 peer 3.3.3.2/32 scope global ml0
mrru 1560
RX: bytes
packets
errors
dropped
overrun
mcast
78
5
1
1
0
0
TX: bytes
packets
errors
dropped
carrier collisions
72
5
0
0
0
0

Command Reference

Rel VC4.1 v. 03

Vyatta

427

Chapter 8: Multilink Interfaces

show interfaces multilink

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

Example 8-4 shows information for a single multilink bundle.

Example 8-4 show interfaces multilink: Displaying detailed information for a multilink
bundle

vyatta@R1> show interfaces multilink ml0

ml0: <POINTOPOINT,MULTICAST,NOARP,UP,10000> mtu 1540 qdisc
pfifo_fast qlen 3
link/ppp
inet 3.3.3.1 peer 3.3.3.2/32 scope global ml0
mrru 1560
RX: bytes
packets
errors
dropped
overrun
mcast
78
5
1
1
0
0
TX: bytes
packets
errors
dropped
carrier collisions
72
5
0
0
0
0
Multilink members:
wan0 : active
wan0: <POINTOPOINT,NOARP,UP,10000> mtu 1450 qdisc pfifo_fast
qlen 100
link/ppp
multilink ml0
RX: bytes
packets
errors
dropped
overrun
mcast
367
16
0
0
0
0
TX: bytes
packets
errors
dropped
carrier collisions
343
15
0
0
0
0

PPP data:
IN.BYTES :

Command Reference

78

Rel VC4.1 v. 03

Vyatta

428

Chapter 8: Multilink Interfaces

IN.PACK
:
IN.VJCOMP :
IN.VJUNC :
IN.VJERR :
OUT.BYTES :
OUT.PACK :
OUT.VJCOMP:
OUT.VJUNC :
OUT.NON-VJ:

Command Reference

show interfaces multilink

5
0
0
0
72
5
0
0
5

Rel VC4.1 v. 03

Vyatta

429

430

Chapter 9: Tunnel Interfaces

This chapter lists the commands for configuring GRE and IP-in-IP routable tunnel
interfaces.
This chapter contains the following commands.
Command

Description

Tunnel Configuration Commands

interfaces tunnel <tunx>

Defines a tunnel interface.

interfaces tunnel <tunx> address <ipv4net>

Sets a primary or secondary IP address for a tunnel interface.

interfaces tunnel <tunx> description <descr>

Specifies a description for a tunnel interface.

interfaces tunnel <tunx> disable

Disables a tunnel interface without discarding configuration.

interfaces tunnel <tunx> encapsulation

Sets the encapsulation for a tunnel interface.

interfaces tunnel <tunx> firewall

All commands for configuring firewall on tunnel interfaces

are given in the Vyatta Security Reference Guide.

interfaces tunnel <tunx> ip ospf

All commands for configuring firewall on tunnel interfaces

are given in Chapter 15: OSPF. See page 688.

interfaces tunnel <tunx> key <key>

Defines an authentication key for a tunnel interface.

interfaces tunnel <tunx> local-ip <ipv4>

Sets the IP address for the local endpoint of a tunnel.

Chapter 9: Tunnel Interfaces

Command

431

Description

Tunnel Configuration Commands

interfaces tunnel <tunx> mtu <mtu>

Sets the MTU size for a tunnel interface.

interfaces tunnel <tunx> remote-ip <ipv4>

Sets the IP address for the remote endpoint of a tunnel.

interfaces tunnel <tunx> tos <tos>

Specifies the value to be written into the ToS byte of the

tunnel packets IP header.

interfaces tunnel <tunx> ttl <ttl>

Defines the time-to-live (TTL) value to be written into the

tunnel packets IP header.

Tunnel Operational Commands

clear interfaces tunnel counters

Clears tunnel interface statistics.

show interfaces tunnel

Displays information about tunnel interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 9: Tunnel Interfaces

clear interfaces tunnel counters

clear interfaces tunnel counters

Clears tunnel interface statistics.

Syntax
clear interfaces tunnel [tunx] counters

Command Mode
Operational mode.

Parameters

tunx

Optional. Clears information for the specified tunnel interface. The

range is tun0 to tun23.

Default
None.

Usage Guidelines
Use this command to clear statistics for tunnel interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

432

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx>

interfaces tunnel <tunx>

Defines a tunnel interface.

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

Mandatory. Multi-node. An identifier for the tunnel interface you are

defining. The range is tun0 to tun23.
You can define multiple tunnel interfaces by creating multiple tunnel
configuration nodes.

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> address <ipv4net>

interfaces tunnel <tunx> address <ipv4net>

Sets a primary or secondary IP address for a tunnel interface.

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

Multi-node. An IPv4 network address in the format ip-address/prefix.

You can define more than one IP address for a tunnel interface by
creating multiple address configuration nodes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

434

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> address <ipv4net>

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> description <descr>

interfaces tunnel <tunx> description <descr>

Specifies a description for a tunnel interface.

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

A mnemonic name or description for the interface. The default is an

empty string.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

436

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> description <descr>

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> disable

interfaces tunnel <tunx> disable

Disables a tunnel interface without discarding configuration.

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> encapsulation

interfaces tunnel <tunx> encapsulation

Sets the encapsulation for a tunnel interface.

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

Uses Generic Routing Encapsulation (GRE) to encapsulate transported

packets.

ipip

Uses IP-in-IP to encapsulate transported packets.

Default
GRE is the encapsulation type.

Command Reference

Rel VC4.1 v. 03

Vyatta

439

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> encapsulation

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> key <key>

interfaces tunnel <tunx> key <key>

Defines an authentication key for a tunnel interface.

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> key <key>

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> local-ip <ipv4>

interfaces tunnel <tunx> local-ip <ipv4>

Sets the IP address for the local endpoint of a tunnel.

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

Mandatory. The IPv4 address to be used as the tunnel endpoint on the

local router. The IP address must already be configured for the interface.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

443

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> local-ip <ipv4>

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> mtu <mtu>

interfaces tunnel <tunx> mtu <mtu>

Sets the MTU size for a tunnel interface.

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> mtu <mtu>

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> remote-ip <ipv4>

interfaces tunnel <tunx> remote-ip <ipv4>

Sets the IP address for the remote endpoint of a tunnel.

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

Mandatory. The IPv4 address to be used as the tunnel endpoint on the

remote router. The IP address must already be configured for the
interface.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

447

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> remote-ip <ipv4>

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> tos <tos>

interfaces tunnel <tunx> tos <tos>

Specifies the value to be written into the ToS byte of the tunnel packets IP header.

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> tos <tos>

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

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> ttl <ttl>

interfaces tunnel <tunx> ttl <ttl>

Defines the time-to-live (TTL) value to be written into the tunnel packets IP header.

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

Mandatory. The name of the tunnel interface you are

configuring. The range is tun0 to tun23.

ttl

Optional. The value to be written into the TTL field in tunnel

packet IP headers (the carrier packet). The range is 0 to 255,
where 0 means tunnel packets copy the TTL 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

451

Chapter 9: Tunnel Interfaces

interfaces tunnel <tunx> ttl <ttl>

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

Chapter 9: Tunnel Interfaces

show interfaces tunnel

show interfaces tunnel

Displays information about tunnel interfaces.

Syntax
show interfaces tunnel [tunx [brief] | detail]

Command Mode
Operational mode.

Parameters

tunx

Optional. Displays information for the specified tunnel interface. The

range is tun0 to tun23.

brief

Optional. Displays a brief status of the specified tunnel.

detail

Optional. Displays a detailed status of the tunnel interfaces.

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

Chapter 9: Tunnel Interfaces

Command Reference

show interfaces tunnel

Rel VC4.1 v. 03

Vyatta

454

455

Chapter 10: PPPoE

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

ADSL PPPoE Configuration Commands

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

Enables or disables a PPPoE unit on a PVC with

PPPoE encapsulation on an ADSL interface.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

access-concentrator <name>

Allows you to restrict ADSL PPPoE sessions to one

specific access concentrator.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

connect-on-demand

Enables or disables on-demand PPPoE connection

on an ADSL PPPoE unit.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

default-route <param>

Enables or disables automatically adding a default

route when an ADSL PPPoE link is brought up.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> firewall

All commands for configuring Firewall on PPPoE

interfaces are given in the Vyatta Security Reference
Guide.

Chapter 10: PPPoE

456

Command

Description

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

idle-timeout <timeout>

Specifies the length of time in seconds to wait

before disconnecting an idle on-demand ADSL
PPPoE session.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf

All commands for configuring OSPF on PPPoE

interfaces are given in Chapter 15: OSPF.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip

All commands for configuring RIP on PPPoE

interfaces are given in Chapter 14: RIP.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

local-address <ipv4>

Sets the IP address of the local endpoint of an ADSL

PPPoE link.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> mtu

<mtu>

Specifies the MTU for an ADSL PPPoE interface.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

name-server <param>

Specifies whether an ADSL PPPoE interface should

obtain name server entries from the remote peer
interface.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

password <password>

Specifies the password to use to authenticate with a

remote ADSL PPPoE endpoint.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

qos-policy out <policy-name>

Applies an outbound QoS policy to a PVC with

PPPoE encapsulation on an ADSL interface.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

remote-address <ipv4>

Sets the IP address of the remote end of an ADSL

PPPoE link.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

service-name <name>

Allows an ADSL PPPoE interface to restrict

connections to access concentrators by service
name.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> user-id

<user-id>

Specifies the user ID to use to authenticate with a

remote ADSL PPPoE endpoint.

Ethernet PPPoE Configuration Commands

interfaces ethernet <ethx> pppoe <num>

Enables or disables a PPPoE unit on an Ethernet

interface.

interfaces ethernet <ethx> pppoe <num>

access-concentrator <name>

Allows you to restrict Ethernet PPPoE sessions to

one specific access concentrator.

interfaces ethernet <ethx> pppoe <num>

connect-on-demand

Enables or disables on-demand PPPoE connection

on an Ethernet PPPoE unit.

interfaces ethernet <ethx> pppoe <num> default-route

<param>

Enables or disables automatically adding a default

route when an Ethernet PPPoE link is brought up.

interfaces ethernet <ethx> pppoe <num> firewall

All commands for configuring Firewall on PPPoE

interfaces are given in the Vyatta Security Reference
Guide.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 10: PPPoE

457

Command

Description

interfaces ethernet <ethx> pppoe <num> idle-timeout

<timeout>

Specifies the length of time in seconds to wait

before disconnecting an idle on-demand Ethernet
PPPoE session.

interfaces ethernet <ethx> pppoe <num> ip ospf

All commands for configuring OSPF on PPPoE

interfaces are given in Chapter 15: OSPF.

interfaces ethernet <ethx> pppoe <num> ip rip

All commands for configuring RIP on PPPoE

interfaces are given in Chapter 14: RIP.

interfaces ethernet <ethx> pppoe <num> local-address

<ipv4>

Sets the IP address of the local endpoint of an

Ethernet PPPoE link.

interfaces ethernet <ethx> pppoe <num> mtu <mtu>

Specifies the MTU for an Ethernet PPPoE interface.

interfaces ethernet <ethx> pppoe <num> name-server

<param>

Specifies whether an Ethernet PPPoE interface

should obtain name server entries from the remote
peer interface.

interfaces ethernet <ethx> pppoe <num> password

<password>

Specifies the password to use to authenticate with a

remote Ethernet PPPoE endpoint.

interfaces ethernet <ethx> pppoe <num> remote-address

<ipv4>

Sets the IP address of the remote end of an Ethernet

PPPoE link.

interfaces ethernet <ethx> pppoe <num> service-name

<name>

Allows an Ethernet PPPoE interface to restrict

connections to access concentrators by service
name.

interfaces ethernet <ethx> pppoe <num> user-id <user-id>

Specifies the user ID to use to authenticate with a

remote Ethernet PPPoE endpoint.

PPPoE Operational Commands

set interface pppoe <num> down

Operationally shuts down a Point-to-Point Protocol

over Ethernet (PPPoE) interface.

set interface pppoe <num> up

Operationally brings up a PPPoE interface, if it is not

up already.

show interfaces pppoe

Displays information about PPPoE interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

Enables or disables a PPPoE unit on a PVC with PPPoE encapsulation on an ADSL
interface.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

num

Mandatory. The PPPoE unit number. This number must be unique

for a given ADSL interface but need not be globally unique (for
example, a PPPoE unit number 3 can be defined on on both adsl0
and adsl2). The PPPoE interface will be named pppoeunit (e.g.
pppoe7). The range of values is 0 to 15.The range of values is 0 to
15.

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> access-concentrator <name>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

access-concentrator <name>
Allows you to restrict ADSL PPPoE sessions to one specific access concentrator.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface; that
is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

name

The name of the access concentrator for this PPPoE unit to use
exclusively for PPPoE sessions.

Rel VC4.1 v. 03

Vyatta

460

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> access-concentrator <name>

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> connect-on-demand

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

connect-on-demand
Enables or disables on-demand PPPoE connection on an ADSL PPPoE unit.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

Rel VC4.1 v. 03

Vyatta

462

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> connect-on-demand

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> default-route <param>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

default-route <param>
Enables or disables automatically adding a default route when an ADSL PPPoE link is
brought up.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

Rel VC4.1 v. 03

Vyatta

464

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> default-route <param>

param

Mandatory. Specifies whether a default route is automatically added

when the PPP link comes up.
auto: The PPP process automatically adds a default route to the
remote end of the link.
none: No default route is added.

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> idle-timeout <timeout>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

idle-timeout <timeout>
Specifies the length of time in seconds to wait before disconnecting an idle on-demand
ADSL PPPoE session.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

Rel VC4.1 v. 03

Vyatta

466

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> idle-timeout <timeout>

timeout

Mandatory. The amount of time, in seconds, after which an idle

connection will be closed. The range is 0 to 4294967295, where 0
means the connection is never closed.

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> local-address <ipv4>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

local-address <ipv4>
Sets the IP address of the local endpoint of an ADSL PPPoE link.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> local-address <ipv4>

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> mtu <mtu>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> mtu

<mtu>
Specifies the MTU for an ADSL PPPoE interface.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> mtu <mtu>

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> name-server <param>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

name-server <param>
Specifies whether an ADSL PPPoE interface should obtain name server entries from the
remote peer interface.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

Rel VC4.1 v. 03

Vyatta

472

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> name-server <param>

param

Mandatory. Specifies whether the local PPPoE endpoint should

obtain name server entries from the remote endpoint. Supported
values are as follows:
auto: The endpoint obtains name server entries from its peer.
none: The endpoint uses the name server(s) configured for the local
system.

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> password <password>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

password <password>
Specifies the password to use to authenticate with a remote ADSL PPPoE endpoint.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

password

Mandatory. The password used to authenticate the local endpoint

with the remote PPPoE server.

Rel VC4.1 v. 03

Vyatta

474

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> password <password>

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> qos-policy out <policy-name>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

qos-policy out <policy-name>
Applies an outbound QoS policy to a PVC with PPPoE encapsulation on an ADSL
interface.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface; that
is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

policy-name

The name of the outbound QoS policy to apply to this interface.

Rel VC4.1 v. 03

Vyatta

476

Chapter 10: PPPoE

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> remote-address <ipv4>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

remote-address <ipv4>
Sets the IP address of the remote end of an ADSL PPPoE link.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

ipv4

Mandatory. The IP address of the remote end of the PPPoE link.

Only one remote address can be specified.

Rel VC4.1 v. 03

Vyatta

478

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> remote-address <ipv4>

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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> service-name <name>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

service-name <name>
Allows an ADSL PPPoE interface to restrict connections to access concentrators by service
name.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

Rel VC4.1 v. 03

Vyatta

480

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> service-name <name>

name

Mandatory. A service name. The local endpoint will send session

requests only to access concentrators advertising this service 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

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> user-id <user-id>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num>

user-id <user-id>
Specifies the user ID to use to authenticate with a remote ADSL PPPoE endpoint.

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

Mandatory. The name of the interface. This can be the name of a

PPPoA-, PPPoE-, or Classical IPOA- encapsulated DSL interface;
that is the interface name can be pppoax, pppoex, or 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

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

user-id

Optional. The user ID to be used by the local endpoint to

authenticate itself to the remote endpoint.

Rel VC4.1 v. 03

Vyatta

482

Chapter 10: PPPoE

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> user-id <user-id>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num>

interfaces ethernet <ethx> pppoe <num>

Enables or disables a PPPoE unit on an Ethernet interface.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The PPPoE unit number. This number must be unique

for a given Ethernet interface but need not be globally unique (for
example, a PPPoE unit number 3 can be defined on on both eth0 and
eth2). The PPPoE interface will be named pppoeunit (e.g. pppoe7).
The range of values is 0 to 15.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

484

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> access-concentrator <name>

interfaces ethernet <ethx> pppoe <num>

access-concentrator <name>
Allows you to restrict Ethernet PPPoE sessions to one specific access concentrator.

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

Mandatory. The name of a defined Ethernet interface. The range is eth0

to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> access-concentrator <name>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> connect-on-demand

interfaces ethernet <ethx> pppoe <num>

connect-on-demand
Enables or disables on-demand PPPoE connection on an Ethernet PPPoE unit.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

Default
On-demand PPPoE connection is disabled.

Command Reference

Rel VC4.1 v. 03

Vyatta

488

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> connect-on-demand

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> default-route <param>

interfaces ethernet <ethx> pppoe <num> default-route

<param>
Enables or disables automatically adding a default route when an Ethernet PPPoE link is
brought up.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

param

Mandatory. Specifies whether a default route is automatically added

when the PPP link comes up.
auto: The PPP process automatically adds a default route to the
remote end of the link.
none: No default route is added.

Command Reference

Rel VC4.1 v. 03

Vyatta

490

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> default-route <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 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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> idle-timeout <timeout>

interfaces ethernet <ethx> pppoe <num> idle-timeout

<timeout>
Specifies the length of time in seconds to wait before disconnecting an idle on-demand
Ethernet PPPoE session.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

timeout

Mandatory. The amount of time, in seconds, after which an idle

connection will be closed. The range is 0 to 4294967295, where 0
means the connection is never closed.

Default
Idle connections are never disconnected.

Command Reference

Rel VC4.1 v. 03

Vyatta

492

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> idle-timeout <timeout>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> local-address <ipv4>

interfaces ethernet <ethx> pppoe <num> local-address

<ipv4>
Sets the IP address of the local endpoint of an Ethernet PPPoE link.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> local-address <ipv4>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> mtu <mtu>

interfaces ethernet <ethx> pppoe <num> mtu <mtu>

Specifies the MTU for an Ethernet PPPoE interface.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> mtu <mtu>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> name-server <param>

interfaces ethernet <ethx> pppoe <num> name-server

<param>
Specifies whether an Ethernet PPPoE interface should obtain name server entries from the
remote peer interface.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

param

Mandatory. Specifies whether the local PPPoE endpoint should

obtain name server entries from the remote endpoint. Supported
values are as follows:
auto: The endpoint obtains name server entries from its peer.
none: The endpoint uses the name server(s) configured for the local
system.

Command Reference

Rel VC4.1 v. 03

Vyatta

498

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> name-server <param>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> password <password>

interfaces ethernet <ethx> pppoe <num> password

<password>
Specifies the password to use to authenticate with a remote Ethernet PPPoE endpoint.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

password

Mandatory. The password used to authenticate the local endpoint

with the remote PPPoE server.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

500

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> password <password>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> qos-policy out <policy-name>

interfaces ethernet <ethx> pppoe <num> qos-policy out

<policy-name>
Applies an outbound QoS policy to a PVC with PPPoE encapsulation on an Ethernet
interface.

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

Mandatory. The name of a defined Ethernet interface. The range is eth0

to eth23.

num

Mandatory. The PPPoE unit number. The range of values is 0 to 15.

policy-name

The name of the outbound QoS policy to apply to this interface.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

502

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> qos-policy out <policy-name>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> remote-address <ipv4>

interfaces ethernet <ethx> pppoe <num>

remote-address <ipv4>
Sets the IP address of the remote end of an Ethernet PPPoE link.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

ipv4

Mandatory. The IP address of the remote end of the PPPoE link.

Only one remote address can be specified.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

504

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> remote-address <ipv4>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> service-name <name>

interfaces ethernet <ethx> pppoe <num> service-name

<name>
Allows an Ethernet PPPoE interface to restrict connections to access concentrators by
service name.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

name

Mandatory. A service name. The local endpoint will send session

requests only to access concentrators advertising this service name

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

506

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> service-name <name>

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

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> user-id <user-id>

interfaces ethernet <ethx> pppoe <num> user-id

<user-id>
Specifies the user ID to use to authenticate with a remote Ethernet PPPoE endpoint.

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

Mandatory. The name of a defined Ethernet interface. The range is

eth0 to eth23.

num

Mandatory. The name of a defined PPPoE unit. The range of values

is 0 to 15.

user-id

Optional. The user ID to be used by the local endpoint to

authenticate itself to the remote endpoint.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

508

Chapter 10: PPPoE

interfaces ethernet <ethx> pppoe <num> user-id <user-id>

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

Chapter 10: PPPoE

set interface pppoe <num> down

set interface pppoe <num> down

Operationally shuts down a Point-to-Point Protocol over Ethernet (PPPoE) interface.

Syntax
set interface pppoe num down

Command Mode
Operational mode.

Parameters

num

The PPPoE unit to bring down.

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

Chapter 10: PPPoE

set interface pppoe <num> up

set interface pppoe <num> up

Operationally brings up a PPPoE interface, if it is not up already.

Syntax
set interface pppoe num up

Command Mode
Operational mode.

Parameters

num

The PPPoE unit to bring up.

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

Chapter 10: PPPoE

show interfaces pppoe

show interfaces pppoe

Displays information about PPPoE interfaces.

Syntax
show interfaces pppoe [num]

Command Mode
Operational mode.

Parameters

num

Displays information for the specified PPPoE unit.

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

Chapter 11: Forwarding and Routing

This chapter lists commands for enabling and disabling forwarding, and for
displaying general routing information.
This chapter contains the following commands.
Command

Description

Routing and Forwarding Operational Commands

clear ip prefix-list

Clears prefix list statistics or status.

clear ip route cache

Flushes the kernel route cache.

show ip forwarding

Displays IP forwarding status.

show ip route

Displays routes stored in the RIB and FIB.

show ip route <ipv4net> longer-prefixes

Displays prefixes longer than a specified prefix.

show ip route cache

Displays the kernel route cache.

show ip route connected

Displays directly connected routes.

show ip route forward

Displays routes stored in the FIB.

show ip route static

Displays static routes.

show ip route kernel

Displays kernel routes.

Chapter 11: Forwarding and Routing

514

Command

Description

show ip route supernets-only

Displays supernet routes.

show table

Displays the systems routing table.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 11: Forwarding and Routing

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

Optional. Clears statistics for the specified prefix list.

ipv4net

Optional. Clears statistics for the specified network.

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

Chapter 11: Forwarding and Routing

clear ip route cache

clear ip route cache

Flushes the kernel route cache.

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

Chapter 11: Forwarding and Routing

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

vyatta@vyatta:~$ show ip forwarding

IP forwarding is on
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

517

Chapter 11: Forwarding and Routing

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

Optional. Displays routing information for the specified address.

ipv4net

Optional. Displays routing information for the specified prefix.

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

vyatta@vyatta:~$ show ip route

Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
S>* 0.0.0.0/0 [1/0] via 10.1.0.1, eth0
O
10.1.0.0/24 [110/10] is directly connected, eth0, 05:35:15

Command Reference

Rel VC4.1 v. 03

Vyatta

518

Chapter 11: Forwarding and Routing

show ip route

C>* 10.1.0.0/24 is directly connected, eth0

O>* 10.192.32.0/24 [110/20] via 10.1.0.45, eth0, 05:35:15
O>* 10.192.128.0/24 [110/11] via 10.1.0.66, eth0, 05:35:15
O>* 10.192.128.1/32 [110/11] via 10.1.0.66, eth0, 05:35:15
O>* 10.192.129.0/24 [110/11] via 10.1.0.66, eth0, 05:35:15
O>* 10.192.130.0/24 [110/11] via 10.1.0.66, eth0, 05:35:15
O>* 10.192.131.0/24 [110/11] via 10.1.0.66, eth0, 05:35:15
C>* 127.0.0.0/8 is directly connected, lo
O>* 172.16.0.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.1.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.2.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.3.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.4.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.5.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.6.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.7.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.8.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
O>* 172.16.9.0/24 [110/11] via 10.1.0.4, eth0, 05:35:15
C>* 172.16.234.0/25 is directly connected, eth1
S>* 192.94.202.0/24 [1/0] via 172.16.234.27, eth1
vyatta@vyatta:~$

Example 11-3 shows information for the route 10.192.128.1.

Example 11-3 show ip route <ipv4>: Displaying information about a specific address

vyatta@vyatta:~$ show ip route 10.192.128.1

Routing entry for 10.192.128.1/32
Known via "ospf", distance 110, metric 11, best
Last update 09:47:07 ago
* 10.1.0.66, via eth0
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

519

Chapter 11: Forwarding and Routing

show ip route <ipv4net> longer-prefixes

show ip route <ipv4net> longer-prefixes

Displays prefixes longer than a specified prefix.

Syntax
show ip route ipv4net longer-prefixes

Command Mode
Operational mode.

Parameters

ipv4net

Mandatory. Displays all prefixes longer than the specified prefix.

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

vyatta@vyatta:~$ show ip route 10.192.128.0/24 longer-prefixes

Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
O>* 10.192.128.0/24 [110/11] via 10.1.0.66, eth0, 09:36:20
O>* 10.192.128.1/32 [110/11] via 10.1.0.66, eth0, 09:36:20
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

520

Chapter 11: Forwarding and Routing

show ip route cache

show ip route cache

Displays the kernel route cache.

Syntax
show ip route cache [ipv4net]

Command Mode
Operational mode.

Parameters

ipv4net

Optional. Displays kernel route cache information for the specified

route.

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

vyatta@vyatta:~$ show ip route cache

local 10.1.0.62 from 10.1.0.1 dev lo src 10.1.0.62
cache <local,src-direct> users 1 age 42sec iif eth0
multicast 224.0.0.5 from 10.1.0.45 dev lo src 10.1.0.62
cache <local,mc> users 1 used 8 age 5sec iif eth0
local 10.1.0.62 from 69.59.150.131 dev lo src 10.1.0.62
cache <local> users 1 used 3 age 47sec iif eth0
10.1.0.1 from 10.1.0.62 dev eth0
cache users 1 age 42sec mtu 1500 advmss 1460 hoplimit 64

Command Reference

Rel VC4.1 v. 03

Vyatta

521

Chapter 11: Forwarding and Routing

show ip route cache

10.0.0.30 from 10.1.0.62 tos lowdelay via 10.1.0.1 dev eth0

cache users 2 age 0sec mtu 1500 advmss 1460 hoplimit 64
multicast 224.0.0.5 from 10.1.0.56 dev lo src 10.1.0.62
cache <local,mc> users 1 used 8 age 8sec iif eth0
multicast 224.0.0.5 from 10.1.0.66 dev lo src 10.1.0.62
cache <local,mc> users 1 used 8 age 0sec iif eth0
multicast 224.0.0.6 dev eth0 src 10.1.0.62
cache <mc> users 1 age 21sec mtu 1500 advmss 1460 hoplimit 64
multicast 224.0.0.5 from 10.1.0.4 dev lo src 10.1.0.62
cache <local,mc> users 1 used 9 age 1sec iif eth0
69.59.150.131 via 10.1.0.1 dev eth0 src 10.1.0.62
cache users 1 age 47sec mtu 1500 advmss 1460 hoplimit 64
multicast 224.0.0.5 dev eth0 src 10.1.0.62
cache <local,mc> users 1 used 8 age 5sec mtu 1500 advmss
1460 hoplimit 64
69.59.150.131 from 10.1.0.62 via 10.1.0.1 dev eth0
cache users 1 used 1 age 47sec mtu 1500 advmss 1460 hoplimit
64
local 10.1.0.62 from 10.0.0.30 tos lowdelay dev lo src 10.1.0.62
cache <local> users 1 used 1 age 0sec iif eth0
vyatta@vyatta:~$

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

vyatta@vyatta:~$ show ip route cache 10.1.0.62

local 10.1.0.62 from 10.1.0.1 dev lo src 10.1.0.62
cache <local,src-direct> users 1 used 3 age 9sec iif eth0
local 10.1.0.62 from 69.59.150.131 dev lo src 10.1.0.62
cache <local> users 1 used 7 age 102sec iif eth0
local 10.1.0.62 from 10.0.0.30 tos lowdelay dev lo src 10.1.0.62
cache <local> users 1 used 33 iif eth0
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

522

Chapter 11: Forwarding and Routing

show ip route connected

show ip route connected

Displays directly connected routes.

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

Chapter 11: Forwarding and Routing

show ip route forward

show ip route forward

Displays routes stored in the FIB.

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

vyatta@vyatta:~$ show ip route forward

default via 10.1.0.1 dev eth0 proto zebra
10.1.0.0/24 dev eth0 proto kernel scope link src 10.1.0.62
10.192.32.0/24 via 10.1.0.45 dev eth0 proto zebra metric 20
10.192.128.0/24 via 10.1.0.66 dev eth0 proto zebra metric 11
10.192.128.1 via 10.1.0.66 dev eth0 proto zebra metric 11
10.192.129.0/24 via 10.1.0.66 dev eth0 proto zebra metric 11
10.192.130.0/24 via 10.1.0.66 dev eth0 proto zebra metric 11

Command Reference

Rel VC4.1 v. 03

Vyatta

524

Chapter 11: Forwarding and Routing

show ip route forward

10.192.131.0/24 via 10.1.0.66 dev eth0 proto zebra metric 11

172.16.0.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.1.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.2.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.3.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.4.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.5.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.6.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.7.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.8.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.9.0/24 via 10.1.0.4 dev eth0 proto zebra metric 11
172.16.234.0/25 dev eth1 proto kernel scope link src
172.16.234.23
192.94.202.0/24 via 172.16.234.27 dev eth1 proto zebra
vyatta@vyatta:~$

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

vyatta@vyatta:~$ show ip route forward 10.1.0.0/24

10.1.0.0/24 dev eth0 proto kernel scope link src 10.1.0.62
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

525

Chapter 11: Forwarding and Routing

show ip route kernel

show ip route kernel

Displays kernel routes.

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

vyatta@vyatta:~$ show ip route kernel

Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
K>* 10.172.24.0/24 via 10.1.0.1, eth0
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

526

Chapter 11: Forwarding and Routing

show ip route static

show ip route static

Displays static routes.

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

vyatta@vyatta:~$ show ip route static

Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
S>* 0.0.0.0/0 [1/0] via 10.1.0.1, eth0
S>* 192.94.202.0/24 [1/0] via 172.16.234.27, eth1
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

527

Chapter 11: Forwarding and Routing

show ip route supernets-only

show ip route supernets-only

Displays supernet routes.

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

vyatta@vyatta:~$ show ip route supernets-only

Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
S>* 0.0.0.0/0 [1/0] via 10.1.0.1, eth0
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

528

Chapter 11: Forwarding and Routing

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

vyatta@vyatta:~$ show table

table 0
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

529

530

Chapter 12: Bridging

This chapter lists the commands used for Spanning Tree Protocol and bridging.
This chapter contains the following commands.
Command

Description

Bridging Configuration Commands

interfaces bridge <brx>

Defines a bridge group and its spanning tree

parameters.

interfaces bridge <brx> address <address>

Specifies an IP address for the interface.

interfaces bridge <brx> aging <age>

Specifies the MAC address aging timeout.

interfaces bridge <brx> description <desc>

Specifies a description for the bridge group.

interfaces bridge <brx> disable <state>

Specifies whether or not bridging is enabled on the

interface.

interfaces bridge <brx> forwarding-delay <delay>

Specifies the amount of time the bridge will keep

listening after a topology change.

interfaces bridge <brx> hello-time <interval>

Specifies the hello packet interval.

interfaces bridge <brx> max-age <interval>

Specifies how long to wait for a hello packet.

Chapter 12: Bridging

531

Command

Description

interfaces bridge <brx> priority <priority>

Specifies the forwarding priority of this bridge in the

spanning tree.

interfaces bridge <brx> stp <state>

Specifies whether or not the Spanning Tree Protocol

is enabled on the interface.

interfaces ethernet <ethx> bridge-group bridge <group-id>

Specify a bridge group to add an Ethernet interface

to.

interfaces ethernet <ethx> bridge-group cost <cost>

Specify a path cost for a bridge group on an

Ethernet interface.

interfaces ethernet <ethx> bridge-group priority <priority>

Specify a path priority for a bridge group on an

Ethernet interface.

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>

Specify a path cost for a bridge group on a virtual

interface.

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>

Clears the systems ARP cache for the specified IP

address. See page 52 in Chapter 3: System
Management.

clear interfaces bridge counters

Clears bridge interface counters.

show arp

Displays the systems ARP cache. See page 64 in

Chapter 3: System Management..

show bridge

Displays the information for active bridge groups.

show interfaces

Displays information about system interfaces. See

page 78 in Chapter 3: System Management..

show interfaces bridge

Shows bridge interface information.

show interfaces ethernet

Displays information about an Ethernet vif. See

page 258 in Chapter 6: Ethernet Interfaces, VLAN
Interfaces, and the Loopback Interface.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 12: Bridging

clear interfaces bridge counters

clear interfaces bridge counters

Clears bridge interface counters.

Syntax
clear interfaces bridge [ethx] counters

Command Mode
Operational mode.

Parameters

ethx

Optional. The identifier for the Ethernet interface whose bridging

counters you wish to clear. This may be eth0 to eth23, depending on
what Ethernet interfaces that are actually available on the system.

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

Chapter 12: Bridging

interfaces bridge <brx>

interfaces bridge <brx>

Defines a bridge group and its spanning tree parameters.

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

Chapter 12: Bridging

interfaces bridge <brx> address <address>

interfaces bridge <brx> address <address>

Specifies an IP address for the interface.

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

Chapter 12: Bridging

interfaces bridge <brx> address <address>

Use the show form of this command to view the IP address.

Command Reference

Rel VC4.1 v. 03

Vyatta

535

Chapter 12: Bridging

interfaces bridge <brx> aging <age>

interfaces bridge <brx> aging <age>

Specifies the MAC address aging timeout.

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

Chapter 12: Bridging

interfaces bridge <brx> aging <age>

Use the show form of this command to view the aging configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

537

Chapter 12: Bridging

interfaces bridge <brx> description <desc>

interfaces bridge <brx> description <desc>

Specifies a description for the bridge group.

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

Optional. A brief description for the bridge group.

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

Chapter 12: Bridging

interfaces bridge <brx> disable <state>

interfaces bridge <brx> disable <state>

Specifies whether or not bridging is enabled on the interface.

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

Optional. Enables or disables bridging on this interface. Supported

values are as follows:
trueDisables bridging on this interface, without discarding the
configuration.
falseEnables bridging on this interface.

Default
The default is false.

Command Reference

Rel VC4.1 v. 03

Vyatta

539

Chapter 12: Bridging

interfaces bridge <brx> disable <state>

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

Chapter 12: Bridging

interfaces bridge <brx> forwarding-delay <delay>

interfaces bridge <brx> forwarding-delay <delay>

Specifies the amount of time the bridge will keep listening after a topology change.

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

Chapter 12: Bridging

interfaces bridge <brx> forwarding-delay <delay>

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

Chapter 12: Bridging

interfaces bridge <brx> hello-time <interval>

interfaces bridge <brx> hello-time <interval>

Specifies the hello packet interval.

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

Optional. The interval in seconds at which this bridge will transmit

hello packets, which are messages that communicate the state of the
spanning tree topology. On a spanning tree, hello packets are sent by the
bridge that assumes itself to be the root bridge.
The range is 1 to 4294967295.

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

Chapter 12: Bridging

interfaces bridge <brx> hello-time <interval>

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

Chapter 12: Bridging

interfaces bridge <brx> max-age <interval>

interfaces bridge <brx> max-age <interval>

Specifies how long to wait for a hello packet.

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

Chapter 12: Bridging

interfaces bridge <brx> max-age <interval>

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

Chapter 12: Bridging

interfaces bridge <brx> priority <priority>

interfaces bridge <brx> priority <priority>

Specifies the forwarding priority of this bridge in the spanning tree.

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

Chapter 12: Bridging

interfaces bridge <brx> stp <state>

interfaces bridge <brx> stp <state>

Specifies whether or not the Spanning Tree Protocol is enabled on the interface.

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

Optional. Allows you to enable or disable the Spanning Tree Protocol on

a per-bridge basis. Supported values are as follows:
true: Enables Spanning Tree Protocol on this bridge.
false: Disables Spanning Tree Protocol on this bridge.

Default
The default is false.

Command Reference

Rel VC4.1 v. 03

Vyatta

548

Chapter 12: Bridging

interfaces bridge <brx> stp <state>

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

Chapter 12: Bridging

interfaces ethernet <ethx> bridge-group bridge <group-id>

interfaces ethernet <ethx> bridge-group bridge

<group-id>
Specify a bridge group to add an Ethernet interface to.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Chapter 12: Bridging

interfaces ethernet <ethx> bridge-group bridge <group-id>

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

Chapter 12: Bridging

interfaces ethernet <ethx> bridge-group cost <cost>

interfaces ethernet <ethx> bridge-group cost <cost>

Specify a path cost for a bridge group on an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Chapter 12: Bridging

interfaces ethernet <ethx> bridge-group cost <cost>

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

Chapter 12: Bridging

interfaces ethernet <ethx> bridge-group priority <priority>

interfaces ethernet <ethx> bridge-group priority

<priority>
Specify a path priority for a bridge group on an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Chapter 12: Bridging

interfaces ethernet <ethx> bridge-group priority <priority>

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

Chapter 12: Bridging

interfaces ethernet <ethx> vif <vlan-id> bridge-group bridge <group-id>

interfaces ethernet <ethx> vif <vlan-id> bridge-group

bridge <group-id>
Specify a bridge group to add a virtual interface to.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

vlan-id

The VLAN ID for the vif. The range is 0 to 4095.

group-id

The bridge group ID to assign the interface to. Supported identifiers are
br0 through br9.

Rel VC4.1 v. 03

Vyatta

556

Chapter 12: Bridging

interfaces ethernet <ethx> vif <vlan-id> bridge-group bridge <group-id>

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

Chapter 12: Bridging

interfaces ethernet <ethx> vif <vlan-id> bridge-group cost <cost>

interfaces ethernet <ethx> vif <vlan-id> bridge-group

cost <cost>
Specify a path cost for a bridge group on a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

vlan-id

The VLAN ID for the vif. The range is 0 to 4095.

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

Chapter 12: Bridging

interfaces ethernet <ethx> vif <vlan-id> bridge-group cost <cost>

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

Chapter 12: Bridging

interfaces ethernet <ethx> vif <vlan-id> bridge-group priority <priority>

interfaces ethernet <ethx> vif <vlan-id> bridge-group

priority <priority>
Specify a path priority for a bridge group on a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

vlan-id

The VLAN ID for the vif. The range is 0 to 4095.

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

Chapter 12: Bridging

interfaces ethernet <ethx> vif <vlan-id> bridge-group priority <priority>

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

Chapter 12: Bridging

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

Displays information for the specified bridge group: one of br0

through br9.

macs

Shows the MAC table for the specified bridge.

spanning-tree

Shows spanning tree information for the specified bridge.

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

Chapter 12: Bridging

show interfaces bridge

show interfaces bridge

Shows bridge interface information.

Syntax
show interfaces bridge [bridge-group [brief] | detail]

Command Mode
Operational mode.

Parameters

bridge-group

Displays information for the specified bridge group: one of br0

through br9.

brief

Shows a summary of information for a given bridge group.

detail

Shows detailed bridge interface information.

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

Chapter 13: Static Routes

This chapter lists the commands for configuring static routes on the Vyatta system.
This chapter contains the following commands.

Command

Description

Static Route Configuration Commands

protocols static interface-route <subnet>
next-hop-interface <ethx>

Allows you to configure the next hop interface for an

interface-based static route.

protocols static route <subnet> blackhole

Allows you to configure a blackhole static route.

protocols static route <subnet> next-hop <address> Allows you to configure the next hop for a static route.

Static Route Operational Commands

show ip route static

Displays static routes. See page 527.

Chapter 13: Static Routes

protocols static interface-route <subnet> next-hop-interface <ethx>

protocols static interface-route <subnet>

next-hop-interface <ethx>
Allows you to configure the next hop interface for an interface-based 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

Mandatory. Multi-node. Defines an interface-based static route.

The format is a destination subnet of the form address/prefix.
You can define multiple interface-based routes by creating
multiple interface-route configuration nodes.

Command Reference

ethx

Mandatory. The next hop Ethernet interface.

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

Chapter 13: Static Routes

protocols static interface-route <subnet> next-hop-interface <ethx>

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

Chapter 13: Static Routes

protocols static route <subnet> blackhole

protocols static route <subnet> blackhole

Allows you to configure a blackhole static route.

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

Mandatory. Multi-node. Defines a static route. The format is a

destination subnet of the form address/prefix.
You can define multiple static routes by creating multiple route
configuration nodes.

distance

Optional. Defines the blackhole 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

567

Chapter 13: Static Routes

protocols static route <subnet> blackhole

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

Chapter 13: Static Routes

protocols static route <subnet> next-hop <address>

protocols static route <subnet> next-hop <address>

Allows you to configure the next hop for a static route.

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

Mandatory. Multi-node. Defines a static route. The format is a

destination subnet of the form address/prefix.
You can define multiple static routes by creating multiple route
configuration nodes.

address

Mandatory. The address of the next hop router.

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

Chapter 13: Static Routes

protocols static route <subnet> next-hop <address>

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

Chapter 14: RIP

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

RIP Router-Level Configuration Commands

protocols rip default-distance <distance>

Sets the administrative distance for RIP.

protocols rip default-information originate

Generates a default route into a RIP routing domain.

protocols rip default-metric <metric>

Sets the default metric for external routes redistributed

into RIP.

protocols rip distribute-list access-list

Applies an access list for filtering inbound or outbound

RIP packets.

protocols rip distribute-list interface <ethx> access-list

Applies an access list to a specific interface for filtering

inbound or outbound RIP packets.

protocols rip distribute-list interface <ethx> prefix-list

Applies a prefix list to a specific interface for filtering

inbound or outbound RIP packets.

protocols rip distribute-list prefix-list

Applies a prefix list for filtering inbound or outbound RIP

packets.

Chapter 14: RIP

572

Command

Description

protocols rip interface <ethx>

Enables the Routing Information Protocol (RIP) for an

interface.

protocols rip neighbor <ipv4>

Defines a RIP neighbor router.

protocols rip network <ipv4net>

Specifies a network for the Routing Information Protocol

(RIP).

protocols rip network-distance <ipv4net>

Specifies the administrative distance for a RIP network.

protocols rip passive-interface <ethx>

Suppresses RIP routing updates on an interface.

protocols rip redistribute bgp

Allows you to redistribute BGP routes into RIP routing

tables.

protocols rip redistribute connected

Allows you to redistribute directly connected routes into

RIP routing tables.

protocols rip redistribute kernel

Allows you to redistribute kernel routes into RIP routing

tables.

protocols rip redistribute ospf

Allows you to redistribute OSPF routes into RIP routing

tables.

protocols rip redistribute static

Allows you to redistribute static routes into RIP routing

tables.

protocols rip route <ipv4net>

Specifies a RIP static route.

protocols rip timers garbage-collection <seconds>

Allows you to set timers for RIP garbage collection.

protocols rip timers timeout <seconds>

Allows you to set the interval for RIP time-outs.

protocols rip timers update <seconds>

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

Enables RIP on an ADSL PVC with Classical IPOA

encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip

authentication

Specify RIP authentication for an ADSL PVC with

Classical IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip

split-horizon <param>

Enables or disables split-horizon in RIP updates coming

from an ADSL PVC with Classical IPOA encapsulation.

RIP Configuration Commands for ADSL Interfaces with Classical PPPoA Encapsulation
interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip
rip

Enables RIP on an ADSL PVC with PPPoA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

rip authentication

Specify RIP authentication for an ADSL PVC with PPPoA

encapsulation.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 14: RIP

573

Command

Description

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

rip split-horizon poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from an ADSL PVC with PPPoA
encapsulation.

RIP Configuration Commands for ADSL Interfaces with PPPoE Encapsulation

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip
rip

Enables RIP on an ADSL PVC with PPPoE encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

rip authentication

Specify RIP authentication for an ADSL PVC with PPPoE

encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

rip split-horizon poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from an ADSL PVC with PPPoE
encapsulation.

RIP Configuration Commands for Ethernet Interfaces

interfaces ethernet <ethx> ip rip

Enables RIP on an Ethernet interface.

interfaces ethernet <ethx> ip rip authentication

Specify RIP authentication for the Ethernet interface.

interfaces ethernet <ethx> ip rip split-horizon

poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

RIP Configuration Commands for Ethernet PPPoE interfaces

interfaces ethernet <ethx> pppoe <num> ip rip

Enables RIP on a PPPoE interface.

interfaces ethernet <ethx> pppoe <num> ip rip

authentication

Specifies authentication for RIP on a PPPoE interface.

interfaces ethernet <ethx> pppoe <num> ip rip

split-horizon poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

RIP Configuration Commands for Ethernet Vifs

interfaces ethernet <ethx> vif <vlan-id> ip rip

Enables RIP on a virtual interface.

interfaces ethernet <ethx> vif <vlan-id> ip rip

authentication

Specify RIP authentication for the virtual interface.

interfaces ethernet <ethx> vif <vlan-id> ip rip

split-horizon poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

RIP Configuration Commands for Loopback Interfaces

interfaces loopback lo ip rip

Enables RIP on the loopback interface.

interfaces loopback lo ip rip authentication

Specify RIP authentication for the loopback interface.

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

Chapter 14: RIP

574

Command

Description

RIP Configuration Commands for Multilink Interfaces

interfaces multilink <mlx> ip rip

Enables RIP on a multilink interface.

interfaces multilink <mlx> ip rip authentication

Specifies authentication for RIP on a multilink interface.

interfaces multilink <mlx> ip rip split-horizon

poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

RIP Configuration Commands for Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

Enables RIP on the virtual interface of a Cisco HDLC

serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

authentication

Specifies authentication for RIP on a Cisco HDLC serial

interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

split-horizon poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

interfaces serial <wanx> frame-relay vif <dlci> ip rip

Enables RIP on the virtual interface of a Frame Relay

serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip rip

authentication

Specifies authentication for RIP on a Frame Relay serial

interface.

interfaces serial <wanx> frame-relay vif <dlci> ip rip

split-horizon poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

interfaces serial <wanx> ppp vif 1 ip rip

Enables RIP on the virtual interface of a PPP serial

interface.

interfaces serial <wanx> ppp vif 1 ip rip authentication

Specifies authentication for RIP on a virtual interface of a

PPP serial interface.

interfaces serial <wanx> ppp vif 1 ip rip split-horizon

poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

RIP Configuration Commands for Tunnel Interfaces

interfaces tunnel <tunx> ip rip

Enables RIP on a tunnel interface.

interfaces tunnel <tunx> ip rip authentication

Specifies authentication for RIP on a tunnel interface.

interfaces tunnel <tunx> ip rip split-horizon

poison-reverse

Enables or disables split-horizon poison-reverse in RIP

updates coming from this interface.

RIP Debug Commands

debug rip events

Command Reference

Enables or disables debug message generation related to

RIP events.

Rel VC4.1 v. 03

Vyatta

Chapter 14: RIP

575

Command

Description

debug rip packet

Enables or disables debug message generation related to

all RIP packet types.

debug rip zebra

Enables or disables debug message generation for the

Zebra RIP process.

RIP Show Commands

show debugging rip

Displays RIP protocol debugging flags.

show ip route rip

Displays all IP RIP routes.

show ip rip

Displays information for the Routing Information

Protocol (RIP).

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 14: RIP

debug rip events

debug rip events

Enables or disables debug message generation related to RIP events.

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

Chapter 14: RIP

debug rip packet

debug rip packet

Enables or disables debug message generation related to all RIP packet types.

Syntax
debug rip packet [recv [detail] | send [detail]]
no debug rip packet [recv | send ]

Command Mode
Operational mode.

Parameters

recv

Optional. Provides debugging on all received packets.

recv detail

Optional. Provides detailed debugging on all received packets.

send

Optional. Provides debugging on all sent packets.

send detail

Optional. Provides detailed debugging on all sent packets.

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

Chapter 14: RIP

debug rip zebra

debug rip zebra

Enables or disables debug message generation for the Zebra RIP process.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip

Enables RIP on an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip authentication

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip

authentication
Specify RIP authentication for an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip authentication

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in simple (plain-text) authentication.

This must be the same on both the sending and receiving systems.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip authentication

Use the show form of this command to display RIP authentication configuration
information.

Command Reference

Rel VC4.1 v. 03

Vyatta

583

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip split-horizon <param>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip

split-horizon <param>
Enables or disables split-horizon in RIP updates coming from an ADSL PVC with Classical
IPOA encapsulation.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip rip split-horizon <param>

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip

Enables RIP on an ADSL PVC with PPPoA encapsulation.

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

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

Rel VC4.1 v. 03

Vyatta

586

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip authentication

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip

authentication
Specify RIP authentication for an ADSL PVC with PPPoA encapsulation.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip authentication

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

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in simple (plain-text) authentication.

This must be the same on both the sending and receiving systems.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip authentication

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip split-horizon poison-reverse

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip rip

split-horizon poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from an ADSL
PVC with PPPoA encapsulation.

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

Chapter 14: RIP

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

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip

Enables RIP on an ADSL PVC with PPPoE encapsulation.

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

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

Rel VC4.1 v. 03

Vyatta

593

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip authentication

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip

authentication
Specify RIP authentication for an ADSL PVC with PPPoE encapsulation.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip authentication

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

Mandatory. The name of a defined PPPoE unit. The range of values is

0 to 15.

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in simple (plain-text) authentication.

This must be the same on both the sending and receiving systems.

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip authentication

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

Chapter 14: RIP

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip split-horizon poison-reverse

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip rip

split-horizon poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from an ADSL
PVC with PPPoE encapsulation.

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

Chapter 14: RIP

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

Mandatory. The name of a defined PPPoE unit. The range of values is

0 to 15.

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

Chapter 14: RIP

interfaces ethernet <ethx> ip rip

interfaces ethernet <ethx> ip rip

Enables RIP on an Ethernet interface.

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

Chapter 14: RIP

interfaces ethernet <ethx> ip rip authentication

interfaces ethernet <ethx> ip rip authentication

Specify RIP authentication for the Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

601

Chapter 14: RIP

interfaces ethernet <ethx> ip rip authentication

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in simple (plain-text) authentication.

This must be the same on both the sending and receiving systems.

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

Chapter 14: RIP

interfaces ethernet <ethx> ip rip split-horizon poison-reverse

interfaces ethernet <ethx> ip rip split-horizon

poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

603

Chapter 14: RIP

interfaces ethernet <ethx> ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces ethernet <ethx> pppoe <num> ip rip

interfaces ethernet <ethx> pppoe <num> ip rip

Enables RIP on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

num

Mandatory. The name of a defined PPPoE unit. The range is 0 to 15.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

605

Chapter 14: RIP

interfaces ethernet <ethx> pppoe <num> ip rip

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

Chapter 14: RIP

interfaces ethernet <ethx> pppoe <num> ip rip authentication

interfaces ethernet <ethx> pppoe <num> ip rip

authentication
Specifies authentication for RIP on a PPPoE interface.

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

Chapter 14: RIP

interfaces ethernet <ethx> pppoe <num> ip rip authentication

Parameters

ethx

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

num

Mandatory. The name of a defined PPPoE unit. The range is 0 to 15.

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must

be eight characters or less and the same on both the sending and
receiving systems.

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

Chapter 14: RIP

interfaces ethernet <ethx> pppoe <num> ip rip split-horizon poison-reverse

interfaces ethernet <ethx> pppoe <num> ip rip

split-horizon poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

num

Command Reference

Mandatory. The name of a defined PPPoE unit. The range is 0 to 15.

Rel VC4.1 v. 03

Vyatta

609

Chapter 14: RIP

interfaces ethernet <ethx> pppoe <num> ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces ethernet <ethx> vif <vlan-id> ip rip

interfaces ethernet <ethx> vif <vlan-id> ip rip

Enables RIP on a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Chapter 14: RIP

interfaces ethernet <ethx> vif <vlan-id> ip rip

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

Chapter 14: RIP

interfaces ethernet <ethx> vif <vlan-id> ip rip authentication

interfaces ethernet <ethx> vif <vlan-id> ip rip

authentication
Specify RIP authentication for the virtual interface.

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

Chapter 14: RIP

interfaces ethernet <ethx> vif <vlan-id> ip rip authentication

Parameters

ethx

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in simple (plain-text) authentication.

This must be the same on both the sending and receiving systems.

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

Chapter 14: RIP

interfaces ethernet <ethx> vif <vlan-id> ip rip authentication

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

Chapter 14: RIP

interfaces ethernet <ethx> vif <vlan-id> ip rip split-horizon poison-reverse

interfaces ethernet <ethx> vif <vlan-id> ip rip

split-horizon poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

616

Chapter 14: RIP

interfaces ethernet <ethx> vif <vlan-id> ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces loopback lo ip rip

interfaces loopback lo ip rip

Enables RIP on the loopback interface.

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

Chapter 14: RIP

interfaces loopback lo ip rip authentication

interfaces loopback lo ip rip authentication

Specify RIP authentication for the loopback interface.

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in simple (plain-text) authentication.

This must be the same on both the sending and receiving systems.

Rel VC4.1 v. 03

Vyatta

619

Chapter 14: RIP

interfaces loopback lo ip rip authentication

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

Chapter 14: RIP

interfaces loopback lo ip rip split-horizon poison-reverse

interfaces loopback lo ip rip split-horizon

poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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

Chapter 14: RIP

interfaces loopback lo ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces multilink <mlx> ip rip

interfaces multilink <mlx> ip rip

Enables RIP on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up

to two multilink bundles. Supported values are ml0 (em ell zero)
through ml23 (em ell twenty-three).

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

Chapter 14: RIP

interfaces multilink <mlx> ip rip authentication

interfaces multilink <mlx> ip rip authentication

Specifies authentication for RIP on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up

to two multilink bundles. Supported values are ml0 (em ell zero)
through ml23 (em ell twenty-three).

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

Chapter 14: RIP

interfaces multilink <mlx> ip rip authentication

md5-password

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must

be eight characters or less and the same on both the sending and
receiving systems.

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

Chapter 14: RIP

interfaces multilink <mlx> ip rip split-horizon poison-reverse

interfaces multilink <mlx> ip rip split-horizon

poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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

Mandatory. The identifier of the multilink bundle. You can create up

to two multilink bundles. Supported values are ml0 (em ell zero)
through ml23 (em ell twenty-three).

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

626

Chapter 14: RIP

interfaces multilink <mlx> ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

Enables RIP on the virtual interface of a Cisco HDLC serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

Default
RIP is not enabled on Cisco HDLC interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

628

Chapter 14: RIP

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

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

Chapter 14: RIP

interfaces serial <wanx> cisco-hdlc vif 1 ip rip authentication

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

authentication
Specifies authentication for RIP on a Cisco HDLC serial interface.

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

Chapter 14: RIP

interfaces serial <wanx> cisco-hdlc vif 1 ip rip authentication

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must

be eight characters or less and the same on both the sending and
receiving systems.

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

Chapter 14: RIP

interfaces serial <wanx> cisco-hdlc vif 1 ip rip split-horizon poison-reverse

interfaces serial <wanx> cisco-hdlc vif 1 ip rip

split-horizon poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

632

Chapter 14: RIP

interfaces serial <wanx> cisco-hdlc vif 1 ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces serial <wanx> frame-relay vif <dlci> ip rip

interfaces serial <wanx> frame-relay vif <dlci> ip rip

Enables RIP on the virtual interface of a Frame Relay serial interface.

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

Chapter 14: RIP

interfaces serial <wanx> frame-relay vif <dlci> ip rip

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

Chapter 14: RIP

interfaces serial <wanx> frame-relay vif <dlci> ip rip authentication

interfaces serial <wanx> frame-relay vif <dlci> ip rip

authentication
Specifies authentication for RIP on a Frame Relay serial interface.

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

Chapter 14: RIP

interfaces serial <wanx> frame-relay vif <dlci> ip rip authentication

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must

be eight characters or less and the same on both the sending and
receiving systems.

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

Chapter 14: RIP

interfaces serial <wanx> frame-relay vif <dlci> ip rip split-horizon poison-reverse

interfaces serial <wanx> frame-relay vif <dlci> ip rip

split-horizon poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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

Chapter 14: RIP

interfaces serial <wanx> frame-relay vif <dlci> ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces serial <wanx> ppp vif 1 ip rip

interfaces serial <wanx> ppp vif 1 ip rip

Enables RIP on the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

Default
RIP is not enabled on PPP interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

640

Chapter 14: RIP

interfaces serial <wanx> ppp vif 1 ip rip

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

Chapter 14: RIP

interfaces serial <wanx> ppp vif 1 ip rip authentication

interfaces serial <wanx> ppp vif 1 ip rip authentication

Specifies authentication for RIP on a virtual interface of a PPP serial interface.

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

Chapter 14: RIP

interfaces serial <wanx> ppp vif 1 ip rip authentication

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

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

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must

be eight characters or less and the same on both the sending and
receiving systems.

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

Chapter 14: RIP

interfaces serial <wanx> ppp vif 1 ip rip split-horizon poison-reverse

interfaces serial <wanx> ppp vif 1 ip rip split-horizon

poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

644

Chapter 14: RIP

interfaces serial <wanx> ppp vif 1 ip rip split-horizon poison-reverse

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

Chapter 14: RIP

interfaces tunnel <tunx> ip rip

interfaces tunnel <tunx> ip rip

Enables RIP on a tunnel interface.

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

Chapter 14: RIP

interfaces tunnel <tunx> ip rip authentication

interfaces tunnel <tunx> ip rip authentication

Specifies authentication for RIP on a tunnel interface.

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

Chapter 14: RIP

interfaces tunnel <tunx> ip rip authentication

md5-password

Optional. The password to use in MD5 authentication. This must be

the same on both the sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must

be eight characters or less and the same on both the sending and
receiving systems.

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

Chapter 14: RIP

interfaces tunnel <tunx> ip rip split-horizon poison-reverse

interfaces tunnel <tunx> ip rip split-horizon

poison-reverse
Enables or disables split-horizon poison-reverse in RIP updates coming from this interface.

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

Chapter 14: RIP

interfaces tunnel <tunx> ip rip split-horizon poison-reverse

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

Chapter 14: RIP

protocols rip default-distance <distance>

protocols rip default-distance <distance>

Sets the administrative distance for RIP.

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

Chapter 14: RIP

protocols rip default-information originate

protocols rip default-information originate

Generates a default route into a RIP routing domain.

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

Chapter 14: RIP

protocols rip default-metric <metric>

protocols rip default-metric <metric>

Sets the default metric for external routes redistributed into RIP.

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

Mandatory. The metric that will be assigned to external routes

imported into RIP for redistribution. The range is 1-16. The default is
1.

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

Chapter 14: RIP

protocols rip distribute-list access-list

protocols rip distribute-list access-list

Applies an access list for filtering inbound or outbound RIP packets.

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

Chapter 14: RIP

protocols rip distribute-list access-list

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

Chapter 14: RIP

protocols rip distribute-list interface <ethx> access-list

protocols rip distribute-list interface <ethx> access-list

Applies an access list to a specific interface for filtering inbound or outbound RIP packets.

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

Mandatory. Interface on which to filter packets.

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

Chapter 14: RIP

protocols rip distribute-list interface <ethx> access-list

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

Chapter 14: RIP

protocols rip distribute-list interface <ethx> prefix-list

protocols rip distribute-list interface <ethx> prefix-list

Applies a prefix list to a specific interface for filtering inbound or outbound RIP packets.

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

Mandatory. Interface on which to apply the access list filter.

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

Chapter 14: RIP

protocols rip distribute-list interface <ethx> prefix-list

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

Chapter 14: RIP

protocols rip distribute-list prefix-list

protocols rip distribute-list prefix-list

Applies a prefix list for filtering inbound or outbound RIP packets.

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

Chapter 14: RIP

protocols rip distribute-list prefix-list

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

Chapter 14: RIP

protocols rip interface <ethx>

protocols rip interface <ethx>

Enables the Routing Information Protocol (RIP) for an interface.

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

Mandatory. Multi-node. The name of a configured Ethernet interface.

You can enable RIP on more than one interface by creating multiple
protocols rip interface configuration nodes.

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

Chapter 14: RIP

protocols rip interface <ethx>

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

Chapter 14: RIP

protocols rip neighbor <ipv4>

protocols rip neighbor <ipv4>

Defines a RIP neighbor router.

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

Mandatory. Multi-node. The IP address of the neighbor router.

You can define more than one RIP neighbor router by creating multiple
protocols rip neighbor configuration nodes.

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

Chapter 14: RIP

protocols rip network <ipv4net>

protocols rip network <ipv4net>

Specifies a network for the Routing Information Protocol (RIP).

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

Mandatory. Multi-node. The IP network address of the RIP network.

You can identify more than one RIP network by creating multiple
protocols rip network configuration nodes.

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

Chapter 14: RIP

protocols rip network-distance <ipv4net>

protocols rip network-distance <ipv4net>

Specifies the administrative distance for a RIP network.

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

Mandatory. The IP network address identifying the network.

access-list

Applies a defined access to the specified network.

distance

Applies the specified administrative distance to the specified network.

The range is 1 to 255. The default is 120.

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

Chapter 14: RIP

protocols rip network-distance <ipv4net>

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 RIP is 120.
Use the delete form of this command to restore the default administrative distance to a RIP
network or remove an access list.
Use the show form of this command to display administrative distance of a RIP network or
access list application.

Command Reference

Rel VC4.1 v. 03

Vyatta

667

Chapter 14: RIP

protocols rip passive-interface <ethx>

protocols rip passive-interface <ethx>

Suppresses RIP routing updates on an interface.

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

Mandatory. Multi-node. The name of a configured Ethernet interface on

which to suppress RIP routing updates.
You can suppress routing updates on more than one RIP interface by
creating multiple protocols rip passive-interface configuration nodes.

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

Chapter 14: RIP

Command Reference

protocols rip passive-interface <ethx>

Rel VC4.1 v. 03

Vyatta

669

Chapter 14: RIP

protocols rip redistribute bgp

protocols rip redistribute bgp

Allows you to redistribute BGP routes into RIP routing tables.

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

The routing metric to be applied to BGP routes being imported into

RIP routing tables. The range is 1-16. The default is 1.

map-name

Optional. Applies the specified route map to BGP routes being

imported into RIP routing tables.

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

Chapter 14: RIP

protocols rip redistribute bgp

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

Chapter 14: RIP

protocols rip redistribute connected

protocols rip redistribute connected

Allows you to redistribute directly connected routes into RIP routing tables.

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

Optional. The routing metric to be applied to connected routes being

imported into RIP routing tables. The range is 1-16. The default is 1.

map-name

Optional. Applies the specified route map to connected routes being

imported into RIP routing tables.

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

Chapter 14: RIP

protocols rip redistribute connected

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

Chapter 14: RIP

protocols rip redistribute kernel

protocols rip redistribute kernel

Allows you to redistribute kernel routes into RIP routing tables.

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

Optional. The routing metric to be applied to kernel routes being

imported into RIP routing tables. The range is 1-16. The default is 1.

map-name

Optional. Applies the specified route map to kernel routes being

imported into RIP routing tables.

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

Chapter 14: RIP

protocols rip redistribute kernel

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

Chapter 14: RIP

protocols rip redistribute ospf

protocols rip redistribute ospf

Allows you to redistribute OSPF routes into RIP routing tables.

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

Optional. The routing metric to be applied to OSPF routes being

imported into RIP routing tables. The range is 1-16. The default is 1.

map-name

Optional. Applies the specified route map to OSPF routes being

imported into RIP routing tables.

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

Chapter 14: RIP

protocols rip redistribute ospf

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

Chapter 14: RIP

protocols rip redistribute static

protocols rip redistribute static

Allows you to redistribute static routes into RIP routing tables.

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

Optional. The routing metric to be applied to static routes being

imported into RIP routing tables. The range is 1-16. The default is 1.

map-name

Optional. Applies the specified route map to static routes being

imported into RIP routing tables.

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

Chapter 14: RIP

protocols rip redistribute static

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

Chapter 14: RIP

protocols rip route <ipv4net>

protocols rip route <ipv4net>

Specifies a RIP static route.

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

Mandatory. The network address defining the RIP static route.

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

Chapter 14: RIP

protocols rip timers garbage-collection <seconds>

protocols rip timers garbage-collection <seconds>

Allows you to set timers for RIP garbage collection.

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

Mandatory. The timer interval period in seconds. The range is 5

to 2147483647.

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

Chapter 14: RIP

protocols rip timers timeout <seconds>

protocols rip timers timeout <seconds>

Allows you to set the interval for RIP time-outs.

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

Mandatory. The RIP timeout interval, in seconds. The range is 5

to 2147483647. The default is 180.

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

Chapter 14: RIP

protocols rip timers update <seconds>

protocols rip timers update <seconds>

Allows you to set the timer for RIP routing table updates.

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

Chapter 14: RIP

show debugging rip

show debugging rip

Displays RIP protocol debugging flags.

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

Chapter 14: RIP

show ip route rip

show ip route rip

Displays all IP RIP routes.

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

vyatta@vyatta:~$ show ip route rip

Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

685

Chapter 14: RIP

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

Optional. Displays only RIP protocol status information.

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

vyatta@vyatta:~$ show ip rip

Codes: R - RIP, C - connected, S - Static, O - OSPF, B - BGP
Sub-codes:
(n) - normal, (s) - static, (d) - default, (r) redistribute,
(i) - interface
Network
Next Hop
C(i) 192.168.1.0/24
0.0.0.0
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Metric From
1 self

Tag Time
0

Vyatta

686

Chapter 14: RIP

Command Reference

show ip rip

Rel VC4.1 v. 03

Vyatta

687

688

Chapter 15: OSPF

This chapter lists the commands for configuring OSPF on the Vyatta system.
This chapter contains the following commands.
Command

Description

OSPF Router-Level Configuration Commands

protocols ospf

Enables the Open Shortest Path First (OSPF) routing

protocol on the router.

protocols ospf access-list <list-num>

Specifies access list to filter networks in routing updates.

protocols ospf area <area-id>

Defines an OSPF area.

protocols ospf area <area-id> area-type normal

Designates an OSPF area as a normal area.

protocols ospf area <area-id> area-type nssa

Designates an OSPF area as a not-so-stubby area (NSSA).

protocols ospf area <area-id> area-type stub

Designates an OSPF area as a stub area.

protocols ospf area <area-id> authentication

Specifies the authentication type for an OSPF area.

protocols ospf area <area-id> network <ipv4net>

Specifies a network address for an OSPF area.

protocols ospf area <area-id> range <ip4net>

Allows an ABR to summarize routes matching a prefix

range.

Chapter 15: OSPF

689

Command

Description

protocols ospf area <area-id> shortcut <mode>

Sets the OSPF shortcut mode for an Area Border Router

(ABR).

protocols ospf area <area-id> virtual-link <ipv4>

authentication

Specifies the authentication characteristics for a virtual

link.

protocols ospf area <area-id> virtual-link <ipv4>

dead-interval <interval>

Specifies the dead interval for a virtual link.

protocols ospf area <area-id> virtual-link <ipv4>

hello-interval <interval>

Sets the interval between OSPF hello packets on a virtual

link.

protocols ospf area <area-id> virtual-link <ipv4>

retransmit-interval <interval>

Specifies the retransmit interval for a virtual link.

protocols ospf area <area-id> virtual-link <ipv4>

transmit-delay <delay>

Specifies the transmit delay for a virtual link.

protocols ospf auto-cost reference-bandwidth

<bandwidth>

Directs the system to use the reference bandwidth

method for calculating administrative cost.

protocols ospf default-information originate

Sets the characteristics of an external default route

originated into an OSPF routing domain.

protocols ospf default-metric <metric>

Sets default metric to be applied to routes being

redistributed into OSPF.

protocols ospf distance

Sets the OSPF administrative distance by route type.

protocols ospf log-adjacency-changes

Enables or disables logging of changes in adjacency

state of neighbors.

protocols ospf max-metric router-lsa

Enables or disables an OSPF stub router to advertise a

maximum metric value when the router is started up or
reloaded.

protocols ospf mpls-te

Sets Multi-Protocol Label Switching (MPLS) Traffic

Engineering (MPLS-TE) parameters.

protocols ospf neighbor <ipv4>

Defines an OSPF neighbor.

protocols ospf parameters

Sets global OSPF parameters, such as router ID.

protocols ospf passive-interface <ethx>

Suppress routing updates on an interface.

protocols ospf refresh timers <value>

Sets values for OSPF refresh timers.

protocols ospf timers throttle spf

Enables or disables OSPF SPF throttling.

OSPF Area Configuration Commands

protocols ospf area <area-id> area-type normal

Command Reference

Designates an OSPF area as a normal area.

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

690

Command

Description

protocols ospf area <area-id> area-type nssa

Designates an OSPF area as a not-so-stubby area (NSSA).

protocols ospf area <area-id> area-type stub

Designates an OSPF area as a stub area.

protocols ospf area <area-id> authentication

Specifies the authentication type for an OSPF area.

protocols ospf area <area-id> network <ipv4net>

Specifies a network address for an OSPF area.

protocols ospf area <area-id> range <ip4net>

Allows an ABR to summarize routes matching a prefix

range.

protocols ospf area <area-id> shortcut <mode>

Sets the OSPF shortcut mode for an Area Border Router

(ABR).

protocols ospf area <area-id> virtual-link <ipv4>

authentication

Specifies the authentication characteristics for a virtual

link.

protocols ospf area <area-id> virtual-link <ipv4>

dead-interval <interval>

Specifies the dead interval for a virtual link.

protocols ospf area <area-id> virtual-link <ipv4>

hello-interval <interval>

Sets the interval between OSPF hello packets on a virtual

link.

protocols ospf area <area-id> virtual-link <ipv4>

retransmit-interval <interval>

Specifies the retransmit interval for a virtual link.

protocols ospf area <area-id> virtual-link <ipv4>

transmit-delay <delay>

Specifies the transmit delay for a virtual link.

OSPF Configuration Commands for ADSL Interfaces with Classical IPOA Encapsulation
interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip
ospf

Enables OSPF on an ADSL PVC with Classical IPOA

encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf authentication

Specifies the authentication method for OSPF on an

ADSL PVC with Classical IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf bandwidth <bandwidth>

Specifies the bandwidth of an ADSL PVC with Classical

IPOA encapsulation for calculating OSPF cost.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf cost <cost>

Sets the routing cost for OSPF on an ADSL PVC with

Classical IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf dead-interval <interval>

Sets the OSPF dead interval for an ADSL PVC with

Classical IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf hello-interval <interval>

Sets the interval between OSPF hello packets on an

ADSL PVC with Classical IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf mtu-ignore

Disables MTU mismatch detection for an ADSL PVC with

Classical IPOA encapsulation.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

691

Command

Description

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf network <type>

Specifies the OSPF network type for an ADSL PVC with

Classical IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf priority <priority>

Sets the OSPF priority for an ADSL PVC with Classical

IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf retransmit-interval <interval>

Sets the OSPF retransmit interval for an ADSL PVC with

Classical IPOA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf transmit-delay <delay>

Specifies the OSPF transmit delay for an ADSL PVC with

Classical IPOA encapsulation.

OSPF Configuration Commands for ADSL Interfaces with PPPoA Encapsulation

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip
ospf

Enables OSPF on an ADSL PVC with PPPoA

encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf authentication

Specifies the authentication method for OSPF on an

ADSL PVC with PPPoA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf bandwidth <bandwidth>

Specifies the bandwidth of an ADSL PVC with PPPoA

encapsulation for calculating OSPF cost.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf cost <cost>

Sets the routing cost for OSPF on an ADSL PVC with

PPPoA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf dead-interval <interval>

Sets the OSPF dead interval for an ADSL PVC with PPPoA
encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf hello-interval <interval>

Sets the interval between OSPF hello packets on an

ADSL PVC with PPPoA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf mtu-ignore

Disables MTU mismatch detection for an ADSL PVC with

PPPoA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf network <type>

Specifies the OSPF network type for an ADSL PVC with

PPPoA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf priority <priority>

Sets the OSPF priority for an ADSL PVC with PPPoA

encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf retransmit-interval <interval>

Sets the OSPF retransmit interval for an ADSL PVC with

PPPoA encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf transmit-delay <delay>

Specifies the OSPF transmit delay for an ADSL PVC with

PPPoA encapsulation.

OSPF Configuration Commands for ADSL Interfaces with PPPoE Encapsulation

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip
ospf

Command Reference

Enables OSPF on an ADSL PVC with PPPoE

encapsulation.

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

692

Command

Description

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf authentication

Specifies the authentication method for OSPF on an

ADSL PVC with PPPoE encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf bandwidth <bandwidth>

Specifies the bandwidth of an ADSL PVC with PPPoE

encapsulation for calculating OSPF cost.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf cost <cost>

Sets the routing cost for OSPF on an ADSL PVC with

PPPoE encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf dead-interval <interval>

Sets the OSPF dead interval for an ADSL PVC with PPPoE
encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf hello-interval <interval>

Sets the interval between OSPF hello packets on an

ADSL PVC with PPPoE encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf mtu-ignore

Disables MTU mismatch detection for an ADSL PVC with

PPPoE encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf network <type>

Specifies the OSPF network type for an ADSL PVC with

PPPoE encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf priority <priority>

Sets the OSPF priority for an ADSL PVC with PPPoE

encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf retransmit-interval <interval>

Sets the OSPF retransmit interval for an ADSL PVC with

PPPoE encapsulation.

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf transmit-delay <delay>

Specifies the OSPF transmit delay for an ADSL PVC with

PPPoE encapsulation.

OSPF Configuration Commands for Ethernet Interfaces

interfaces ethernet <ethx> ip ospf authentication

Specifies the authentication method for OSPF on an

Ethernet interface.

interfaces ethernet <ethx> ip ospf bandwidth

<bandwidth>

Specifies the bandwidth of an Ethernet interface for

calculating OSPF cost.

interfaces ethernet <ethx> ip ospf cost <cost>

Sets the routing cost for OSPF on an Ethernet interface.

interfaces ethernet <ethx> ip ospf dead-interval

<interval>

Sets the OSPF dead interval for an Ethernet interface.

interfaces ethernet <ethx> ip ospf hello-interval

<interval>

Sets the interval between OSPF hello packets on an

Ethernet interface.

interfaces ethernet <ethx> ip ospf mtu-ignore

Disables MTU mismatch detection for an Ethernet

interface.

interfaces ethernet <ethx> ip ospf network <type>

Specifies the OSPF network type for an Ethernet

interface.

interfaces ethernet <ethx> ip ospf priority <priority>

Sets the OSPF priority for an Ethernet interface.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

693

Command

Description

interfaces ethernet <ethx> ip ospf retransmit-interval

<interval>

Sets the OSPF retransmit interval for an Ethernet

interface.

interfaces ethernet <ethx> ip ospf transmit-delay

<delay>

Specifies the OSPF transmit delay for an Ethernet

interface.

OSPF Configuration Commands for Ethernet PPPoE Interfaces

interfaces ethernet <ethx> pppoe <num> ip ospf

Enables OSPF on a PPPoE interface.

interfaces ethernet <ethx> pppoe <num> ip ospf

authentication

Specifies the authentication method for OSPF on a

PPPoE interface.

interfaces ethernet <ethx> pppoe <num> ip ospf

bandwidth <bandwidth>

Specifies the bandwidth of a PPPoE interface for

calculating OSPF cost.

interfaces ethernet <ethx> pppoe <num> ip ospf cost

<cost>

Sets the routing cost for OSPF on a PPPoE interface.

interfaces ethernet <ethx> pppoe <num> ip ospf

dead-interval <interval>

Sets the dead interval for OSPF on a PPPoE interface.

interfaces ethernet <ethx> pppoe <num> ip ospf

hello-interval <interval>

Sets the interval between OSPF hello packets on a PPPoE

interface.

interfaces ethernet <ethx> pppoe <num> ip ospf

mtu-ignore

Disables MTU mismatch detection for OSPF on a PPPoE

interface.

interfaces ethernet <ethx> pppoe <num> ip ospf

network <type>

Specifies the network type for OSPF on a PPPoE

interface.

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>

Sets the retransmit interval for OSPF on a PPPoE

interface.

interfaces ethernet <ethx> pppoe <num> ip ospf

transmit-delay <delay>

Specifies the transmit delay for OSPF on a PPPoE

interface.

OSPF Configuration Commands for Ethernet Vifs

interfaces ethernet <ethx> vif <vlan-id> ip ospf

Enables OSPF on a virtual interface.

interfaces ethernet <ethx> vif <vlan-id> ip ospf

authentication

Specifies the authentication method for OSPF on a

virtual interface.

interfaces ethernet <ethx> vif <vlan-id> ip ospf

bandwidth <bandwidth>

Specifies the bandwidth of a virtual interface for

calculating OSPF cost.

interfaces ethernet <ethx> vif <vlan-id> ip ospf cost

<cost>

Sets the routing cost for OSPF on a virtual interface.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

694

Command

Description

interfaces ethernet <ethx> vif <vlan-id> ip ospf

dead-interval <interval>

Sets the OSPF dead interval for a virtual interface.

interfaces ethernet <ethx> vif <vlan-id> ip ospf

hello-interval <interval>

Sets the interval between OSPF hello packets on a virtual

interface.

interfaces ethernet <ethx> vif <vlan-id> ip ospf

mtu-ignore

Disables MTU mismatch detection for a virtual interface.

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>

Sets the OSPF priority for a virtual interface.

interfaces ethernet <ethx> vif <vlan-id> ip ospf

retransmit-interval <interval>

Sets the OSPF retransmit interval for a virtual interface.

interfaces ethernet <ethx> vif <vlan-id> ip ospf

transmit-delay <delay>

Specifies the OSPF transmit delay for a virtual interface.

OSPF Configuration Commands for Loopback Interfaces

interfaces loopback lo ip ospf

Enables OSPF on the loopback interface.

interfaces loopback lo ip ospf authentication

Specifies the authentication method for OSPF on the

loopback interface.

interfaces loopback lo ip ospf cost <cost>

Sets the routing cost for OSPF on the loopback interface.

interfaces loopback lo ip ospf dead-interval <interval>

Sets the OSPF dead interval for the loopback interface.

interfaces loopback lo ip ospf hello-interval <interval>

Sets the interval between OSPF hello packets on the

loopback interface.

interfaces loopback lo ip ospf mtu-ignore

Disables MTU mismatch detection for the loopback

interface.

interfaces loopback lo ip ospf network <type>

Specifies the OSPF network type for the loopback

interface.

interfaces loopback lo ip ospf priority <priority>

Specifies the Open Shortest Path First (OSPF) priority for

the loopback interface.

interfaces loopback lo ip ospf retransmit-interval

<interval>

Sets the OSPF retransmit interval for the loopback

interface.

interfaces loopback lo ip ospf transmit-delay <delay>

Specifies the Open Shortest Path First (OSPF) transmit

delay for the loopback interface.

OSPF Configuration Commands for Multilink Interfaces

interfaces multilink <mlx> ip ospf

Command Reference

Enables OSPF on a multilink interface.

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

695

Command

Description

interfaces multilink <mlx> ip ospf

Specifies the authentication method for OSPF on a

multilink interface.

interfaces multilink <mlx> ip ospf bandwidth

<bandwidth>

Specifies the bandwidth of a multilink interface for

calculating OSPF cost.

interfaces multilink <mlx> ip ospf cost <cost>

Sets the routing cost for OSPF on a multilink interface.

interfaces multilink <mlx> ip ospf dead-interval

<interval>

Sets the dead interval for OSPF on a multilink interface.

interfaces multilink <mlx> ip ospf hello-interval

<interval>

Sets the interval between OSPF hello packets on a

multilink interface.

interfaces multilink <mlx> ip ospf mtu-ignore

Disables MTU mismatch detection for OSPF on a

multilink interface.

interfaces multilink <mlx> ip ospf network <type>

Specifies the network type for OSPF on a multilink

interface.

interfaces multilink <mlx> ip ospf priority <priority>

Sets the priority for OSPF on a multilink interface.

interfaces multilink <mlx> ip ospf retransmit-interval

<interval>

Sets the retransmit interval for OSPF on a multilink

interface.

interfaces multilink <mlx> ip ospf transmit-delay

<delay>

Specifies the transmit delay for OSPF on a multilink

interface.

OSPF Configuration Commands for Serial Interfaces

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

Enables OSPF on the virtual interface of a Cisco HDLC

serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

authentication

Specifies the authentication method for OSPF on the

virtual interface of a Cisco HDLC serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

bandwidth <bandwidth>

Specifies the bandwidth on the virtual interface of a

Cisco HDLC serial interface for calculating OSPF cost.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf cost

<cost>

Sets the routing cost for OSPF on the virtual interface of

a Cisco HDLC serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

dead-interval <interval>

Sets the OSPF dead interval for the virtual interface of a

Cisco HDLC serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

hello-interval <interval>

Sets the interval between OSPF hello packets on the

virtual interface of a Cisco HDLC serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

mtu-ignore

Disables MTU mismatch detection for the virtual

interface of a Cisco HDLC serial interface.

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

Chapter 15: OSPF

696

Command

Description

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf priority

<priority>

Sets the OSPF priority for the virtual interface of a Cisco

HDLC serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

retransmit-interval <interval>

Sets the OSPF retransmit interval for the virtual interface

of a Cisco HDLC serial interface.

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

transmit-delay <delay>

Specifies the OSPF transmit delay for the virtual interface

of a Cisco HDLC serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

Enables OSPF on the virtual interface of a Frame Relay

serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

authentication

Specifies the authentication method for OSPF on the

virtual interface of a Frame Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

bandwidth <bandwidth>

Specifies the bandwidth on the virtual interface of a

Frame Relay serial interface for calculating OSPF cost.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

cost <cost>

Sets the routing cost for OSPF on the virtual interface of

a Frame Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

dead-interval <interval>

Sets the OSPF dead interval for the virtual interface of a

Frame Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

hello-interval <interval>

Sets the interval between OSPF hello packets on the

virtual interface of a Frame Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

mtu-ignore

Disables MTU mismatch detection for the virtual

interface of a Frame Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

network <type>

Specifies the OSPF network type for the virtual interface

of a Frame Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

priority <priority>

Sets the OSPF priority for the virtual interface of a Frame

Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

retransmit-interval <interval>

Sets the OSPF retransmit interval for the virtual interface

of a Frame Relay serial interface.

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

transmit-delay <delay>

Specifies the OSPF transmit delay for the virtual interface

of a Frame Relay serial interface.

interfaces serial <wanx> ppp vif 1 ip ospf

Enables OSPF on the virtual interface of a PPP serial

interface.

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>

Specifies the bandwidth on the virtual interface of a PPP

serial interface for calculating OSPF cost.

interfaces serial <wanx> ppp vif 1 ip ospf cost <cost>

Sets the routing cost for OSPF on the virtual interface of

a PPP serial interface.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

697

Command

Description

interfaces serial <wanx> ppp vif 1 ip ospf dead-interval

<interval>

Sets the OSPF dead interval for the virtual interface of a

PPP serial interface.

interfaces serial <wanx> ppp vif 1 ip ospf hello-interval

<interval>

Sets the interval between OSPF hello packets on the

virtual interface of a PPP serial interface.

interfaces serial <wanx> ppp vif 1 ip ospf mtu-ignore

Disables MTU mismatch detection for the virtual

interface of a PPP serial interface.

interfaces serial <wanx> ppp vif 1 ip ospf network

<type>

Specifies the OSPF network type for the virtual interface

of a PPP serial interface.

interfaces serial <wanx> ppp vif 1 ip ospf priority

<priority>

Sets the OSPF priority for the virtual interface of a PPP

serial interface.

interfaces serial <wanx> ppp vif 1 ip ospf

retransmit-interval <interval>

Sets the OSPF retransmit interval for the virtual interface

of a PPP serial interface.

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.

OSPF Configuration Commands for Tunnel Interfaces

interfaces tunnel <tunx> ip ospf

Enables OSPF on a tunnel interface.

interfaces tunnel <tunx> ip ospf authentication

Specifies the authentication method for OSPF on an

Ethernet interface.

interfaces tunnel <tunx> ip ospf bandwidth

<bandwidth>

Specifies the bandwidth of a tunnel interface for

calculating OSPF cost.

interfaces tunnel <tunx> ip ospf cost <cost>

Sets the routing cost for OSPF on a tunnel 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

Disables MTU mismatch detection for a tunnel interface.

interfaces tunnel <tunx> ip ospf network <type>

Specifies the OSPF network type for a tunnel interface.

interfaces tunnel <tunx> ip ospf priority <priority>

Sets the OSPF priority for a tunnel interface.

interfaces tunnel <tunx> ip ospf retransmit-interval

<interval>

Sets the OSPF retransmit interval for a tunnel interface.

interfaces tunnel <tunx> ip ospf transmit-delay <delay> Specifies the OSPF transmit delay for a tunnel interface.

OSPF Route Redistribution Commands

protocols ospf redistribute bgp

Command Reference

Sets the parameters for redistribution of BGP routes into

OSPF.

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

698

Command

Description

protocols ospf redistribute connected

Sets the parameters for redistribution of connected

routes into OSPF.

protocols ospf redistribute kernel

Sets the parameters for redistribution of kernel routes

into OSPF.

protocols ospf redistribute rip

Sets the parameters for redistribution of RIP routes into

OSPF.

protocols ospf redistribute static

Sets the parameters for redistribution of static routes

into OSPF.

OSPF Debug Commands

debug ospf event

Enables or disables debug message generation related to

OSPF events.

debug ospf ism

Enables or disables debug message generation related to

the OSPF ISM.

debug ospf lsa

Enables or disables debug message generation related to

OSPF link-state advertisements (LSAs).

debug ospf nsm

Enables or disables debug message generation related to

the OSPF NSM.

debug ospf nssa

Enables or disables debug message generation related to

OSPF not-so-stubby areas (NSSAs).

debug ospf packet all

Enables or disables debug message generation related to

all OSPF packets.

debug ospf packet dd

Enables or disables debug message generation related to

OSPF Database Description (DD) packets.

debug ospf packet hello

Enables or disables debug message generation related to

OSPF hello packets.

debug ospf packet ls-ack

Enables or disables debug message generation related to

OSPF link-state acknowledgement (LS Ack) packets.

debug ospf packet ls-request

Enables or disables debug message generation related to

OSPF link-state request (LSR) packets.

debug ospf packet ls-update

Enables or disables debug message generation related to

OSPF link-state update (LSU) packets.

debug ospf zebra

Enables or disables debug message generation for the

Zebra OSPF process.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

Command

699

Description

OSPF Show Commands

show debugging ospf

Displays OSPF protocol debugging flags.

show ip ospf

Displays high-level OSPF configuration information.

show ip ospf border-routers

Displays OSPF border router information.

show ip ospf database

Displays OSPF database information.

show ip ospf interface

Displays OSPF configuration and status information for a

specified interface.

show ip ospf neighbor

Displays OSPF neighbor information for a specified

address or interface.

show ip ospf route

Displays OSPF route information.

show ip route ospf

Displays all IP OSPF routes.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 15: OSPF

debug ospf event

debug ospf event

Enables or disables debug message generation related to OSPF events.

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

Chapter 15: OSPF

debug ospf ism

debug ospf ism

Enables or disables debug message generation related to the OSPF ISM.

Syntax
debug ospf ism [events | status | timers]
no debug ospf ism [events | status | timers]

Command Mode
Operational mode.

Parameters

events

Optional. Enables or disables debug message generation related to

OSPF ISM events.

status

Optional. Enables or disables debug message generation related to

OSPF ISM status.

timers

Optional. Enables or disables debug message generation related to

OSPF ISM 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

Chapter 15: OSPF

debug ospf lsa

debug ospf lsa

Enables or disables debug message generation related to OSPF link-state advertisements
(LSAs).

Syntax
debug ospf lsa [flooding | generate | install | refresh]
no debug ospf lsa [flooding | generate | install | refresh]

Command Mode
Operational mode.

Parameters

flooding

Optional. Generates messages related to OSPF LSA flood events.

generate

Optional. Generates messages relates to OSPF LSA generation.

install

Optional. Generates messages relates to OSPF LSA installation.

refresh

Optional. Generates messages relates to OSPF LSA refreshes.

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

Chapter 15: OSPF

debug ospf nsm

debug ospf nsm

Enables or disables debug message generation related to the OSPF NSM.

Syntax
debug ospf nsm [events | status | timers]
no debug ospf nsm [events | status | timers]

Command Mode
Operational mode.

Parameters

events

Optional. Enables or disables debug message generation related to

OSPF NSM events.

status

Optional. Enables or disables debug message generation related to

OSPF NSM status.

timers

Optional. Enables or disables debug message generation related to

OSPF NSM 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

Chapter 15: OSPF

debug ospf nssa

debug ospf nssa

Enables or disables debug message generation related to OSPF not-so-stubby areas
(NSSAs).

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

Chapter 15: OSPF

debug ospf packet all

debug ospf packet all

Enables or disables debug message generation related to all OSPF packets.

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

Optional. Generates detailed debug messages for all OSPF packets,

both sent and received.

recv

Optional. Generates debug messages for all received OSPF packet

types.

detail

Optional. Generates detailed debug messages for all received OSPF

packets.

send

Optional. Generates debug messages for all transmitted OSPF packets.

detail

Optional. Generates detailed debug messages for all transmitted OSPF

packets.

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

Chapter 15: OSPF

debug ospf packet dd

debug ospf packet dd

Enables or disables debug message generation related to OSPF Database Description (DD)
packets.

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

Optional. Generates detailed debug messages for OSPF DD packets,

both sent and received.

recv

Optional. Generates debug messages for received OSPF DD packets.

detail

Optional. Generates detailed debug messages for received OSPF DD

packets.

send

Optional. Generates debug messages for transmitted OSPF DD

packets.

detail

Optional. Generates detailed debug messages for transmitted OSPF

DD packets.

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

Chapter 15: OSPF

debug ospf packet hello

debug ospf packet hello

Enables or disables debug message generation related to OSPF hello packets.

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

Optional. Generates detailed debug messages for OSPF hello packets,

both sent and received.

recv

Optional. Generates debug messages for received OSPF hello packets.

detail

Optional. Generates detailed debug messages for received OSPF hello

packets.

send

Optional. Generates debug messages for transmitted OSPF hello

packets.

detail

Optional. Generates detailed debug messages for transmitted OSPF

hello packets.

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

Chapter 15: OSPF

debug ospf packet ls-ack

debug ospf packet ls-ack

Enables or disables debug message generation related to OSPF link-state
acknowledgement (LS Ack) packets.

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

Optional. Generates detailed debug messages for OSPF LS Ack

packets, both sent and received.

recv

Optional. Generates debug messages for received OSPF LS Ack

packets.

detail

Optional. Generates detailed debug messages for received OSPF LS

Ack packets.

send

Optional. Generates debug messages for transmitted OSPF LS Ack

packets.

detail

Optional. Generates detailed debug messages for transmitted OSPF

LS Ack packets.

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

Chapter 15: OSPF

debug ospf packet ls-request

debug ospf packet ls-request

Enables or disables debug message generation related to OSPF link-state request (LSR)
packets.

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

Optional. Generates detailed debug messages for OSPF LSR packets,

both sent and received.

recv

Optional. Generates debug messages for received OSPF LSR packets.

detail

Optional. Generates detailed debug messages for received OSPF LSR

packets.

send

Optional. Generates debug messages for transmitted OSPF LSR

packets.

detail

Optional. Generates detailed debug messages for transmitted OSPF

LSR packets.

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

Chapter 15: OSPF

debug ospf packet ls-update

debug ospf packet ls-update

Enables or disables debug message generation related to OSPF link-state update (LSU)
packets.

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

Optional. Generates detailed debug messages for OSPF LSU packets,

both sent and received.

recv

Optional. Generates debug messages for received OSPF LSU packets.

detail

Optional. Generates detailed debug messages for received OSPF LSU

packets.

send

Optional. Generates debug messages for transmitted OSPF LSU

packets.

detail

Optional. Generates detailed debug messages for transmitted OSPF

LSU packets.

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

Chapter 15: OSPF

debug ospf zebra

debug ospf zebra

Enables or disables debug message generation for the Zebra OSPF process.

Syntax
debug ospf zebra [interface | redistribute]
no debug ospf zebra [interface | redistribute]

Command Mode
Operational mode.

Parameters

interface

Optional. Generates debug messages for interfaces on which Zebra

OSPF is enabled.

redistribute

Optional. Generates debug messages for routes redistributed into

Zebra OSPF.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf
Enables OSPF on an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf authentication

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf authentication
Specifies the authentication method for OSPF on an ADSL PVC with Classical IPOA
encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf authentication

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf authentication

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf bandwidth <bandwidth>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf bandwidth <bandwidth>
Specifies the bandwidth of an ADSL PVC with Classical IPOA encapsulation for
calculating OSPF cost.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf bandwidth <bandwidth>

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf cost <cost>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf cost <cost>
Sets the routing cost for OSPF on an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf cost <cost>

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

T3 (44.736 Mbps

100+ Mbps

Rel VC4.1 v. 03

Vyatta

720

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf cost <cost>

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf dead-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf dead-interval <interval>
Sets the OSPF dead interval for an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf hello-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf hello-interval <interval>
Sets the interval between OSPF hello packets on an ADSL PVC with Classical IPOA
encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf hello-interval <interval>

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf mtu-ignore

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf mtu-ignore
Disables MTU mismatch detection for an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf network <type>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf network <type>
Specifies the OSPF network type for an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf network <type>

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf priority <priority>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf priority <priority>
Sets the OSPF priority for an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf retransmit-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf retransmit-interval <interval>
Sets the OSPF retransmit interval for an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf retransmit-interval <interval>

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf transmit-delay <delay>

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip

ospf transmit-delay <delay>
Specifies the OSPF transmit delay for an ADSL PVC with Classical IPOA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> classical-ipoa ip ospf transmit-delay <delay>

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf
Enables OSPF on an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf authentication

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf authentication
Specifies the authentication method for OSPF on an ADSL PVC with PPPoA
encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf authentication

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

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf authentication

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf bandwidth <bandwidth>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf bandwidth <bandwidth>
Specifies the bandwidth of an ADSL PVC with PPPoA encapsulation for calculating OSPF
cost.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf bandwidth <bandwidth>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf cost <cost>
Sets the routing cost for OSPF on an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

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

4 Mbps Token Ring

10 Mbps Ethernet

10

Rel VC4.1 v. 03

Vyatta

744

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf cost <cost>

Table 15-2 OSPF Costs for Common Media Types

16 Mbps Token Ring

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf dead-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf dead-interval <interval>
Sets the OSPF dead interval for an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf dead-interval <interval>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf hello-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf hello-interval <interval>
Sets the interval between OSPF hello packets on an ADSL PVC with PPPoA
encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf hello-interval <interval>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf mtu-ignore

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf mtu-ignore
Disables MTU mismatch detection for an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf mtu-ignore

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf network <type>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf network <type>
Specifies the OSPF network type for an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf network <type>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf priority <priority>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf priority <priority>
Sets the OSPF priority for an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf priority <priority>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf retransmit-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf retransmit-interval <interval>
Sets the OSPF retransmit interval for an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf retransmit-interval <interval>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf transmit-delay <delay>

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip

ospf transmit-delay <delay>
Specifies the OSPF transmit delay for an ADSL PVC with PPPoA encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoa <num> ip ospf transmit-delay <delay>

num

Mandatory. The PPPoA unit number. This number must be unique

across all PPPoA interfaces. In addition, only one PPPoA instance can
be configured on a PVC. PPPoA units range from 0 to 15 and the
resulting interfaces are named pppoa0 to pppoa15.

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf
Enables OSPF on an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf authentication

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf authentication
Specifies the authentication method for OSPF on an ADSL PVC with PPPoE
encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf authentication

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

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf authentication

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf bandwidth <bandwidth>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf bandwidth <bandwidth>
Specifies the bandwidth of an ADSL PVC with PPPoE encapsulation for calculating OSPF
cost.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf bandwidth <bandwidth>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf cost <cost>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf cost <cost>
Sets the routing cost for OSPF on an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf cost <cost>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

Rel VC4.1 v. 03

Vyatta

768

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf cost <cost>

Table 15-3 OSPF Costs for Common Media Types

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

769

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf dead-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf dead-interval <interval>
Sets the OSPF dead interval for an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf dead-interval <interval>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf hello-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf hello-interval <interval>
Sets the interval between OSPF hello packets on an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf hello-interval <interval>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf mtu-ignore

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf mtu-ignore
Disables MTU mismatch detection for an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf mtu-ignore

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf network <type>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf network <type>
Specifies the OSPF network type for an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf network <type>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf priority <priority>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf priority <priority>
Sets the OSPF priority for an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf priority <priority>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf retransmit-interval <interval>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf retransmit-interval <interval>
Sets the OSPF retransmit interval for an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf retransmit-interval <interval>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf transmit-delay <delay>

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip

ospf transmit-delay <delay>
Specifies the OSPF transmit delay for an ADSL PVC with PPPoE encapsulation.

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

Chapter 15: OSPF

interfaces adsl <adslx> pvc <pvc-id> pppoe <num> ip ospf transmit-delay <delay>

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf

interfaces ethernet <ethx> ip ospf

Enables OSPF on an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

784

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf authentication

interfaces ethernet <ethx> ip ospf authentication

Specifies the authentication method for OSPF on an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

786

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf authentication

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf bandwidth <bandwidth>

interfaces ethernet <ethx> ip ospf bandwidth

<bandwidth>
Specifies the bandwidth of an Ethernet interface for calculating OSPF cost.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

788

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf bandwidth <bandwidth>

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf cost <cost>

interfaces ethernet <ethx> ip ospf cost <cost>

Sets the routing cost for OSPF on an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

Default
For details on the default of OSPF cost, please see the Usage Guidelines.

Command Reference

Rel VC4.1 v. 03

Vyatta

790

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf cost <cost>

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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf dead-interval <interval>

interfaces ethernet <ethx> ip ospf dead-interval

<interval>
Sets the OSPF dead interval for an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf hello-interval <interval>

interfaces ethernet <ethx> ip ospf hello-interval

<interval>
Sets the interval between OSPF hello packets on an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

Default
Hello packets are sent every 10 seconds.

Command Reference

Rel VC4.1 v. 03

Vyatta

794

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf hello-interval <interval>

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf mtu-ignore

interfaces ethernet <ethx> ip ospf mtu-ignore

Disables MTU mismatch detection for an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Default
MTU mismatch detection is enabled by default.

Command Reference

Rel VC4.1 v. 03

Vyatta

796

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf network <type>

interfaces ethernet <ethx> ip ospf network <type>

Specifies the OSPF network type for an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

798

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf network <type>

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf priority <priority>

interfaces ethernet <ethx> ip ospf priority <priority>

Sets the OSPF priority for an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf retransmit-interval <interval>

interfaces ethernet <ethx> ip ospf retransmit-interval

<interval>
Sets the OSPF retransmit interval for an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Default
Unacknowledged LSAs are retransmitted at 5-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

802

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf transmit-delay <delay>

interfaces ethernet <ethx> ip ospf transmit-delay

<delay>
Specifies the OSPF transmit delay for an Ethernet interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

Default
Link-state transmits occur at 1-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

804

Chapter 15: OSPF

interfaces ethernet <ethx> ip ospf transmit-delay <delay>

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf

interfaces ethernet <ethx> pppoe <num> ip ospf

Enables OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

806

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf authentication

interfaces ethernet <ethx> pppoe <num> ip ospf

authentication
Specifies the authentication method for OSPF on a PPPoE interface.

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf authentication

Parameters

ethx

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf authentication

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf bandwidth <bandwidth>

interfaces ethernet <ethx> pppoe <num> ip ospf

bandwidth <bandwidth>
Specifies the bandwidth of a PPPoE interface for calculating OSPF cost.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

Rel VC4.1 v. 03

Vyatta

811

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf bandwidth <bandwidth>

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf cost <cost>

interfaces ethernet <ethx> pppoe <num> ip ospf cost

<cost>
Sets the routing cost for OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

Rel VC4.1 v. 03

Vyatta

813

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf cost <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
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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

T3 (44.736 Mbps

100+ Mbps

Rel VC4.1 v. 03

Vyatta

814

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf cost <cost>

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf dead-interval <interval>

interfaces ethernet <ethx> pppoe <num> ip ospf

dead-interval <interval>
Sets the dead interval for OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf hello-interval <interval>

interfaces ethernet <ethx> pppoe <num> ip ospf

hello-interval <interval>
Sets the interval between OSPF hello packets on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

Rel VC4.1 v. 03

Vyatta

818

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf hello-interval <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
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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf mtu-ignore

interfaces ethernet <ethx> pppoe <num> ip ospf

mtu-ignore
Disables MTU mismatch detection for OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

num

Command Reference

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

Rel VC4.1 v. 03

Vyatta

820

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf network <type>

interfaces ethernet <ethx> pppoe <num> ip ospf

network <type>
Specifies the network type for OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

num

Command Reference

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

Rel VC4.1 v. 03

Vyatta

822

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf network <type>

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf priority <priority>

interfaces ethernet <ethx> pppoe <num> ip ospf

priority <priority>
Sets the priority for OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf retransmit-interval <interval>

interfaces ethernet <ethx> pppoe <num> ip ospf

retransmit-interval <interval>
Sets the retransmit interval for OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Rel VC4.1 v. 03

Vyatta

826

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf transmit-delay <delay>

interfaces ethernet <ethx> pppoe <num> ip ospf

transmit-delay <delay>
Specifies the transmit delay for OSPF on a PPPoE interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

num

Mandatory. The name of a defined PPPoE unit. The range of values is 0

to 15.

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

Rel VC4.1 v. 03

Vyatta

828

Chapter 15: OSPF

interfaces ethernet <ethx> pppoe <num> ip ospf transmit-delay <delay>

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf

interfaces ethernet <ethx> vif <vlan-id> ip ospf

Enables OSPF on a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf authentication

interfaces ethernet <ethx> vif <vlan-id> ip ospf

authentication
Specifies the authentication method for OSPF on a virtual interface.

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf authentication

Parameters

ethx

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf authentication

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf bandwidth <bandwidth>

interfaces ethernet <ethx> vif <vlan-id> ip ospf

bandwidth <bandwidth>
Specifies the bandwidth of a virtual interface for calculating OSPF cost.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

835

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf bandwidth <bandwidth>

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

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf cost <cost>

interfaces ethernet <ethx> vif <vlan-id> ip ospf cost

<cost>
Sets the routing cost for OSPF on a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

837

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf cost <cost>

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

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

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

4 Mbps Token Ring

Rel VC4.1 v. 03

Vyatta

838

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf cost <cost>

Table 15-6 OSPF Costs for Common Media Types

10 Mbps Ethernet

10

16 Mbps Token Ring

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf dead-interval <interval>

interfaces ethernet <ethx> vif <vlan-id> ip ospf

dead-interval <interval>
Sets the OSPF dead interval for a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

840

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf hello-interval <interval>

interfaces ethernet <ethx> vif <vlan-id> ip ospf

hello-interval <interval>
Sets the interval between OSPF hello packets on a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

842

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf hello-interval <interval>

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

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf mtu-ignore

interfaces ethernet <ethx> vif <vlan-id> ip ospf

mtu-ignore
Disables MTU mismatch detection for a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

844

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf network <type>

interfaces ethernet <ethx> vif <vlan-id> ip ospf

network <type>
Specifies the OSPF network type for a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

846

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf network <type>

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf priority <priority>

interfaces ethernet <ethx> vif <vlan-id> ip ospf priority

<priority>
Sets the OSPF priority for a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

848

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf retransmit-interval <interval>

interfaces ethernet <ethx> vif <vlan-id> ip ospf

retransmit-interval <interval>
Sets the OSPF retransmit interval for a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

850

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf retransmit-interval <interval>

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 to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

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

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf transmit-delay <delay>

interfaces ethernet <ethx> vif <vlan-id> ip ospf

transmit-delay <delay>
Specifies the OSPF transmit delay for a virtual interface.

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

Mandatory. Multi-node. An 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.
To see the interfaces available to the system kernel, use the system
option of the show interfaces command (see page 78).

Command Reference

Rel VC4.1 v. 03

Vyatta

852

Chapter 15: OSPF

interfaces ethernet <ethx> vif <vlan-id> ip ospf transmit-delay <delay>

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

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf

interfaces loopback lo ip ospf

Enables OSPF on the loopback interface.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf authentication

interfaces loopback lo ip ospf authentication

Specifies the authentication method for OSPF on the loopback interface.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf authentication

md5-key

A password-like MD5 key of up to 16 alphanumeric characters to be

used as input to the MD5 hashing algorithm. The longer the key, the
stronger the security. This must be the same on both the sending and
receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf cost <cost>

interfaces loopback lo ip ospf cost <cost>

Sets the routing cost for OSPF on the loopback interface.

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

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the loopback
interface. The range is 1 to 65535.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf cost <cost>

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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

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

Chapter 15: OSPF

interfaces loopback lo ip ospf dead-interval <interval>

interfaces loopback lo ip ospf dead-interval <interval>

Sets the OSPF dead interval for the loopback interface.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces loopback lo ip ospf hello-interval <interval>

interfaces loopback lo ip ospf hello-interval <interval>

Sets the interval between OSPF hello packets on the loopback interface.

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

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

Default
Hello packets are sent every 10 seconds.

Command Reference

Rel VC4.1 v. 03

Vyatta

861

Chapter 15: OSPF

interfaces loopback lo ip ospf hello-interval <interval>

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

Chapter 15: OSPF

interfaces loopback lo ip ospf mtu-ignore

interfaces loopback lo ip ospf mtu-ignore

Disables MTU mismatch detection for the loopback interface.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces loopback lo ip ospf network <type>

interfaces loopback lo ip ospf network <type>

Specifies the OSPF network type for the loopback interface.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf network <type>

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

Chapter 15: OSPF

interfaces loopback lo ip ospf priority <priority>

interfaces loopback lo ip ospf priority <priority>

Specifies the Open Shortest Path First (OSPF) priority for the loopback interface.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces loopback lo ip ospf retransmit-interval <interval>

interfaces loopback lo ip ospf retransmit-interval

<interval>
Sets the OSPF retransmit interval for the loopback interface.

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

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Default
Unacknowledged LSAs are retransmitted at 5-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

869

Chapter 15: OSPF

interfaces loopback lo ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces loopback lo ip ospf transmit-delay <delay>

interfaces loopback lo ip ospf transmit-delay <delay>

Specifies the Open Shortest Path First (OSPF) transmit delay for the loopback interface.

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

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

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

Chapter 15: OSPF

interfaces loopback lo ip ospf transmit-delay <delay>

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf

interfaces multilink <mlx> ip ospf

Enables OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf

Use the show form of this command to display OSPF configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

874

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf authentication

interfaces multilink <mlx> ip ospf authentication

Specifies the authentication method for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

Rel VC4.1 v. 03

Vyatta

875

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf authentication

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf bandwidth <bandwidth>

interfaces multilink <mlx> ip ospf bandwidth

<bandwidth>
Specifies the bandwidth of a multilink interface for calculating OSPF cost.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

877

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf bandwidth <bandwidth>

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf cost <cost>

interfaces multilink <mlx> ip ospf cost <cost>

Sets the routing cost for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

Default
For details on the default of OSPF cost, please see the Usage Guidelines.

Command Reference

Rel VC4.1 v. 03

Vyatta

879

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf cost <cost>

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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf dead-interval <interval>

interfaces multilink <mlx> ip ospf dead-interval

<interval>
Sets the dead interval for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf hello-interval <interval>

interfaces multilink <mlx> ip ospf hello-interval

<interval>
Sets the interval between OSPF hello packets on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

Default
Hello packets are sent every 10 seconds.

Command Reference

Rel VC4.1 v. 03

Vyatta

883

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf hello-interval <interval>

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf mtu-ignore

interfaces multilink <mlx> ip ospf mtu-ignore

Disables MTU mismatch detection for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf network <type>

interfaces multilink <mlx> ip ospf network <type>

Specifies the network type for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf network <type>

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf priority <priority>

interfaces multilink <mlx> ip ospf priority <priority>

Sets the priority for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf retransmit-interval <interval>

interfaces multilink <mlx> ip ospf retransmit-interval

<interval>
Sets the retransmit interval for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Default
Unacknowledged LSAs are retransmitted at 5-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

891

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf transmit-delay <delay>

interfaces multilink <mlx> ip ospf transmit-delay

<delay>
Specifies the transmit delay for OSPF on a multilink interface.

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

Mandatory. The identifier of the multilink bundle. You can create up to

two multilink bundles. Supported values are ml0 (em ell zero) through
ml23 (em ell twenty-three).

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

Default
Link-state transmits occur at 1-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

893

Chapter 15: OSPF

interfaces multilink <mlx> ip ospf transmit-delay <delay>

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

Enables OSPF on the virtual interface of a Cisco HDLC serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

Default
OSPF is not enabled on Cisco HDLC interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

895

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf authentication

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

authentication
Specifies the authentication method for OSPF on the virtual interface of a Cisco HDLC
serial interface.

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf authentication

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf authentication

Use the show form of this command to display interface authentication configuration
information.

Command Reference

Rel VC4.1 v. 03

Vyatta

899

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf bandwidth <bandwidth>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

bandwidth <bandwidth>
Specifies the bandwidth on the virtual interface of a Cisco HDLC serial interface for
calculating OSPF cost.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

Rel VC4.1 v. 03

Vyatta

900

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf bandwidth <bandwidth>

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf cost <cost>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf cost

<cost>
Sets the routing cost for OSPF on the virtual interface of a Cisco HDLC serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

Rel VC4.1 v. 03

Vyatta

902

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf cost <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 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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

T3 (44.736 Mbps

100+ Mbps

Rel VC4.1 v. 03

Vyatta

903

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf cost <cost>

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf dead-interval <interval>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

dead-interval <interval>
Sets the OSPF dead interval for the virtual interface of a Cisco HDLC serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf hello-interval <interval>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

hello-interval <interval>
Sets the interval between OSPF hello packets on the virtual interface of a Cisco HDLC
serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

907

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf hello-interval <interval>

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf mtu-ignore

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

mtu-ignore
Disables MTU mismatch detection for the virtual interface of a Cisco HDLC serial
interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

909

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf network <type>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf network

<type>
Specifies the OSPF network type for the virtual interface of a Cisco HDLC serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

911

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf network <type>

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf priority <priority>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf priority

<priority>
Sets the OSPF priority for the virtual interface of a Cisco HDLC serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf retransmit-interval <interval>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

retransmit-interval <interval>
Sets the OSPF retransmit interval for the virtual interface of a Cisco HDLC serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Rel VC4.1 v. 03

Vyatta

915

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf transmit-delay <delay>

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf

transmit-delay <delay>
Specifies the OSPF transmit delay for the virtual interface of a Cisco HDLC serial
interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for Cisco HDLC interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

917

Chapter 15: OSPF

interfaces serial <wanx> cisco-hdlc vif 1 ip ospf transmit-delay <delay>

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

Enables OSPF on the virtual interface of a Frame Relay serial interface.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf authentication

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

authentication
Specifies the authentication method for OSPF on the virtual interface of a Frame Relay
serial interface.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf authentication

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf authentication

Use the show form of this command to display interface authentication configuration
information.

Command Reference

Rel VC4.1 v. 03

Vyatta

923

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf bandwidth <bandwidth>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

bandwidth <bandwidth>
Specifies the bandwidth on the virtual interface of a Frame Relay serial interface for
calculating OSPF cost.

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

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

Rel VC4.1 v. 03

Vyatta

924

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf bandwidth <bandwidth>

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf cost <cost>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

cost <cost>
Sets the routing cost for OSPF on the virtual interface of a Frame Relay serial interface.

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

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

Rel VC4.1 v. 03

Vyatta

926

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf cost <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 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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

T3 (44.736 Mbps

100+ Mbps

Rel VC4.1 v. 03

Vyatta

927

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf cost <cost>

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf dead-interval <interval>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

dead-interval <interval>
Sets the OSPF dead interval for the virtual interface of a Frame Relay serial interface.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf hello-interval <interval>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

hello-interval <interval>
Sets the interval between OSPF hello packets on the virtual interface of a Frame Relay
serial interface.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf hello-interval <interval>

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf mtu-ignore

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

mtu-ignore
Disables MTU mismatch detection for the virtual interface of a Frame Relay serial
interface.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf network <type>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

network <type>
Specifies the OSPF network type for the virtual interface of a Frame Relay serial interface.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf network <type>

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf priority <priority>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

priority <priority>
Sets the OSPF priority for the virtual interface of a Frame Relay serial interface.

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf retransmit-interval <interval>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

retransmit-interval <interval>
Sets the OSPF retransmit interval for the virtual interface of a Frame Relay serial interface.

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

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Rel VC4.1 v. 03

Vyatta

939

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf transmit-delay <delay>

interfaces serial <wanx> frame-relay vif <dlci> ip ospf

transmit-delay <delay>
Specifies the OSPF transmit delay for the virtual interface of a Frame Relay serial interface.

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

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

Rel VC4.1 v. 03

Vyatta

941

Chapter 15: OSPF

interfaces serial <wanx> frame-relay vif <dlci> ip ospf transmit-delay <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 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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf

interfaces serial <wanx> ppp vif 1 ip ospf

Enables OSPF on the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

Default
OSPF is not enabled on PPP interfaces.

Command Reference

Rel VC4.1 v. 03

Vyatta

943

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf authentication

interfaces serial <wanx> ppp vif 1 ip ospf

authentication
Specifies the authentication method for OSPF on the virtual interface of a PPP serial
interface.

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf authentication

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

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

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf authentication

Use the show form of this command to display interface authentication configuration
information.

Command Reference

Rel VC4.1 v. 03

Vyatta

947

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf bandwidth <bandwidth>

interfaces serial <wanx> ppp vif 1 ip ospf bandwidth

<bandwidth>
Specifies the bandwidth on the virtual interface of a PPP serial interface for calculating
OSPF cost.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

bandwidth

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

Rel VC4.1 v. 03

Vyatta

948

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf bandwidth <bandwidth>

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf cost <cost>

interfaces serial <wanx> ppp vif 1 ip ospf cost <cost>

Sets the routing cost for OSPF on the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

cost

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

Rel VC4.1 v. 03

Vyatta

950

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf cost <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 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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf cost <cost>

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf dead-interval <interval>

interfaces serial <wanx> ppp vif 1 ip ospf dead-interval

<interval>
Sets the OSPF dead interval for the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf hello-interval <interval>

interfaces serial <wanx> ppp vif 1 ip ospf hello-interval

<interval>
Sets the interval between OSPF hello packets on the virtual interface of a PPP serial
interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

955

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf hello-interval <interval>

interval

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf mtu-ignore

interfaces serial <wanx> ppp vif 1 ip ospf mtu-ignore

Disables MTU mismatch detection for the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

Default
MTU mismatch detection is enabled by default.

Command Reference

Rel VC4.1 v. 03

Vyatta

957

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf mtu-ignore

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf network <type>

interfaces serial <wanx> ppp vif 1 ip ospf network

<type>
Specifies the OSPF network type for the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

Rel VC4.1 v. 03

Vyatta

959

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf network <type>

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf priority <priority>

interfaces serial <wanx> ppp vif 1 ip ospf priority

<priority>
Sets the OSPF priority for the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf retransmit-interval <interval>

interfaces serial <wanx> ppp vif 1 ip ospf

retransmit-interval <interval>
Sets the OSPF retransmit interval for the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

interval

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Rel VC4.1 v. 03

Vyatta

963

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf transmit-delay <delay>

interfaces serial <wanx> ppp vif 1 ip ospf transmit-delay

<delay>
Specifies the OSPF transmit delay for the virtual interface of a PPP serial interface.

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.

The identifier of the virtual interface. Currently, only one vif is

supported for PPP interfaces, and the identifier must be 1.

delay

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

Rel VC4.1 v. 03

Vyatta

965

Chapter 15: OSPF

interfaces serial <wanx> ppp vif 1 ip ospf transmit-delay <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 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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf

interfaces tunnel <tunx> ip ospf

Enables OSPF on a tunnel interface.

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf authentication

interfaces tunnel <tunx> ip ospf authentication

Specifies the authentication method for OSPF on an Ethernet interface.

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf authentication

md5-key

Optional. A password-like MD5 key of up to 16 alphanumeric

characters to be used as input to the MD5 hashing algorithm. The longer
the key, the stronger the security. This must be the same on both the
sending and receiving systems.

password

Optional. The password to use in plain-text authentication. This must be

eight characters or less and the same on both the sending and receiving
systems.

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf bandwidth <bandwidth>

interfaces tunnel <tunx> ip ospf bandwidth

<bandwidth>
Specifies the bandwidth of a tunnel interface for calculating OSPF cost.

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

The bandwidth of the Ethernet interface in kilobits/sec. The range is 1 to

10000000.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

970

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf bandwidth <bandwidth>

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf cost <cost>

interfaces tunnel <tunx> ip ospf cost <cost>

Sets the routing cost for OSPF on a tunnel interface.

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

The link-state metric (OSPF cost) to be advertised in the link-state

advertisement (LSA) as the cost of sending packets over the ethernet
interface. The range is 1 to 65535.

Default
For details on the default of OSPF cost, please see the Usage Guidelines.

Command Reference

Rel VC4.1 v. 03

Vyatta

972

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf cost <cost>

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

4 Mbps Token Ring

10 Mbps Ethernet

10

16 Mbps Token Ring

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf dead-interval <interval>

interfaces tunnel <tunx> ip ospf dead-interval

<interval>
Sets the OSPF dead interval for a tunnel interface.

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf dead-interval <interval>

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf hello-interval <interval>

interfaces tunnel <tunx> ip ospf hello-interval

<interval>
Sets the interval between OSPF hello packets on a tunnel interface.

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

Mandatory. The interval, in seconds, between hello packets. This value

must be the same for all nodes on the network.The range is 1 to 65535.
The default is 10.

Default
Hello packets are sent every 10 seconds.

Command Reference

Rel VC4.1 v. 03

Vyatta

976

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf hello-interval <interval>

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf mtu-ignore

interfaces tunnel <tunx> ip ospf mtu-ignore

Disables MTU mismatch detection for a tunnel interface.

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf mtu-ignore

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

979

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf network <type>

interfaces tunnel <tunx> ip ospf network <type>

Specifies the OSPF network type for a tunnel interface.

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf network <type>

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf priority <priority>

interfaces tunnel <tunx> ip ospf priority <priority>

Sets the OSPF priority for a tunnel interface.

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf priority <priority>

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf retransmit-interval <interval>

interfaces tunnel <tunx> ip ospf retransmit-interval

<interval>
Sets the OSPF retransmit interval for a tunnel interface.

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

Specifies the time in seconds to wait for an acknowledgement, after

which the system retransmits an LSA packet to its neighbors. The range
is 3 to 65535. The default is 5.

Default
Unacknowledged LSAs are retransmitted at 5-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

984

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf retransmit-interval <interval>

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

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf transmit-delay <delay>

interfaces tunnel <tunx> ip ospf transmit-delay <delay>

Specifies the OSPF transmit delay for a tunnel interface.

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

Mandatory. The delay, in seconds, between link-state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

Default
Link-state transmits occur at 1-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

986

Chapter 15: OSPF

interfaces tunnel <tunx> ip ospf transmit-delay <delay>

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

Chapter 15: OSPF

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

Chapter 15: OSPF

protocols ospf access-list <list-num>

protocols ospf access-list <list-num>

Specifies access list to filter networks in routing updates.

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

Mandatory. The access list number used to filter networks in routing

updates.

type

Optional. The type of routes to filter. Possible values include: bgp,

connected, kernel, rip, or static. Multiple types can be specified by
creating additional export configuration nodes.

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

Chapter 15: OSPF

protocols ospf access-list <list-num>

Use the show form of this command to display the configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

990

Chapter 15: OSPF

protocols ospf area <area-id>

protocols ospf area <area-id>

Defines an OSPF area.

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

Mandatory. The ID of the OSPF area, expressed either as an IP address

or as a decimal value.

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

Chapter 15: OSPF

protocols ospf area <area-id> area-type normal

protocols ospf area <area-id> area-type normal

Designates an OSPF area as a normal area.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

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

Chapter 15: OSPF

protocols ospf area <area-id> area-type normal

Use the show form of this command to display an area type configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

993

Chapter 15: OSPF

protocols ospf area <area-id> area-type nssa

protocols ospf area <area-id> area-type nssa

Designates an OSPF area as a not-so-stubby area (NSSA).

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

cost

Optional. The administrative cost, or metric, that will be applied to the

default route in this area. The range is 0 to 6777215.

Rel VC4.1 v. 03

Vyatta

994

Chapter 15: OSPF

protocols ospf area <area-id> area-type nssa

no-summary

Optional. Prevents route summaries from being generated into the

area.

translate

Optional. Directs the NSSA ABR when to translate Type 7 LSAs into
Type 5 AS-external LSAs.

always

Always translates Type 7 LSAs into Type 5 AS-external LSAs.

candidate

Translates only Type 7 LSAs from the candidate NSSA border router.

never

Never translates Type 7 LSAs into Type 5 AS-external LSAs.

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

Chapter 15: OSPF

protocols ospf area <area-id> area-type stub

protocols ospf area <area-id> area-type stub

Designates an OSPF area as a stub area.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

cost

Optional. The administrative cost, or metric, that will be applied to the

default route in this area. The range is 0 to 6777215.

no-summary

Optional. Prevents route summaries from being generated into the

area.

Default
By default, summary routes are generated into the area.

Command Reference

Rel VC4.1 v. 03

Vyatta

996

Chapter 15: OSPF

protocols ospf area <area-id> area-type stub

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

Chapter 15: OSPF

protocols ospf area <area-id> authentication

protocols ospf area <area-id> authentication

Specifies the authentication type for an OSPF area.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

type

The type of authentication to be used. Supported values are as follows:

md5: A hash value is sent through the network, computed from the
password in the OSPF packet and the password, using the Message
Digest algorithm.
plaintext-password: Passwords are sent through the network in plain
text.

Default
The default is plain-text authentication.

Command Reference

Rel VC4.1 v. 03

Vyatta

998

Chapter 15: OSPF

protocols ospf area <area-id> authentication

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

Chapter 15: OSPF

protocols ospf area <area-id> network <ipv4net>

protocols ospf area <area-id> network <ipv4net>

Specifies a network address for an OSPF area.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

ipv4net

Mandatory. Multi-node. Specify the network to be used for the OSPF

area. The format is ip-address/prefix.

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

Chapter 15: OSPF

protocols ospf area <area-id> network <ipv4net>

Use the show form of this command to display OSPF area network configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

100

Chapter 15: OSPF

protocols ospf area <area-id> range <ip4net>

protocols ospf area <area-id> range <ip4net>

Allows an ABR to summarize routes matching a prefix range.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

ipv4net

Mandatory. The range to be summarized, expressed as an IPv4

network in the format ip-address/prefix.

cost

Optional. The administrative cost, or metric, to be applied to routes in

this range. The range is 0 to 16777215.

not-advertise

Optional. Directs the router not to advertise routes in this range.

Rel VC4.1 v. 03

Vyatta

100

Chapter 15: OSPF

protocols ospf area <area-id> range <ip4net>

substitute
ipv4net

Optional. Directs the router to announce routes in this range as being

in the specified prefix instead. The format is ip-address/prefix.

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

Chapter 15: OSPF

protocols ospf area <area-id> shortcut <mode>

protocols ospf area <area-id> shortcut <mode>

Sets the OSPF shortcut mode for an Area Border Router (ABR).

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

Rel VC4.1 v. 03

Vyatta

100

Chapter 15: OSPF

protocols ospf area <area-id> shortcut <mode>

mode

Mandatory. The shortcut mode. Supported values are as follows:

default: If the ABR has an active backbone connection, the area is not
used for shortcutting and the ABR does not set the shortcut bit (S-bit)
in the router-LSA originated for the area. If the ABR does not have a
backbone connection, the area is always used for shortcutting and the
ABR sets the S-bit in the router-LSA for that area.
disable: The ABR does not use this area for shortcutting and does not
set the S-bit in the router-LSA originated for the area.
enable: If the ABR has an active backbone connection, the ABR sets
the S-bit in the router-LSA and the area is used for shortcutting
provided that all other ABRs seen through this area also report the
S-bit. If the ABR has does not have a backbone connection, the ABR
unconditionally uses the area for shortcutting and sets the S-bit in the
router-LSA originated for the area.

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

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> authentication

protocols ospf area <area-id> virtual-link <ipv4>

authentication
Specifies the authentication characteristics for a virtual link.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

Rel VC4.1 v. 03

Vyatta

100

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> authentication

ipv4

Mandatory. The area ID of the virtual link, expressed as an IPv4

address.

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

Optional. The MD5 key to be used as input to the MD5 hashing

algorithm. This must be the same on both the sending and receiving
systems.

password

Optional. The password to use in plain-text authentication. This must

be eight characters or less and the same on both the sending and
receiving systems.

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

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> dead-interval <interval>

protocols ospf area <area-id> virtual-link <ipv4>

dead-interval <interval>
Specifies the dead interval for a virtual link.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

ipv4

Mandatory. The area ID of the virtual link, expressed as an IPv4

address.

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

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> dead-interval <interval>

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

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> hello-interval <interval>

protocols ospf area <area-id> virtual-link <ipv4>

hello-interval <interval>
Sets the interval between OSPF hello packets on a virtual link.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

ipv4

Mandatory. The area ID of the virtual link, expressed as an IPv4

address.

interval

Mandatory. The interval, in seconds, between hello packets. This

value must be the same for all nodes on the network.The range is 1 to
65535. The default is 10.

Default
Hello packets are sent every 10 seconds.

Command Reference

Rel VC4.1 v. 03

Vyatta

101

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> hello-interval <interval>

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

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> retransmit-interval <interval>

protocols ospf area <area-id> virtual-link <ipv4>

retransmit-interval <interval>
Specifies the retransmit interval for a virtual link.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

ipv4

Mandatory. The area ID of the virtual link, expressed as an IPv4

address.

interval

Mandatory. The interval, in seconds, between retransmitting

unacknowledged link-state advertisements (LSAs). This value must
be the same for all nodes on the network. The range is 1 to 65535. The
default is 5.

Default
Unacknowledged LSAs are retransmitted at 5-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

101

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> retransmit-interval <interval>

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

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> transmit-delay <delay>

protocols ospf area <area-id> virtual-link <ipv4>

transmit-delay <delay>
Specifies the transmit delay for a virtual link.

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

Mandatory. The ID of the OSPF area being configured, expressed as

an IP address or a decimal value.

ipv4

Mandatory. The area ID of the virtual link, expressed as an IPv4

address.

delay

Mandatory. The delay, in seconds, between link state transmits. This

value must be the same for all nodes on the network. The range is 1 to
65535. The default is 1.

Default
Link-state transmits occur at 1-second intervals.

Command Reference

Rel VC4.1 v. 03

Vyatta

101

Chapter 15: OSPF

protocols ospf area <area-id> virtual-link <ipv4> transmit-delay <delay>

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

Chapter 15: OSPF

protocols ospf auto-cost reference-bandwidth <bandwidth>

protocols ospf auto-cost reference-bandwidth

<bandwidth>
Directs the system to use the reference bandwidth method for calculating administrative
cost.

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

Mandatory. The reference bandwidth rate in Megabits per second. The

range is 1 to 4294967.

Default
The default reference bandwidth is 108.

Command Reference

Rel VC4.1 v. 03

Vyatta

101

Chapter 15: OSPF

protocols ospf auto-cost reference-bandwidth <bandwidth>

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

Chapter 15: OSPF

protocols ospf default-information originate

protocols ospf default-information originate

Sets the characteristics of an external default route originated into an OSPF routing domain.

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

Optional. Always advertises the default route.

metric metric

Optional. The metric to be applied to the default route. The range is 0

to 16777214. The default is 1.

Rel VC4.1 v. 03

Vyatta

101

Chapter 15: OSPF

protocols ospf default-information originate

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

Optional. The default route is generated if the specified route map is

satisfied.

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.

In not-so-stubby areas (NSSAs) configured to import summary advertisements, a Type

7 LSA with a metric of 1 and a metric type of 2 is generated.

In NSSAs configured not to import summary advertisements, a Type 3 LSA with

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

Chapter 15: OSPF

protocols ospf default-metric <metric>

protocols ospf default-metric <metric>

Sets default metric to be applied to routes being redistributed into OSPF.

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

Mandatory. The metric to be applied to routes from other protocols

being redistributed into OSPF. The range is 0 to 16777214.

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

Chapter 15: OSPF

protocols ospf distance

protocols ospf distance

Sets the OSPF administrative distance by route type.

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

Sets the OSPF administrative distance for external routes (routes

learned from another protocol by redistribution). The range is 1 to 255.
The default is 110.

inter

Sets the OSPF administrative distance for inter-area routes (routes to

another area). The range is 1 to 255. The default is 110.

intra

Sets the OSPF administrative distance for intra-area routes (routes

within an area). The range is 1 to 255. The default is 110.

Rel VC4.1 v. 03

Vyatta

102

Chapter 15: OSPF

protocols ospf distance

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

Chapter 15: OSPF

protocols ospf log-adjacency-changes

protocols ospf log-adjacency-changes

Enables or disables logging of changes in adjacency state of neighbors.

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

Chapter 15: OSPF

protocols ospf max-metric router-lsa

protocols ospf max-metric router-lsa

Enables or disables an OSPF stub router to advertise a maximum metric value when the
router is started up or reloaded.

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

Optional. Advertise the maximum metric for an indefinite

period.

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

Chapter 15: OSPF

protocols ospf max-metric router-lsa

on-startup startup

Advertise the maximum metric when the OSPF process is

started up or reloaded. The startup 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.

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

Chapter 15: OSPF

protocols ospf mpls-te

protocols ospf mpls-te

Sets Multi-Protocol Label Switching (MPLS) Traffic Engineering (MPLS-TE) parameters.

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

Optional. Enables MPLS-TE functionality.

ipv4

Optional. The stable IP address of the advertising router.

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

Chapter 15: OSPF

protocols ospf mpls-te

Use the show form of this command to display MPLS-TE configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

102

Chapter 15: OSPF

protocols ospf neighbor <ipv4>

protocols ospf neighbor <ipv4>

Defines an OSPF neighbor.

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

Mandatory. The IPv4 address of the OSPF neighbor.

interval

Optional. The interval, in seconds, at which this neighbor should be

polled to determine whether it is still reachable. The range is 1
to 65535. The default is 120.

priority

Optional. The priority of this neighbor. The range is 0 to 255, where

the lower the number, the higher the priority. The default is 1.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

102

Chapter 15: OSPF

protocols ospf neighbor <ipv4>

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

Chapter 15: OSPF

protocols ospf parameters

protocols ospf parameters

Sets global OSPF parameters, such as router ID.

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

Optional. Supported only for Area Border Routers (ABRs). Set

the OSPF ABR type. Supported values are as follows:
cisco: Designates the router as a Cisco ABR
ibm: Designates the router as an IBM ABR
shortcut: Designates the router as an ABR supporting shortcut
mode as described in draft-ietf-ospf-shortcut-abr-02.txt.
standard: Designates the router as a standard ABR
The default is standard.

opaque-lsa

Command Reference

Optional. Enables support for opaque link-state advertisement

as described in RFC 2370.

Rel VC4.1 v. 03

Vyatta

103

Chapter 15: OSPF

protocols ospf parameters

rfc1583-compatibility

Optional. Enables compliance with RFC 1583 for handling AS

external routes.

ipv4

Optional. Sets an explicit router ID, overriding the router ID

calculated by the OSPF process. The format is an IPv4 address.

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

Use the IP address of the loopback interface.

Use the highest IP address of the address on router interfaces.

If no interfaces are defined, use 0.0.0.0.

Usage Guidelines
Use this command to set OSPF-specific parameters.
NOTE

Modifying the router ID causes the router to restart.

Use the set form of this command to specify parameter values.

Use the delete form of this command to restore defaults for global OSPF parameters.
Use the show form of this command to display global OSPF parameter configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

103

Chapter 15: OSPF

protocols ospf passive-interface <ethx>

protocols ospf passive-interface <ethx>

Suppress routing updates on an interface.

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

Mandatory. Multi-node. The Ethernet interface for which routing

updates are to be suppressed.
You can suppress routing updates on multiple interfaces by creating
multiple passive-interface configuration nodes.

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

Chapter 15: OSPF

protocols ospf redistribute bgp

protocols ospf redistribute bgp

Sets the parameters for redistribution of BGP routes into OSPF.

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

Optional. Applies the specified metric to BGP routes being

redistributed into OSPF. The range is 1 to 16. The default is 1.

route-map map-name

Optional. Redistributes routes satisfying the specified route

map.

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

Chapter 15: OSPF

protocols ospf redistribute bgp

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

Chapter 15: OSPF

protocols ospf redistribute connected

protocols ospf redistribute connected

Sets the parameters for redistribution of connected routes into OSPF.

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

Optional. Applies the specified metric to connected routes

being redistributed into OSPF. The range is 1 to 16. The default
is 1.

route-map map-name

Optional. Redistributes routes satisfying the specified route

map.

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

Chapter 15: OSPF

protocols ospf redistribute connected

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

Chapter 15: OSPF

protocols ospf redistribute kernel

protocols ospf redistribute kernel

Sets the parameters for redistribution of kernel routes into OSPF.

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

Optional. Applies the specified metric to kernel routes being

redistributed into OSPF. The range is 1 to 16. The default is 1.

route-map map-name

Optional. Redistributes routes satisfying the specified route

map.

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

Chapter 15: OSPF

protocols ospf redistribute kernel

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

Chapter 15: OSPF

protocols ospf redistribute rip

protocols ospf redistribute rip

Sets the parameters for redistribution of RIP routes into OSPF.

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

Optional. Applies the specified metric to RIP routes being

redistributed into OSPF. The range is 1 to 16. The default is 1.

route-map map-name

Optional. Redistributes routes satisfying the specified route

map.

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

Chapter 15: OSPF

protocols ospf redistribute rip

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

Chapter 15: OSPF

protocols ospf redistribute static

protocols ospf redistribute static

Sets the parameters for redistribution of static routes into OSPF.

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

Optional. Applies the specified metric to static routes being

redistributed into OSPF. The range is 1 to 16. The default is 1.

route-map map-name

Optional. Redistributes routes satisfying the specified route

map.

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

Chapter 15: OSPF

protocols ospf redistribute static

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

Chapter 15: OSPF

protocols ospf refresh timers <value>

protocols ospf refresh timers <value>

Sets values for OSPF refresh timers.

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

Mandatory. The timer value, in seconds. The range is 10 to 1800. The

default is 1800 (30 minutes).

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

Chapter 15: OSPF

protocols ospf refresh timers <value>

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

Chapter 15: OSPF

protocols ospf timers throttle spf

protocols ospf timers throttle spf

Enables or disables OSPF SPF throttling.

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

Optional. The delay, in milliseconds, from the first network topology

change received until SPF calculation. The range is 0 to 600000.

initial

Optional. The initial interval, in milliseconds, between consecutive

SPF calculations. The range is 0 to 600000.

max

Optional. The maximum interval, in milliseconds, between

consecutive SPF calculations. The range is 0 to 600000.

Rel VC4.1 v. 03

Vyatta

104

Chapter 15: OSPF

protocols ospf timers throttle spf

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

Chapter 15: OSPF

show debugging ospf

show debugging ospf

Displays OSPF protocol debugging flags.

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

Chapter 15: OSPF

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

vyatta@vyatta:~$ show ip ospf

OSPF Routing Process, Router ID: 10.100.10.1
Supports only single TOS (TOS0) routes
This implementation conforms to RFC2328
RFC1583Compatibility flag is disabled
OpaqueCapability flag is disabled
Initial SPF scheduling delay 200 millisec(s)
Minimum hold time between consecutive SPFs 1000 millisec(s)
Maximum hold time between consecutive SPFs 10000 millisec(s)
Hold time multiplier is currently 1
SPF algorithm last executed 1w2d01h ago
SPF timer is inactive
Refresh timer 10 secs
Number of external LSA 1. Checksum Sum 0x000083e4

Command Reference

Rel VC4.1 v. 03

Vyatta

104

Chapter 15: OSPF

show ip ospf

Number of opaque AS LSA 0. Checksum Sum 0x00000000

Number of areas attached to this router: 1
Area ID: 10.1.0.0
Shortcutting mode: Default, S-bit consensus: no
Number of interfaces in this area: Total: 1, Active: 1
Number of fully adjacent neighbors in this area: 2
Area has no authentication
Number of full virtual adjacencies going through this area: 0
SPF algorithm executed 3 times
Number of LSA 4
Number of router LSA 3. Checksum Sum 0x0000ccad
Number of network LSA 1. Checksum Sum 0x00000df2
Number of summary LSA 0. Checksum Sum 0x00000000
Number of ASBR summary LSA 0. Checksum Sum 0x00000000
Number of NSSA LSA 0. Checksum Sum 0x00000000
Number of opaque link LSA 0. Checksum Sum 0x00000000
Number of opaque area LSA 0. Checksum Sum 0x00000000
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

104

Chapter 15: OSPF

show ip ospf border-routers

show ip ospf border-routers

Displays OSPF border router information.

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

vyatta@vyatta:~$ show ip ospf border-routers

============ OSPF router routing table =============
R
10.1.0.58
[10] area: 10.1.0.0, ASBR
via 10.1.0.58, eth2
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

105

Chapter 15: OSPF

show ip ospf database

show ip ospf database

Displays OSPF database information.

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

Display OSPF max-age database.

self-originate

Display OSPF self-originate database.

asbr-summary

Display OSPF ASBR (Autonomous System Border Router) summary

database.

external

Display OSPF external database.

network

Display OSPF network database.

nssa-external

Display OSPF NSSA external database.

opaque-area

Display OSPF opaque-area database.

opaque-as

Display OSPF opaque-as database.

opaque-link

Display OSPF opaque-link database.

router

Display OSPF router database.

summary

Display summary of OSPF database.

adv-router ipv4

Optional. Display the OSPF database for a given address of the

advertised router specified.

ipv4

Optional. Display the OSPF database for a given address.

self-originate

Optional. Display the self-originate OSPF database for a given

address.

Rel VC4.1 v. 03

Vyatta

105

Chapter 15: OSPF

show ip ospf database

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

vyatta@vyatta:~$ show ip ospf database

OSPF Router with ID (10.100.10.1)
Router Link States (Area 10.1.0.0)
Link ID
10.1.0.33
10.1.0.58
10.100.10.1

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

Net Link States (Area 10.1.0.0)

Link ID
10.1.0.58

ADV Router
10.1.0.58

Age Seq#
CkSum
123 0x800003df 0x0bf3

AS External Link States

Link ID
ADV Router
76.0.0.0
10.1.0.58
76.0.0.0/8 [0x0]

Age Seq#
CkSum Route
1850 0x800000b3 0x83e4 E2

vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

105

Chapter 15: OSPF

show ip ospf interface

show ip ospf interface

Displays OSPF configuration and status information for a specified interface.

Syntax
show ip ospf interface [interface]

Command Mode
Operational mode.

Parameters

interface

Optional. Interface to view OSPF configuration and status on.

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

Chapter 15: OSPF

show ip ospf interface

ifindex 5, MTU 1500 bytes, BW 0 Kbit

<UP,BROADCAST,RUNNING,MULTICAST>
Internet Address 10.1.0.62/24, Broadcast 10.1.0.255, Area
10.1.0.0
MTU mismatch detection:enabled
Router ID 10.100.10.1, Network Type BROADCAST, Cost: 10
Transmit Delay is 1 sec, State DROther, Priority 1
Designated Router (ID) 10.1.0.58, Interface Address 10.1.0.58
Backup Designated Router (ID) 10.1.0.33, Interface Address
10.1.0.33
Multicast group memberships: OSPFAllRouters
Timer intervals configured, Hello 10s, Dead 40s, Wait 40s,
Retransmit 5
Hello due in 0.721s
Neighbor Count is 2, Adjacent neighbor count is 2
eth2_rename is down
ifindex 0, MTU 1500 bytes, BW 0 Kbit <BROADCAST,MULTICAST>
OSPF not enabled on this interface
eth3 is down
ifindex 2, MTU 1500 bytes, BW 0 Kbit <BROADCAST,MULTICAST>
OSPF not enabled on this interface
lo is up
ifindex 1, MTU 16436 bytes, BW 0 Kbit <UP,LOOPBACK,RUNNING>
OSPF not enabled on this interface
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

105

Chapter 15: OSPF

show ip ospf neighbor

show ip ospf neighbor

Displays OSPF neighbor information for a specified address or interface.

Syntax
show ip ospf neighbor [interface | ipv4 | detail | address ipv4]

Command Mode
Operational mode.

Parameters

interface

Optional. Display neighbor information for the specified interface.

ipv4

Optional. Display neighbor information for the specified address.

detail

Optional. Display detailed neighbor information for all neighbors.

address ipv4

Optional. Display neighbor information for the specified address.

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

vyatta@vyatta:~$ show ip ospf neighbor

Neighbor ID Pri State
Dead Time Address
Interface
RXmtL RqstL DBsmL
10.1.0.33
1 Full/Backup
33.842s 10.1.0.33
eth2:10.1.0.62
0
0
0

Command Reference

Rel VC4.1 v. 03

Vyatta

105

Chapter 15: OSPF

show ip ospf neighbor

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

Chapter 15: OSPF

show ip ospf route

show ip ospf route

Displays OSPF route information.

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

vyatta@vyatta:~$ show ip ospf route

============ OSPF network routing table ============
N
10.1.0.0/24
[10] area: 10.1.0.0
directly attached to eth2
============ OSPF router routing table =============
R
10.1.0.58
[10] area: 10.1.0.0, ASBR
via 10.1.0.58, eth2
============ OSPF external routing table ===========
N E2 76.0.0.0/8
[10/20] tag: 0
via 10.1.0.7, eth2
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

105

Chapter 15: OSPF

Command Reference

show ip ospf route

Rel VC4.1 v. 03

Vyatta

105

Chapter 15: OSPF

show ip route ospf

show ip route ospf

Displays all IP OSPF routes.

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

vyatta@vyatta:~$ show ip route ospf

Codes: K - kernel route, C - connected, S - static, R - RIP, O OSPF,
I - ISIS, B - BGP, > - selected route, * - FIB route
O
10.1.0.0/24 [110/10] is directly connected, eth2, 01w2d21h
O>* 76.0.0.0/8 [110/20] via 10.1.0.7, eth2, 4d12h48m
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

105

1060

Chapter 16: BGP

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

protocols bgp <asn> aggregate-address

<ipv4net>

Configuration

Specifies a block of IP addresses to aggregate.

protocols bgp <asn> network <ipv4net>

Configuration

Specifies a network to be advertised by the BGP

routing process.

protocols bgp <asn> timers

Configuration

Sets BGP timers globally for the local router.

Global BGP Configuration Commands

Router-Specific BGP Configuration Commands

protocols bgp <asn> parameters
always-compare-med

Configuration

Directs the router to compare the MED for

paths from neighbors in different autonomous
systems.

protocols bgp <asn> parameters bestpath

as-path

Configuration

Directs the router to compare the AS paths

during best path selection.

Chapter 16: BGP

106

Command

Mode

Description

protocols bgp <asn> parameters bestpath

compare-routerid

Configuration

Directs the router to compare identical routes

received from different external peers during
best path selection.

protocols bgp <asn> parameters bestpath med Configuration

Directs the router to compare the Multi Exit

Discriminator (MED) among paths learned from
confederation peers during best path selection.

protocols bgp <asn> parameters dampening

Configuration

Enables or disables route dampening and sets

route dampening values.

protocols bgp <asn> parameters default

Configuration

Sets default routing behaviors for the system.

protocols bgp <asn> parameters

deterministic-med

Configuration

Enables or disables enforcing of deterministic

MED.

protocols bgp <asn> parameters

disable-network-import-check

Configuration

Disables IGP route check for network

statements.

protocols bgp <asn> parameters

enforce-first-as

Configuration

Enables or disables forcing eBGP peers to list AS

number at the beginning of the AS_PATH
attribute in incoming updates.

protocols bgp <asn> parameters

graceful-restart

Configuration

Enables or disables graceful restart of the BGP

process.

protocols bgp <asn> parameters

log-neighbor-changes

Configuration

Enables or disables logging of the status of BGP

neighbors.

protocols bgp <asn> parameters

no-fast-external-failover

Configuration

Enables or disables automatic resetting of BGP

sessions for failed links.

protocols bgp <asn> parameters router-id <id> Configuration

Sets a fixed BGP router ID for the router,

overriding the automatic ID selection process.

protocols bgp <asn> parameters scan-time

<seconds>

Sets the scanning interval for the router.

Configuration

BGP Route Reflection Configuration Commands

protocols bgp <asn> parameters cluster-id <id> Configuration

Enables or disables route reflection from a BGP

route reflector to clients.

protocols bgp <asn> parameters cluster-id <id> Configuration

Sets the cluster ID for a BGP route reflection

cluster.

protocols bgp <asn> neighbor <id>

route-reflector-client

Defines the local router as a BGP route

reflector, with the neighbor as a route reflector
client.

Command Reference

Configuration

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

Command

106

Mode

Description

BGP Route Server Configuration Commands

protocols bgp <asn> neighbor <id>
route-server-client

Configuration

Defines the local router as a BGP route server,

with the neighbor as a route server client.

BGP Confederation Configuration Commands

protocols bgp <asn> parameters confederation Configuration
identifier <asn>

Defines a BGP confederation.

protocols bgp <asn> parameters confederation Configuration

peers <asn>

Defines the autonomous systems that make up

a BGP confederation.

BGP Route Filtering Configuration Commands

protocols bgp <asn> neighbor <id>
disable-send-community

Configuration

Applies an access list to filter inbound routing

updates from this neighbor.

protocols bgp <asn> neighbor <id> filter-list

import <acl-num>

Configuration

Applies a filter list to routing updates from this

neighbor.

protocols bgp <asn> neighbor <id> prefix-list

import <list-name>

Configuration

Applies an prefix list to filter updates from this

neighbor.

protocols bgp <asn> neighbor <id> route-map Configuration

import <map-name>

Applies a route map to filter updates to or from

this neighbor.

BGP Peer Group Definition Commands

protocols bgp <asn> neighbor <id> peer-group Configuration

Creates a peer group, or assigns a neighbor as

a member of the specified peer group.

BGP Neighbor (and Peer Group) Configuration Commands

protocols bgp <asn> neighbor <id>

Configuration

Defines a BGP neighbor.

protocols bgp <asn> neighbor <id>

advertisement-interval <seconds>

Configuration

Sets the minimum interval for BGP route

updates.

protocols bgp <asn> neighbor <id> allowas-in

Configuration

Allows or disallows receiving BGP

advertisements containing the AS path of the
local router.

protocols bgp <asn> neighbor <id>

attribute-unchanged

Configuration

Allows the router to send updates to a

neighbor with unchanged attributes.

protocols bgp <asn> neighbor <id> capability

dynamic

Configuration

Advertises support for dynamic update of BGP

capabilities advertised and received from this
neighbor.

protocols bgp <asn> neighbor <id> capability

orf

Configuration

Enables or disables forwarding of the default

route to a BGP neighbor.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

Command

106

Mode

Description

protocols bgp <asn> neighbor <id> description Configuration

<desc>

Provides a brief description for a BGP neighbor.

protocols bgp <asn> neighbor <id>

disable-send-community

Configuration

Applies an access list to filter inbound routing

updates from this neighbor.

protocols bgp <asn> neighbor <id>

ebgp-multihop <ttl>

Configuration

Disables BGP capability negotiation.

protocols bgp <asn> neighbor <id>

ebgp-multihop <ttl>

Configuration

Allows eBGP neighbors not on directly

connected networks.

protocols bgp <asn> neighbor <id> filter-list

import <acl-num>

Configuration

Applies a filter list to routing updates from this

neighbor.

protocols bgp <asn> neighbor <id> local-as

Configuration

Defines a local autonomous system number for

eBGP peerings.

protocols bgp <asn> neighbor <id>

nexthop-self

Configuration

Sets the local router as the next hop for this

neighbor.

protocols bgp <asn> neighbor <id>

override-capability

Configuration

Overrides capability negotiation to allow a

peering session to be established with a
neighbor that does not support capability
negotiation.

protocols bgp <asn> neighbor <id> passive

Configuration

Directs the router not to initiate connections

with this neighbor.

protocols bgp <asn> neighbor <id> peer-group Configuration

Creates a peer group, or assigns a neighbor as

a member of the specified peer group.

protocols bgp <asn> neighbor <id> port

<port-num>

Configuration

Specifies the port on which the neighbor is

listening for BGP signals.

protocols bgp <asn> neighbor <id> prefix-list

import <list-name>

Configuration

Applies an prefix list to filter updates from this

neighbor.

protocols bgp <asn> neighbor <id> remote-as

<asn>

Configuration

Specifies the autonomous system number of

the neighbor.

protocols bgp <asn> neighbor <id>

remove-private-as

Configuration

Directs the router to remove private AS

numbers from updates sent to this neighbor.

protocols bgp <asn> neighbor <id> route-map Configuration

import <map-name>

Applies a route map to filter updates to or from

this neighbor.

protocols bgp <asn> neighbor <id> shutdown

Configuration

Administratively shuts down a BGP neighbor.

protocols bgp <asn> neighbor <id>

soft-reconfiguration

Configuration

Directs the router to store received routing

updates.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

106

Command

Mode

Description

protocols bgp <asn> neighbor <id>

strict-capability-match

Configuration

Directs the router to strictly match the

capabilities of the neighbor.

protocols bgp <asn> neighbor <id> timers

Configuration

Sets BGP timers for this neighbor.

protocols bgp <asn> neighbor <id>

unsuppress-map <map-name>

Configuration

Directs the router to selectively advertise routes

suppressed by aggregating addresses, based on
a route map.

protocols bgp <asn> neighbor <id>

update-source <ethx>

Configuration

Allows the router to use a specific interface for

TCP connections.

protocols bgp <asn> neighbor <id> weight

<weight>

Configuration

Defines a default weight for routes from this

neighbor.

protocols bgp <asn> redistribute connected

Configuration

Redistributes directly connected routes into

BGP.

protocols bgp <asn> redistribute kernel

Configuration

Redistributes kernel routes into BGP.

protocols bgp <asn> redistribute ospf

Configuration

Redistributes routes learned from OSPF into

BGP.

protocols bgp <asn> redistribute rip

Configuration

Redistributes routes learned from RIP into BGP.

protocols bgp <asn> redistribute static

Configuration

Redistributes static routes into BGP.

clear ip bgp <address>

Operational

Resets a BGP connection.

clear ip bgp <address> ipv4 unicast

Operational

Optional. Resets only connections in the route

server client Routing Information Base (RIB).

clear ip bgp dampening

Operational

Resets an IPv4 unicast BGP connection.

clear ip bgp external

Operational

Clears BGP route dampening information and

unsuppresses suppressed routes.

clear ip bgp external ipv4 unicast

Operational

Resets peering sessions for eBGP neighbors.

clear ip bgp peer-group <group-name>

Operational

Resets IPv4 unicast peering sessions for eBGP

neighbors.

clear ip bgp peer-group <group-name> ipv4

unicast

Operational

Resets sessions for all members of a peer

group.

clear ip bgp view <view-name> <address>

Operational

Resets BGP connections for a view in a BGP

route server.

BGP Route Redistribution Commands

BGP Clear Commands

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

Command

106

Mode

clear ip bgp view <view-name> <address> ipv4 Operational

unicast

Description
Resets IPv4 unicast BGP connections for a view
in a BGP route server.

BGP Debugging Commands

debug bgp

Operational

Enables or disables debug message generation

related to the acquisition of the BGP router ID
and the sending and receiving of BGP
messages.

debug bgp events

Operational

Enables or disables debug message generation

related to BGP events.

debug bgp filters

Operational

Enables or disables debug message generation

related to the operation of BGP routing filters.

debug bgp fsm

Operational

Enables or disables debug message generation

related to the BGP Finite State Machine (FSM).

debug bgp keepalives

Operational

Display debugging information related to

sending and receiving BGP keep-alive
messages.

debug bgp updates

Operational

Display debugging information related to BGP

routing updates.

debug bgp zebra

Operational

Display debugging information related to

configuration of the Zebra BGP daemon.

show debugging bgp

Operational

Displays BGP protocol debugging flags.

show ip bgp

Operational

Displays BGP routes.

show ip bgp attribute-info

Operational

Displays BGP attribute information.

show ip bgp cidr-only

Operational

Displays BGP routes with CIDR network masks.

show ip bgp community-info

Operational

Displays BGP community information.

show ip bgp community <community>

Operational

Displays BGP routes belonging to the specified

BGP community.

show ip bgp community-list <list-name>

Operational

Displays BGP routes permitted by the specified

community list.

show ip bgp dampened-paths

Operational

Displays BGP routes that are currently

dampened.

show ip bgp filter-list <list-num>

Operational

Displays routes matching a list of autonomous

system paths.

BGP Show Commands

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

106

Command

Mode

Description

show ip bgp flap-statistics

Operational

Displays route flap statistics for BGP routes.

show ip bgp flap-statistics cidr-only

Operational

Displays only route flap statistics for BGP routes

with CIDR network masks.

show ip bgp flap-statistics filter-list <list-num>

Operational

Displays route flap statistics for BGP routes

matching a list of AS paths.

show ip bgp flap-statistics prefix-list

<list-name>

Operational

Displays route flap statistics for BGP routes

matching a prefix list.

show ip bgp flap-statistics regexp <expr>

Operational

Displays route flap statistics for BGP routes

matching an AS path regular expression.

show ip bgp flap-statistics route-map

<map-name>

Operational

Displays route flap statistics for BGP routes

matching a route map.

show ip bgp ipv4 unicast

Operational

Displays information for IPv4 unicast BGP

routes.

show ip bgp ipv4 unicast cidr-only

Operational

Displays IPv4 unicast BGP routes with CIDR

network masks.

show ip bgp ipv4 unicast community

<community>

Operational

Displays IPv4 unicast BGP routes belonging to

the specified community.

show ip bgp ipv4 unicast community-list

<list-name>

Operational

Displays IPv4 unicast BGP routes permitted by

the specified community list.

show ip bgp ipv4 unicast filter-list <list-num>

Operational

Displays IPv4 unicast BGP routes matching a

filter list of autonomous system paths.

show ip bgp ipv4 unicast neighbors

Operational

Displays information for IPv4 unicast BGP

neighbors.

show ip bgp ipv4 unicast neighbors <ipv4>

advertised-routes

Operational

Displays advertised BGP IPv4 unicast routes for

a BGP neighbor.

show ip bgp ipv4 unicast neighbors <ipv4>

prefix-counts

Operational

Displays IPv4 unicast prefix-counts for a BGP

neighbor.

show ip bgp ipv4 unicast neighbors <ipv4>

received prefix-filter

Operational

Displays the IPv4 unicast prefix-lists received

from a BGP neighbor.

show ip bgp ipv4 unicast neighbors <ipv4>

received-routes

Operational

Displays the IPv4 unicast routes received from a

BGP neighbor.

show ip bgp ipv4 unicast neighbors <ipv4>

routes

Operational

Displays IPv4 unicast received and accepted

routes from a BGP neighbor.

show ip bgp ipv4 unicast paths

Operational

Displays BGP IPv4 unicast path information.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

Command

106

Mode

Description

show ip bgp ipv4 unicast prefix-list <list-name> Operational

Displays IPv4 unicast BGP routes matching a

prefix list.

show ip bgp ipv4 unicast regexp <regexp>

Operational

Displays IPv4 unicast BGP routes matching an

AS path regular expression.

show ip bgp ipv4 unicast route-map

<map-name>

Operational

Displays IPv4 unicast BGP routes matching a

route map.

show ip bgp ipv4 unicast rsclient summary

Operational

Displays IPv4 unicast BGP route server client

summary information.

show ip bgp ipv4 unicast statistics

Operational

Displays statistics for BGP IPv4 unicast routes.

show ip bgp memory

Operational

Displays memory usage for BGP.

show ip bgp neighbors

Operational

Displays BGP neighbor information.

show ip bgp neighbors <ipv4>

advertised-routes

Operational

Displays advertised routes for a BGP neighbor.

show ip bgp neighbors <ipv4>

dampened-routes

Operational

Displays dampened routes to a BGP neighbor.

show ip bgp neighbors <ipv4> flap-statistics

Operational

Displays route flap statistics for routes learned

from a BGP neighbor.

show ip bgp neighbors <ipv4> prefix-counts

Operational

Displays prefix counts for a BGP neighbor.

show ip bgp neighbors <ipv4> received

prefix-filter

Operational

Displays prefix lists received from a BGP

neighbor.

show ip bgp neighbors <ipv4> received-routes

Operational

Displays routes received from a BGP neighbor.

show ip bgp neighbors <ipv4> routes

Operational

Displays all received and accepted routes from a

BGP neighbor.

show ip bgp paths

Operational

Displays all BGP paths.

show ip bgp prefix-list <list-name>

Operational

Displays BGP routes matching a prefix list.

show ip bgp regexp <regexp>

Operational

Displays routes matching an AS path regular

expression.

show ip bgp route-map <map-name>

Operational

Displays routes matching a route map.

show ip bgp rsclient <address>

Operational

Displays BGP route server client information.

show ip bgp scan

Operational

Displays BGP scan status.

show ip bgp view <view-name>

Operational

Displays BGP information for a view in a BGP

route server.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

106

Command

Mode

Description

show ip bgp view <view-name> ipv4 unicast

rsclient summary

Operational

Displays IPv4 unicast route server client

summary information for a view in a BGP route
server.

show ip bgp view <view-name> neighbors

Operational

Displays BGP neighbor information for a viewn

in a BGP route server.

show ip bgp view <view-name> rsclient

Operational

Displays BGP route server client information for

a view in a BGP route server.

show ip route bgp

Operational

Displays BGP routes.

See also the following commands in other chapters.

show ip route <ipv4net> longer-prefixes

Command Reference

Operational

show ip route <ipv4net> longer-prefixes See

page 520.

Rel VC4.1 v. 03

Vyatta

Chapter 16: BGP

clear ip bgp <address>

clear ip bgp <address>

Resets a BGP connection.

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

Optional. Resets the inbound session only.

out

Optional. Resets the outbound session only.

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

Optional. Resets only connections in the route server client Routing

Information Base (RIB).

soft

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

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

Chapter 16: BGP

clear ip bgp <address> ipv4 unicast

clear ip bgp <address> ipv4 unicast

Resets an IPv4 unicast BGP connection.

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

Optional. Resets inbound sessions only.

out

Optional. Resets outbound sessions only.

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

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.
.

Command Reference

Rel VC4.1 v. 03

Vyatta

107

Chapter 16: BGP

clear ip bgp <address> ipv4 unicast

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

Chapter 16: BGP

clear ip bgp dampening

clear ip bgp dampening

Clears BGP route dampening information and unsuppresses suppressed routes.

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

Optional. An IPv4 network mask.

ipv4net

Optional. Clears route dampening information for all peers on the

specified network. The format is ip-address/prefix.

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

Chapter 16: BGP

clear ip bgp external

clear ip bgp external

Resets peering sessions for eBGP neighbors.

Syntax
clear ip bgp external [in [prefix-filter] | out | soft [in | out]]

Command Mode
Operational mode.

Parameters

in

Optional. Resets inbound sessions only.

out

Optional. Resets outbound sessions only.

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

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

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

Chapter 16: BGP

clear ip bgp external

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

Chapter 16: BGP

clear ip bgp external ipv4 unicast

clear ip bgp external ipv4 unicast

Resets IPv4 unicast peering sessions for eBGP neighbors.

Syntax
clear ip bgp external ipv4 unicast [in [prefix-filter] | out | soft [in | out]

Command Mode
Operational mode.

Parameters

in

Optional. Resets inbound sessions only.

out

Optional. Resets outbound sessions only.

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

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

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

Chapter 16: BGP

clear ip bgp external ipv4 unicast

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

Chapter 16: BGP

clear ip bgp peer-group <group-name>

clear ip bgp peer-group <group-name>

Resets sessions for all members of a peer group.

Syntax
clear ip bgp peer-group group-name [in [prefix-filter] | out | soft [in | out]]

Command Mode
Operational mode.

Parameters

group-name

Mandatory. The name of a defined BGP peer group.

in

Optional. Resets inbound sessions only.

out

Optional. Resets outbound sessions only.

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

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

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

Chapter 16: BGP

clear ip bgp peer-group <group-name>

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

Chapter 16: BGP

clear ip bgp peer-group <group-name> ipv4 unicast

clear ip bgp peer-group <group-name> ipv4 unicast

Resets IPv4 unicast sessions for all members of a peer group.

Syntax
clear ip bgp peer-group group-name ipv4 unicast [in [prefix-filter] | out | soft [in | out]]

Command Mode
Operational mode.

Parameters

group-name

Mandatory. The name of a defined BGP peer group.

in

Optional. Resets inbound sessions only.

out

Optional. Resets outbound sessions only.

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

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

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

Chapter 16: BGP

clear ip bgp peer-group <group-name> ipv4 unicast

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

Chapter 16: BGP

clear ip bgp view <view-name> <address>

clear ip bgp view <view-name> <address>

Resets BGP connections for a view in a BGP route server.

Syntax
clear ip bgp view view-name {ipv4 | ipv6} [in [prefix-filter] | soft [in | out] | rsclient]

Command Mode
Operational mode.

Parameters

view-name

Mandatory. The name of a view (routing table) in a BGP route server.

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

Optional. Resets inbound sessions only.

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

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

rsclient

Optional. Resets only connections in the route server client Routing

Information Base (RIB).

Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.

Command Reference

Rel VC4.1 v. 03

Vyatta

108

Chapter 16: BGP

clear ip bgp view <view-name> <address>

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

Chapter 16: BGP

clear ip bgp view <view-name> <address> ipv4 unicast

clear ip bgp view <view-name> <address> ipv4 unicast

Resets IPv4 unicast BGP connections for a view in a BGP route server.

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

Optional. Resets inbound sessions only.

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

Optional. Uses soft reconfiguration for the reset.

in

Optional. Resets with soft reconfiguration only inbound sessions.

out

Optional. Resets with soft reconfiguration only outbound sessions.

rsclient

Optional. Resets only connections in the route server client Routing

Information Base (RIB).

Default
When used without the soft option, reset connections are dropped, both inbound and
outbound.

Command Reference

Rel VC4.1 v. 03

Vyatta

108

Chapter 16: BGP

clear ip bgp view <view-name> <address> ipv4 unicast

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

Chapter 16: BGP

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

Chapter 16: BGP

debug bgp events

debug bgp events

Enables or disables debug message generation related to BGP events.

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

Chapter 16: BGP

debug bgp filters

debug bgp filters

Enables or disables debug message generation related to the operation of BGP routing
filters.

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

Chapter 16: BGP

debug bgp fsm

debug bgp fsm

Enables or disables debug message generation related to the BGP Finite State Machine
(FSM).

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

Chapter 16: BGP

debug bgp keepalives

debug bgp keepalives

Display debugging information related to sending and receiving BGP keep-alive messages.

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

Chapter 16: BGP

debug bgp updates

debug bgp updates

Display debugging information related to BGP routing updates.

Syntax
debug bgp updates [in | out]
no debug bgp updates
undebug bgp updates

Command Mode
Operational mode.

Parameters

in

Optional. Debug information is generated only for inbound routing

updates.

out

Optional. Debug information is generated only for outbound routing

updates.

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

Chapter 16: BGP

debug bgp zebra

debug bgp zebra

Display debugging information related to configuration of the Zebra BGP daemon.

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

Chapter 16: BGP

no debug all bgp

no debug all bgp

Disables all BGP debugging.

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

Chapter 16: BGP

protocols bgp <asn>

protocols bgp <asn>

Creates a BGP instance on the router and locates it within an Autonomous System (AS).

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

Chapter 16: BGP

protocols bgp <asn>

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

Chapter 16: BGP

protocols bgp <asn> aggregate-address <ipv4net>

protocols bgp <asn> aggregate-address <ipv4net>

Specifies a block of IP addresses to aggregate.

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

Mandatory. The number of the AS in which this router resides.

ipv4net

Mandatory. The network from which routes are to be aggregated. The

format is ip-address/prefix.

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

Chapter 16: BGP

protocols bgp <asn> aggregate-address <ipv4net>

Use the show form of this command to view aggregate address configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

109

Chapter 16: BGP

protocols bgp <asn> neighbor <id>

protocols bgp <asn> neighbor <id>

Defines a BGP neighbor.

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

Mandatory. Multi-node. The IP address of a BGP neighbor.

You can define multiple BGP neighbors by creating multiple neighbor
configuration nodes.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id>

Use the show form of this command to view BGP neighbor configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

109

Chapter 16: BGP

protocols bgp <asn> neighbor <id> advertisement-interval <seconds>

protocols bgp <asn> neighbor <id>

advertisement-interval <seconds>
Sets the minimum interval for BGP route updates.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

seconds

Mandatory. The minimum interval, in seconds, between BGP routing

updates to this neighbor. The range is 0 to 600. The default is 30 for
eBGP peers and 5 for iBGP peers.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> advertisement-interval <seconds>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> allowas-in

protocols bgp <asn> neighbor <id> allowas-in

Allows or disallows receiving BGP advertisements containing the AS path of the local
router.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

number num

Optional. Specifies the number of times to accept an AS path containing

the readvertisement of the local routers ASN. The range is 1 to 10. The
default is 3.

Default
Readvertisement is disabled.

Command Reference

Rel VC4.1 v. 03

Vyatta

110

Chapter 16: BGP

protocols bgp <asn> neighbor <id> allowas-in

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> attribute-unchanged

protocols bgp <asn> neighbor <id>

attribute-unchanged
Allows the router to send updates to a neighbor with unchanged attributes.

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

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

Mandatory. The IP address of a BGP neighbor or the name of a

BGP peer group.

as-path

Optional. Propagates the route update with unchanged

AS_PATH attribute.

med

Optional. Propagates the route update with unchanged Multi

Exit Discriminator.

Rel VC4.1 v. 03

Vyatta

110

Chapter 16: BGP

protocols bgp <asn> neighbor <id> attribute-unchanged

next-hop

Optional. Propagates the route update with unchanged 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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> capability dynamic

protocols bgp <asn> neighbor <id> capability dynamic

Advertises support for dynamic update of BGP capabilities advertised and received from
this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

Default
By default, the session is brought up with minimal capability on both sides.

Command Reference

Rel VC4.1 v. 03

Vyatta

110

Chapter 16: BGP

protocols bgp <asn> neighbor <id> capability dynamic

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> capability orf

protocols bgp <asn> neighbor <id> capability orf

Advertises support for Outbound Route Filtering (ORF) for updating BGP capabilities
advertised and received from this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

prefix-list

Optional. Advertise prefix-list ORF capability to this neighbor.

receive

Optional. Advertise the ability to receive the ORF from this neighbor.

Rel VC4.1 v. 03

Vyatta

110

Chapter 16: BGP

protocols bgp <asn> neighbor <id> capability orf

send

Optional. Advertise the capability to send the ORF to this neighbor.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> default-originate

protocols bgp <asn> neighbor <id> default-originate

Enables or disables forwarding of the default route to a BGP neighbor.

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

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

Mandatory. The IP address of a BGP neighbor or the name of a

BGP peer group.

route-map map-name

Optional. Specifies a configured route map to be used when

advertising the default route.

Default
The default route is not distributed.

Command Reference

Rel VC4.1 v. 03

Vyatta

110

Chapter 16: BGP

protocols bgp <asn> neighbor <id> default-originate

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:

The route map includes a match ip address clause.

A route exists that exactly matches the IP access list.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> description <desc>

protocols bgp <asn> neighbor <id> description <desc>

Provides a brief description for a BGP neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

desc

Mandatory. A description of up to 80 characters for the neighbor. If

spaces are included, the description must be enclosed in quotes.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

111

Chapter 16: BGP

protocols bgp <asn> neighbor <id> description <desc>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> disable-capability-negotiation

protocols bgp <asn> neighbor <id>

disable-capability-negotiation
Disables BGP capability negotiation.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> disable-capability-negotiation

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> disable-connected-check

protocols bgp <asn> neighbor <id>

disable-connected-check
Disables direct connection verification for single-hop eBGP peers.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> disable-connected-check

Connection verification is used to establish an eBGP peering session with a single-hop

peer. A single-hop peer is defined using the neighbor ebgp-multihop command and
specifying a time-to-live (TTL) value of 1. Such a peer is reachable by a single hop, but is
configured on a loopback interface or is otherwise configured with a nondirectly
connected IP address.
For these peers, the BGP process normally checks to determine whether the eBGP peer is
directly connected to the same network as the local router. If not, the peering session is not
established.
If connection verification is disabled, source updating must be enabled using the protocols
bgp <asn> neighbor <id> update-source <ethx> command (see page 1169) so that the
BGP process can used the loopback interface for the peering session.
Use the delete form of this command to restore connection verification for eBGP peering
sessions.
Use the show form of this command to view BGP neighbor configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

111

Chapter 16: BGP

protocols bgp <asn> neighbor <id> disable-send-community

protocols bgp <asn> neighbor <id>

disable-send-community
Disables sending of community attributes to the specified neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

extended

Optional. Disable sending extended community attributes.

standard

Optional. Disable sending standard community attributes.

Rel VC4.1 v. 03

Vyatta

111

Chapter 16: BGP

protocols bgp <asn> neighbor <id> disable-send-community

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> distribute-list import <acl-num>

protocols bgp <asn> neighbor <id> distribute-list

import <acl-num>
Applies an access list to filter inbound routing updates from this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

acl-num

Optional. The number of a standard or extended access list. The range

for a standard access list is 1 to 99. The range for an extended access list
is 100 to 199.

Rel VC4.1 v. 03

Vyatta

111

Chapter 16: BGP

protocols bgp <asn> neighbor <id> distribute-list import <acl-num>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> distribute-list export <acl-num>

protocols bgp <asn> neighbor <id> distribute-list

export <acl-num>
Applies an access list to filter outbound routing updates to this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

acl-num

Optional. The number of a standard or extended access list. The range

for a standard access list is 1 to 99. The range for an extended access list
is 100 to 199.

Rel VC4.1 v. 03

Vyatta

112

Chapter 16: BGP

protocols bgp <asn> neighbor <id> distribute-list export <acl-num>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> ebgp-multihop <ttl>

protocols bgp <asn> neighbor <id> ebgp-multihop <ttl>

Allows eBGP neighbors not on directly connected networks.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

ttl

Mandatory. The time-to-live, or maximum number of hops allowed. The

range is 1 to 255. The default is 10.

Default
Only directly connected neighbors are allowed.

Command Reference

Rel VC4.1 v. 03

Vyatta

112

Chapter 16: BGP

protocols bgp <asn> neighbor <id> ebgp-multihop <ttl>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> filter-list import <acl-num>

protocols bgp <asn> neighbor <id> filter-list import

<acl-num>
Applies a filter list to routing updates from this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

acl-num

Mandatory. Number of an autonomous system path access list. The

range is 1 to 65535.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

112

Chapter 16: BGP

protocols bgp <asn> neighbor <id> filter-list import <acl-num>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> filter-list export <acl-num>

protocols bgp <asn> neighbor <id> filter-list export

<acl-num>
Applies a filter list to routing updates to this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

acl-num

Mandatory. Number of an autonomous system path access list. The

range is 1 to 65535.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

112

Chapter 16: BGP

protocols bgp <asn> neighbor <id> filter-list export <acl-num>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> local-as

protocols bgp <asn> neighbor <id> local-as

Defines a local autonomous system number for eBGP peerings.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

asn

Optional. Valid autonomous system number. This may not be the

number of the autonomous system to which the neighbor belongs. The
range is 1 to 65535.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> local-as

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> maximum-prefix <max-num>

protocols bgp <asn> neighbor <id> maximum-prefix

<max-num>
Sets the maximum number of prefixes to accept from this neighbor before that neighbor is
taken down.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

max-num

Mandatory. The maximum number of prefixes to accept from this

neighbor before the neighbor is taken down.

Default
No maximum to the number of prefixes accepted.

Command Reference

Rel VC4.1 v. 03

Vyatta

113

Chapter 16: BGP

protocols bgp <asn> neighbor <id> maximum-prefix <max-num>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> nexthop-self

protocols bgp <asn> neighbor <id> nexthop-self

Sets the local router as the next hop for this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> nexthop-self

Use the show form of this command to view BGP neighbor configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

113

Chapter 16: BGP

protocols bgp <asn> neighbor <id> override-capability

protocols bgp <asn> neighbor <id> override-capability

Overrides capability negotiation to allow a peering session to be established with a
neighbor that does not support capability negotiation.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> override-capability

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> passive

protocols bgp <asn> neighbor <id> passive

Directs the router not to initiate connections with this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> passive

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> peer-group

protocols bgp <asn> neighbor <id> peer-group

Creates a peer group, or assigns a neighbor as a member of the specified peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> peer-group

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.

ipv4

Mandatory when assigning a neighbor to a peer group. The

IPv4 address of a defined BGP neighbor.

group-name

Mandatory. A string identifying a BGP peer group.

Default
By default, peer group members inherit the following settings, if configured:

Remote AS

Update source

Outbound route maps

Outbound filter lists

Outbound distribute lists

Nexthop-self settings

BGP Peer Groups

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> port <port-num>

protocols bgp <asn> neighbor <id> port <port-num>

Specifies the port on which the neighbor is listening for BGP signals.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> port <port-num>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> prefix-list import <list-name>

protocols bgp <asn> neighbor <id> prefix-list import

<list-name>
Applies an prefix list to filter updates from this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

list-name

Mandatory. Name of a configured prefix list.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

114

Chapter 16: BGP

protocols bgp <asn> neighbor <id> prefix-list import <list-name>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> prefix-list export <list-name>

protocols bgp <asn> neighbor <id> prefix-list export

<list-name>
Applies an prefix list to filter updates to this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

list-name

Mandatory. Name of a configured prefix list.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

114

Chapter 16: BGP

protocols bgp <asn> neighbor <id> prefix-list export <list-name>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> remote-as <asn>

protocols bgp <asn> neighbor <id> remote-as <asn>

Specifies the autonomous system number of the neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> remote-as <asn>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> remove-private-as

protocols bgp <asn> neighbor <id> remove-private-as

Directs the router to remove private AS numbers from updates sent to this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

Default
Private AS numbers are included in outgoing updates.

Command Reference

Rel VC4.1 v. 03

Vyatta

114

Chapter 16: BGP

protocols bgp <asn> neighbor <id> remove-private-as

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-map import <map-name>

protocols bgp <asn> neighbor <id> route-map import

<map-name>
Applies a route map to filter updates to or from this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

map-name

Mandatory. Name of a configured route map.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

115

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-map import <map-name>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-map export <map-name>

protocols bgp <asn> neighbor <id> route-map export

<map-name>
Applies a route map to filter updates to this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

map-name

Mandatory. Name of a configured route map.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

115

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-map export <map-name>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-reflector-client

protocols bgp <asn> neighbor <id>

route-reflector-client
Defines the local router as a BGP route reflector, with the neighbor as a route reflector
client.

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

Mandatory.The IP address of a BGP neighbor or the name of a BGP peer

group.

Default
There is no route reflector in the autonomous system.

Command Reference

Rel VC4.1 v. 03

Vyatta

115

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-reflector-client

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.

An RR environment is unlike a regular environment, where iBGP peers never forward a

route update to other iBGP peers (which is the reason why each iBGP peer must peer with
all other peers). When an RR server receives an iBGP update from an RR client, these route
updates can also be sent to all other RR clients. When an RR server receives a route update
from a peer, it selects the best path based on its path selection rule. After the best path is
selected, the RR server chooses its action depending on the type of the peer from which it
learned the best path.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-server-client

protocols bgp <asn> neighbor <id> route-server-client

Defines the local router as a BGP route server, with the neighbor as a route server client.

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

Mandatory.The IP address of a BGP neighbor or the name of a BGP peer

group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> route-server-client

Use the show form of this command to view BGP neighbor configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

115

Chapter 16: BGP

protocols bgp <asn> neighbor <id> shutdown

protocols bgp <asn> neighbor <id> shutdown

Administratively shuts down a BGP neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> shutdown

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> soft-reconfiguration

protocols bgp <asn> neighbor <id> soft-reconfiguration

Directs the router to store received routing updates.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

inbound

Optional. Indicates that the update to be stored is an incoming update.

Default
Disabled.

Command Reference

Rel VC4.1 v. 03

Vyatta

116

Chapter 16: BGP

protocols bgp <asn> neighbor <id> soft-reconfiguration

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> strict-capability-match

protocols bgp <asn> neighbor <id>

strict-capability-match
Directs the router to strictly match the capabilities of the neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

Default
Disabled.

Command Reference

Rel VC4.1 v. 03

Vyatta

116

Chapter 16: BGP

protocols bgp <asn> neighbor <id> strict-capability-match

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> timers

protocols bgp <asn> neighbor <id> timers

Sets BGP timers for this neighbor.

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

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

Mandatory. The IP address of a BGP neighbor or the name of a

BGP peer group.

connect seconds

Optional. The amount of time, in seconds, that the system waits

for the transport protocol connection to complete. If this timer
expires, the state remains in Connect state, the timer is reset,
and the system tries to initiate a new transport connection. The
range is 0 to 65535.The default is 120.
During the connect period, the remote BGP peer can establish a
connection to the local system.

Command Reference

Rel VC4.1 v. 03

Vyatta

116

Chapter 16: BGP

protocols bgp <asn> neighbor <id> timers

keepalive seconds

Optional. The frequency, in seconds, with which the local router

sends keep-alive messages to this neighbor. The range is 1 to
65535, where 0 disables the keep-alive timer. The default is 60.

holdtime seconds

Optional. The maximum interval, in seconds, after which if the

local router has not received a keep-alive message from this
neighbor, the neighbor is declared dead. The range is 0 and 4 to
65535, where 0 disables the holdtime timer. The default is 180.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> unsuppress-map <map-name>

protocols bgp <asn> neighbor <id> unsuppress-map

<map-name>
Directs the router to selectively advertise routes suppressed by aggregating addresses,
based on a route map.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

map-name

Mandatory. The name of a configured route map.

Default
Routes suppressed by address aggregation are not advertised.

Command Reference

Rel VC4.1 v. 03

Vyatta

116

Chapter 16: BGP

protocols bgp <asn> neighbor <id> unsuppress-map <map-name>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> update-source <ethx>

protocols bgp <asn> neighbor <id> update-source

<ethx>
Allows the router to use a specific interface for TCP connections.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

ethx

Mandatory. The name of the interface to be used for TCP connections.

Default
The closest interface (that is, the best local address) is assigned for TCP sessions.

Command Reference

Rel VC4.1 v. 03

Vyatta

116

Chapter 16: BGP

protocols bgp <asn> neighbor <id> update-source <ethx>

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> weight <weight>

protocols bgp <asn> neighbor <id> weight <weight>

Defines a default weight for routes from this neighbor.

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

Mandatory. The IP address of a BGP neighbor or the name of a BGP

peer group.

weight

Mandatory. The weight to be assigned to routes from this neighbor. The

range is 0 to 65535.

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

Chapter 16: BGP

protocols bgp <asn> neighbor <id> weight <weight>

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

Chapter 16: BGP

protocols bgp <asn> network <ipv4net>

protocols bgp <asn> network <ipv4net>

Specifies a network to be advertised by the BGP routing process.

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

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.

ipv4net

Mandatory. Multi-node. An IPv4 network in the format

ip-address/prefix.
You can advertise to multiple networks by creating multiple
network configuration nodes.

Command Reference

backdoor

Optional. Indicates that this network is reachable by a backdoor

route. A backdoor network is considered to be like a local
network, but is not advertised.

route-map map-name

Optional. Specifies a configured route map to be used when

advertising the network.

Rel VC4.1 v. 03

Vyatta

117

Chapter 16: BGP

protocols bgp <asn> network <ipv4net>

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

Chapter 16: BGP

protocols bgp <asn> parameters always-compare-med

protocols bgp <asn> parameters always-compare-med

Directs the router to compare the MED for paths from neighbors in different autonomous
systems.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters always-compare-med

Use the show form of this command to view global BGP configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

117

Chapter 16: BGP

protocols bgp <asn> parameters bestpath as-path

protocols bgp <asn> parameters bestpath as-path

Directs the router to compare the AS paths during best path selection.

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

Mandatory. The number of 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.

confed

Optional. Directs the router to compare the AS paths within a

confederation during best path selection.

ignore

Optional. Directs the router to ignore AS_PATH during best

path selection.

Rel VC4.1 v. 03

Vyatta

117

Chapter 16: BGP

protocols bgp <asn> parameters bestpath as-path

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

Chapter 16: BGP

protocols bgp <asn> parameters bestpath compare-routerid

protocols bgp <asn> parameters bestpath

compare-routerid
Directs the router to compare identical routes received from different external peers during
best path selection.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters bestpath compare-routerid

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

Chapter 16: BGP

protocols bgp <asn> parameters bestpath med

protocols bgp <asn> parameters bestpath med

Directs the router to compare the Multi Exit Discriminator (MED) among paths learned
from confederation peers during best path selection.

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

Mandatory. The number of 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.

confed

Optional. Compare the MED among confederation paths

missing-as-worst

Optional. Treat a missing MED as the least preferred one.

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

Chapter 16: BGP

protocols bgp <asn> parameters bestpath med

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

Chapter 16: BGP

protocols bgp <asn> parameters cluster-id <id>

protocols bgp <asn> parameters cluster-id <id>

Sets the cluster ID for a BGP route reflection cluster.

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

Mandatory. The number of 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

Mandatory. A network address uniquely identifying the route reflection

cluster.

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

Chapter 16: BGP

protocols bgp <asn> parameters cluster-id <id>

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

Chapter 16: BGP

protocols bgp <asn> parameters confederation identifier <asn>

protocols bgp <asn> parameters confederation

identifier <asn>
Defines a BGP confederation.

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

Mandatory. The number of 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.

identifier asn

Mandatory. The AS number of the BGP confederation. The

range of values is 1 to 65535. The subrange 64512 to 65535 is
reserved for private autonomous systems.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

118

Chapter 16: BGP

protocols bgp <asn> parameters confederation identifier <asn>

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

Chapter 16: BGP

protocols bgp <asn> parameters confederation peers <asn>

protocols bgp <asn> parameters confederation peers

<asn>
Defines the autonomous systems that make up a BGP confederation.

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

Mandatory. The number of the AS in which this router resides.

peers asn

Mandatory. The subautonomous systems that will make up the

BGP confederation. The range of values is 1 to 65535. The
subrange 64512 to 65535 is reserved for private autonomous
systems. Multiple ASs can be specified in a space-separated
list.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

118

Chapter 16: BGP

protocols bgp <asn> parameters confederation peers <asn>

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

Chapter 16: BGP

protocols bgp <asn> parameters dampening

protocols bgp <asn> parameters dampening

Enables or disables route dampening and sets route dampening values.

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

Mandatory. The number of 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.

half-life minutes

Optional. The time period, in minutes, after which the penalty

assigned to a route because of flapping is reduced by half. The
range is 1 to 45. The default is 15.

max-suppress-time
minutes

Optional. The maximum time, in minutes, that a route may be

suppressed. The range is 1 to 20000. The default is four times
the half-life period.

Rel VC4.1 v. 03

Vyatta

118

Chapter 16: BGP

protocols bgp <asn> parameters dampening

re-use penalty

Optional. The reuse threshold. If the penalty for a flapping route

is reduced below this point, the route is to be brought back into
use. The range is 1 to 20000. The default is 750.

start-suppress-time
penalty

Optional. The route suppression threshold. If the accumulated

penalty for a flapping route reaches this limit, the route is
suppressed. The range is 1 to 20000. The default is 2000.

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

Chapter 16: BGP

protocols bgp <asn> parameters default

protocols bgp <asn> parameters default

Sets default routing behaviors for the system.

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

Mandatory. The number of 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.

local-pref pref

Optional. Specifies the degree of preference that iBGP peers are

to give local routes during BGP best path selection. The higher
the value, the more the route is to be preferred. The range is 0
to 4294967295. The default is 100.

no-ipv4-unicast

Optional. Disables the IPv4 unicast address family as the

default for peering session establishment. By default, IPv4
address family prefixes are automatically exchanged.

Rel VC4.1 v. 03

Vyatta

119

Chapter 16: BGP

protocols bgp <asn> parameters default

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

Chapter 16: BGP

protocols bgp <asn> parameters deterministic-med

protocols bgp <asn> parameters deterministic-med

Enables or disables enforcing of deterministic MED.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters disable-network-import-check

protocols bgp <asn> parameters

disable-network-import-check
Disables IGP route check for network statements.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters disable-network-import-check

Use the show form of this command to view global BGP configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

119

Chapter 16: BGP

protocols bgp <asn> parameters enforce-first-as

protocols bgp <asn> parameters enforce-first-as

Enables or disables forcing eBGP peers to list AS number at the beginning of the AS_PATH
attribute in incoming updates.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters enforce-first-as

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

Chapter 16: BGP

protocols bgp <asn> parameters graceful-restart

protocols bgp <asn> parameters graceful-restart

Enables or disables graceful restart of the BGP process.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters graceful-restart

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

Chapter 16: BGP

protocols bgp <asn> parameters log-neighbor-changes

protocols bgp <asn> parameters log-neighbor-changes

Enables or disables logging of the status of BGP neighbors.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters log-neighbor-changes

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

Chapter 16: BGP

protocols bgp <asn> parameters no-client-to-client-reflection

protocols bgp <asn> parameters

no-client-to-client-reflection
Enables or disables route reflection from a BGP route reflector to clients.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters no-client-to-client-reflection

Use the show form of this command to view global BGP configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

120

Chapter 16: BGP

protocols bgp <asn> parameters no-fast-external-failover

protocols bgp <asn> parameters

no-fast-external-failover
Enables or disables automatic resetting of BGP sessions for failed links.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters no-fast-external-failover

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

Chapter 16: BGP

protocols bgp <asn> parameters router-id <id>

protocols bgp <asn> parameters router-id <id>

Sets a fixed BGP router ID for the router, overriding the automatic ID selection process.

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

Mandatory. The number of 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

Mandatory. The ID to be used by the router as the BGP router 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

Chapter 16: BGP

protocols bgp <asn> parameters router-id <id>

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

Chapter 16: BGP

protocols bgp <asn> parameters scan-time <seconds>

protocols bgp <asn> parameters scan-time <seconds>

Sets the scanning interval for the router.

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

Mandatory. The number of 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.

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

Chapter 16: BGP

protocols bgp <asn> parameters scan-time <seconds>

Use the show form of this command to view global BGP configuration settings.

Command Reference

Rel VC4.1 v. 03

Vyatta

120

Chapter 16: BGP

protocols bgp <asn> redistribute connected

protocols bgp <asn> redistribute connected

Redistributes directly connected routes into BGP.

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

Optional. The metric to be applied to redistributed connected routes.

map-name

Optional. The name of a configured route map to be used for

redistributing connected routes.

Rel VC4.1 v. 03

Vyatta

121

Chapter 16: BGP

protocols bgp <asn> redistribute connected

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

Chapter 16: BGP

protocols bgp <asn> redistribute kernel

protocols bgp <asn> redistribute kernel

Redistributes kernel routes into BGP.

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

Optional. The metric to be applied to redistributed kernel routes.

map-name

Optional. The name of a configured route map to be used for

redistributing kernel routes.

Default
When this command has not been set, kernel routes are not distributed into BGP.

Command Reference

Rel VC4.1 v. 03

Vyatta

121

Chapter 16: BGP

protocols bgp <asn> redistribute kernel

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

Chapter 16: BGP

protocols bgp <asn> redistribute ospf

protocols bgp <asn> redistribute ospf

Redistributes routes learned from OSPF into BGP.

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

Optional. The metric to be applied to redistributed OSPF routes.

map-name

Optional. The name of a configured route map to be used for

redistributing OSPF routes.

Rel VC4.1 v. 03

Vyatta

121

Chapter 16: BGP

protocols bgp <asn> redistribute ospf

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

Chapter 16: BGP

protocols bgp <asn> redistribute rip

protocols bgp <asn> redistribute rip

Redistributes routes learned from RIP into BGP.

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

Optional. The metric to be applied to redistributed RIP routes.

map-name

Optional. The name of a configured route map to be used for

redistributing RIP routes.

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

Chapter 16: BGP

protocols bgp <asn> redistribute rip

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

Chapter 16: BGP

protocols bgp <asn> redistribute static

protocols bgp <asn> redistribute static

Redistributes static routes into BGP.

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

Optional. The metric to be applied to redistributed static routes.

map-name

Optional. The name of a configured route map to be used for

redistributing static routes.

Default
When this command has not been set static routes are not distributed into BGP.

Command Reference

Rel VC4.1 v. 03

Vyatta

121

Chapter 16: BGP

protocols bgp <asn> redistribute static

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

Chapter 16: BGP

protocols bgp <asn> timers

protocols bgp <asn> timers

Sets BGP timers globally for the local router.

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

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.

keepalive seconds

Optional. The frequency, in seconds, with which the local router

sends keep-alive messages to neighbors. The range is 1 to
65535. The default is 60.

holdtime seconds

Optional. The maximum interval, in seconds, after which if the

local router has not received a keep-alive message from the
neighbor, a neighbor is declared dead. The range is 0 and 4 to
65535, where 0 disables the holdtime timer. The default is 180.

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

Chapter 16: BGP

protocols bgp <asn> timers

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

Chapter 16: BGP

show debugging bgp

show debugging bgp

Displays BGP protocol debugging flags.

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

Chapter 16: BGP

show ip bgp

show ip bgp
Displays BGP routes.

Syntax
show ip bgp [ipv4 | ipv4net [longer-prefixes] | summary]

Command Mode
Operational mode.

Parameters

ipv4

Optional. Displays routes for the neighbor at the specified IPv4

address.

ipv4net

Optional. Displays routes for the specified IPv4 network.

longer-prefixes

Optional. Displays any routes more specific than the one specified.

summary

Optional. Shows summary BGP route information.

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

Chapter 16: BGP

show ip bgp attribute-info

show ip bgp attribute-info

Displays BGP attribute information.

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

Chapter 16: BGP

show ip bgp cidr-only

show ip bgp cidr-only

Displays BGP routes with CIDR network masks.

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

Chapter 16: BGP

show ip bgp community-info

show ip bgp community-info

Displays BGP community information.

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

Chapter 16: BGP

show ip bgp community <community>

show ip bgp community <community>

Displays BGP routes belonging to the specified BGP community.

Syntax
show ip bgp community community [exact-match]

Command Mode
Operational mode.

Parameters

community

Mandatory. A BGP community identifier in the form AA:NN (where

AA and NN are in the range of 0-65535), one of the well-known BGP
communities local-AS, no-export, or no-advertise, or a
space-separated list of up to four community identifiers.

exact-match

Optional. Displays only routes that have an 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

Chapter 16: BGP

show ip bgp community-list <list-name>

show ip bgp community-list <list-name>

Displays BGP routes permitted by the specified community list.

Syntax
show ip bgp community-list list-name [exact-match]

Command Mode
Operational mode.

Parameters

list-name

Mandatory. A preconfigured list of BGP communities.

exact-match

Optional. Displays only route that have an 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

Chapter 16: BGP

show ip bgp dampened-paths

show ip bgp dampened-paths

Displays BGP routes that are currently dampened.

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

Chapter 16: BGP

show ip bgp filter-list <list-num>

show ip bgp filter-list <list-num>

Displays routes matching a list of autonomous system paths.

Syntax
show ip bgp filter-list list-num

Command Mode
Operational mode.

Parameters

list-num

Mandatory. The number of a preconfigured autonomous system path

access list. The range is 1 to 500.

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

Chapter 16: BGP

show ip bgp flap-statistics

show ip bgp flap-statistics

Displays route flap statistics for BGP routes.

Syntax
show ip bgp flap-statistics [ipv4 | ipv4net [longer-prefixes]

Command Mode
Operational mode.

Parameters

ipv4

Optional. Displays flap statistics for routes matching the specified

IPv4 address.

ipv4net

Optional. Displays flap statistics for routes matching the specified

IPv4 network.

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

Chapter 16: BGP

show ip bgp flap-statistics cidr-only

show ip bgp flap-statistics cidr-only

Displays only route flap statistics for BGP routes with CIDR network masks.

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

Chapter 16: BGP

show ip bgp flap-statistics filter-list <list-num>

show ip bgp flap-statistics filter-list <list-num>

Displays route flap statistics for BGP routes matching a list of AS paths.

Syntax
show ip bgp flap-statistics filter-list list-num

Command Mode
Operational mode.

Parameters

list-num

Mandatory. The number of a defined list of AS paths. The range is 1 to

500.

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

Chapter 16: BGP

show ip bgp flap-statistics prefix-list <list-name>

show ip bgp flap-statistics prefix-list <list-name>

Displays route flap statistics for BGP routes matching a prefix list.

Syntax
show ip bgp flap-statistics prefix-list list-name

Command Mode
Operational mode.

Parameters

list-name

Mandatory. The name of a defined prefix list.

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

Chapter 16: BGP

show ip bgp flap-statistics regexp <expr>

show ip bgp flap-statistics regexp <expr>

Displays route flap statistics for BGP routes matching an AS path regular expression.

Syntax
show ip bgp flap-statistics regexp expr

Command Mode
Operational mode.

Parameters

expr

Mandatory. A POSIX-style regular expression representing a set of AS

paths.

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

Chapter 16: BGP

show ip bgp flap-statistics route-map <map-name>

show ip bgp flap-statistics route-map <map-name>

Displays route flap statistics for BGP routes matching a route map.

Syntax
show ip bgp flap-statistics route-map map-name

Command Mode
Operational mode.

Parameters

map-name

Optional. The name of a defined route map.

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

Chapter 16: BGP

show ip bgp ipv4 unicast

show ip bgp ipv4 unicast

Displays information for IPv4 unicast BGP routes.

Syntax
show ip bgp ipv4 unicast [ipv4 | ipv4net [longer-prefixes] | summary]

Command Mode
Operational

Parameters

ipv4

Optional. Show BGP information for the specified address.

ipv4net

Optional. Show BGP information for the specified network.

longer-prefixes

Optional. Displays any routes more specific than the one specified.

summary

Optional. Displays summary IPv4 unicast route information.

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

Chapter 16: BGP

show ip bgp ipv4 unicast cidr-only

show ip bgp ipv4 unicast cidr-only

Displays IPv4 unicast BGP routes with CIDR network masks.

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

Chapter 16: BGP

show ip bgp ipv4 unicast community <community>

show ip bgp ipv4 unicast community <community>

Displays IPv4 unicast BGP routes belonging to the specified community.

Syntax
show ip bgp ipv4 unicast community community [exact-match]

Command Mode
Operational mode.

Parameters

community

Mandatory. A BGP community identifier in the form AA:NN (where

AA and NN are in the range of 0-65535), one of the well-known BGP
communities local-AS, no-export, or no-advertise, or a
space-separated list of up to four community identifiers.

exact-match

Optional. Displays only routes that have an 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

Chapter 16: BGP

show ip bgp ipv4 unicast community-list <list-name>

show ip bgp ipv4 unicast community-list <list-name>

Displays IPv4 unicast BGP routes permitted by the specified community list.

Syntax
show ip bgp ipv4 unicast community-list list-name [exact-match]

Command Mode
Operational mode.

Parameters

list-name

Mandatory. A preconfigured list of BGP communities.

exact-match

Optional. Displays routes that have an 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

Chapter 16: BGP

show ip bgp ipv4 unicast filter-list <list-num>

show ip bgp ipv4 unicast filter-list <list-num>

Displays IPv4 unicast BGP routes matching a filter list of autonomous system paths.

Syntax
show ip bgp ipv4 unicast filter-list list-num

Command Mode
Operational mode.

Parameters

list-num

Mandatory. The number of a preconfigured autonomous system path

access list. The range is 1 to 500.

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

Chapter 16: BGP

show ip bgp ipv4 unicast neighbors

show ip bgp ipv4 unicast neighbors

Displays information for IPv4 unicast BGP neighbors.

Syntax
show ip bgp ipv4 unicast neighbors [ipv4]

Command Mode
Operational mode.

Parameters

ipv4

Displays detailed information for the specified IPv4 unicast BGP

neighbor.

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

Chapter 16: BGP

show ip bgp ipv4 unicast neighbors <ipv4> advertised-routes

show ip bgp ipv4 unicast neighbors <ipv4>

advertised-routes
Displays advertised BGP IPv4 unicast routes for a BGP neighbor.

Syntax
show ip bgp ipv4 unicast neighbors ipv4 advertised-routes

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of an IPv4 unicast BGP neighbor.

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

Chapter 16: BGP

show ip bgp ipv4 unicast neighbors <ipv4> prefix-counts

show ip bgp ipv4 unicast neighbors <ipv4>

prefix-counts
Displays IPv4 unicast prefix-counts for a BGP neighbor.

Syntax
show ip bgp ipv4 unicast neighbors ipv4 prefix-counts

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of an IPv4 unicast BGP neighbor.

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

Chapter 16: BGP

show ip bgp ipv4 unicast neighbors <ipv4> received prefix-filter

show ip bgp ipv4 unicast neighbors <ipv4> received

prefix-filter
Displays the IPv4 unicast prefix-lists received from a BGP neighbor.

Syntax
show ip bgp ipv4 unicast neighbors ipv4 received prefix-filter

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of an IPv4 unicast BGP neighbor.

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

Chapter 16: BGP

show ip bgp ipv4 unicast neighbors <ipv4> received-routes

show ip bgp ipv4 unicast neighbors <ipv4>

received-routes
Displays the IPv4 unicast routes received from a BGP neighbor.

Syntax
show ip bgp ipv4 unicast neighbors ipv4 received-routes

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of an IPv4 unicast BGP neighbor.

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

Chapter 16: BGP

show ip bgp ipv4 unicast neighbors <ipv4> routes

show ip bgp ipv4 unicast neighbors <ipv4> routes

Displays IPv4 unicast received and accepted routes from a BGP neighbor.

Syntax
show ip bgp ipv4 unicast neighbors ipv4 routes

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of an IPv4 unicast BGP neighbor.

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

Chapter 16: BGP

show ip bgp ipv4 unicast paths

show ip bgp ipv4 unicast paths

Displays BGP IPv4 unicast path information.

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

Chapter 16: BGP

show ip bgp ipv4 unicast prefix-list <list-name>

show ip bgp ipv4 unicast prefix-list <list-name>

Displays IPv4 unicast BGP routes matching a prefix list.

Syntax
show ip bgp ipv4 unicast prefix-list list-name

Command Mode
Operational mode.

Parameters

list-name

Mandatory. Name of a defined prefix list.

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

Chapter 16: BGP

show ip bgp ipv4 unicast regexp <regexp>

show ip bgp ipv4 unicast regexp <regexp>

Displays IPv4 unicast BGP routes matching an AS path regular expression.

Syntax
show ip bgp ipv4 unicast regexp regexp

Command Mode
Operational mode.

Parameters

regexp

Mandatory. A POSIX-style regular expression representing a set of AS

paths.

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

Chapter 16: BGP

show ip bgp ipv4 unicast route-map <map-name>

show ip bgp ipv4 unicast route-map <map-name>

Displays IPv4 unicast BGP routes matching a route map.

Syntax
show ip bgp ipv4 unicast route-map map-name

Command Mode
Operational mode.

Parameters

map-name

Mandatory. Name of a defined route map.

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

Chapter 16: BGP

show ip bgp ipv4 unicast rsclient summary

show ip bgp ipv4 unicast rsclient summary

Displays IPv4 unicast BGP route server client summary information.

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

Chapter 16: BGP

show ip bgp ipv4 unicast statistics

show ip bgp ipv4 unicast statistics

Displays statistics for BGP IPv4 unicast routes.

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

Chapter 16: BGP

show ip bgp memory

show ip bgp memory

Displays memory usage for BGP.

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

Chapter 16: BGP

show ip bgp neighbors

show ip bgp neighbors

Displays BGP neighbor information.

Syntax
show ip bgp neighbors [ipv4]

Command Mode
Operational mode.

Parameters

ipv4

Optional. The IP address of a BGP neighbor.

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

Chapter 16: BGP

show ip bgp neighbors <ipv4> advertised-routes

show ip bgp neighbors <ipv4> advertised-routes

Displays advertised routes for a BGP neighbor.

Syntax
show ip bgp neighbors ipv4 advertised-routes

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of a BGP neighbor.

Default
None.

Usage Guidelines
Use this command to display advertised routes for a BGP neighbor.

Command Reference

Rel VC4.1 v. 03

Vyatta

125

Chapter 16: BGP

show ip bgp neighbors <ipv4> dampened-routes

show ip bgp neighbors <ipv4> dampened-routes

Displays dampened routes to a BGP neighbor.

Syntax
show ip bgp neighbors ipv4 dampened-routes

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of a BGP neighbor.

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

Chapter 16: BGP

show ip bgp neighbors <ipv4> flap-statistics

show ip bgp neighbors <ipv4> flap-statistics

Displays route flap statistics for routes learned from a BGP neighbor.

Syntax
show ip bgp neighbors ipv4 flap-statistics

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of a BGP neighbor.

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

Chapter 16: BGP

show ip bgp neighbors <ipv4> prefix-counts

show ip bgp neighbors <ipv4> prefix-counts

Displays prefix counts for a BGP neighbor.

Syntax
show ip bgp neighbors ipv4 prefix-counts

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of a BGP neighbor.

Default
None.

Usage Guidelines
Use this command to display prefix counts for a BGP neighbor.

Command Reference

Rel VC4.1 v. 03

Vyatta

125

Chapter 16: BGP

show ip bgp neighbors <ipv4> received prefix-filter

show ip bgp neighbors <ipv4> received prefix-filter

Displays prefix lists received from a BGP neighbor.

Syntax
show ip bgp neighbors ipv4 received prefix-filter

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of a BGP neighbor.

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

Chapter 16: BGP

show ip bgp neighbors <ipv4> received-routes

show ip bgp neighbors <ipv4> received-routes

Displays routes received from a BGP neighbor.

Syntax
show ip bgp neighbors ipv4 received-routes

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of a BGP neighbor.

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

Chapter 16: BGP

show ip bgp neighbors <ipv4> routes

show ip bgp neighbors <ipv4> routes

Displays all received and accepted routes from a BGP neighbor.

Syntax
show ip bgp neighbors ipv4 routes

Command Mode
Operational mode.

Parameters

ipv4

Mandatory. The IP address of a BGP neighbor.

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

Chapter 16: BGP

show ip bgp paths

show ip bgp paths

Displays all BGP paths.

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

Chapter 16: BGP

show ip bgp prefix-list <list-name>

show ip bgp prefix-list <list-name>

Displays BGP routes matching a prefix list.

Syntax
show ip bgp prefix-list list-name

Command Mode
Operational mode.

Parameters

list-name

Mandatory. Name of a defined prefix list.

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

Chapter 16: BGP

show ip bgp regexp <regexp>

show ip bgp regexp <regexp>

Displays routes matching an AS path regular expression.

Syntax
show ip bgp regexp regexp

Command Mode
Operational mode.

Parameters

regexp

Mandatory. A POSIX-style regular expression representing a set of

AS paths.

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

Chapter 16: BGP

show ip bgp route-map <map-name>

show ip bgp route-map <map-name>

Displays routes matching a route map.

Syntax
show ip bgp route-map map-name

Command Mode
Operational mode.

Parameters

map-name

Optional. The name of a defined route map.

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

Chapter 16: BGP

show ip bgp rsclient <address>

show ip bgp rsclient <address>

Displays BGP route server client information.

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

Optional. Displays summary information for all route server clients.

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

Chapter 16: BGP

show ip bgp scan

show ip bgp scan

Displays BGP scan status.

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

Chapter 16: BGP

show ip bgp view <view-name>

show ip bgp view <view-name>

Displays BGP information for a view in a BGP route server.

Syntax
show ip bgp view view-name [ipv4 | ipv4net | summary]

Command Mode
Operational mode.

Parameters

view-name

Mandatory. The name of a view (routing table) in a BGP route server.

ipv4

Optional. Show BGP information for the specified address.

ipv4net

Optional. Show BGP information for the specified network.

summary

Optional. Shows summary information for the specified view.

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

Chapter 16: BGP

show ip bgp view <view-name> ipv4 unicast rsclient summary

show ip bgp view <view-name> ipv4 unicast rsclient

summary
Displays IPv4 unicast route server client summary information for a view in a BGP route
server.

Syntax
show ip bgp view view-name ipv4 unicast rsclient summary

Command Mode
Operational mode.

Parameters

view-name

Mandatory. The name of a view (routing table) in a BGP route server.

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

Chapter 16: BGP

show ip bgp view <view-name> ipv4 unicast summary

show ip bgp view <view-name> ipv4 unicast summary

Displays IPv4 unicast summary information for a view in a BGP route server.

Syntax
show ip bgp view view-name ipv4 unicast summary

Command Mode
Operational mode.

Parameters

view-name

Mandatory. The name of a view (routing table) in a BGP route server.

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

Chapter 16: BGP

show ip bgp view <view-name> neighbors

show ip bgp view <view-name> neighbors

Displays BGP neighbor information for a viewn in a BGP route server.

Syntax
show ip bgp view view-name neighbors [ipv4]

Command Mode
Operational mode.

Parameters

view-name

Mandatory. The name of a view (routing table) in a BGP route server.

ipv4

Optional. Displays information about the neighbor at the specified IPv4

address.

ipv6

Optional. Displays information about the neighbor at the specified IPv6

address.

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

Chapter 16: BGP

show ip bgp view <view-name> rsclient

show ip bgp view <view-name> rsclient

Displays BGP route server client information for a view in a BGP route server.

Syntax
show ip bgp view view-name rsclient {ipv4 | ipv6 | ipv4net| | summary}

Command Mode
Operational mode.

Parameters

view-name

Mandatory. The name of a view (routing table) in a BGP route server.

ipv4

Displays route server client information for the specified IPv4 neighbor.

ipv6

Displays route server client information for the specified IPv6 neighbor.

ipv4net

Displays information for all route server clients on the specified

network.

summary

Shows summary route server client information.

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

Chapter 16: BGP

show ip route bgp

show ip route bgp

Displays BGP routes.

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>*

10.1.0.0/24 [20/75] via 10.1.0.4 inactive, 1d00h46m

10.100.100.4/32 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h46m
10.104.104.4/32 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h46m
172.16.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.1.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.2.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.3.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.4.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.5.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.6.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
172.20.7.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m

Command Reference

Rel VC4.1 v. 03

Vyatta

127

Chapter 16: BGP

show ip route bgp

B>* 172.20.8.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m

B>* 172.20.9.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.21.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.22.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.23.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.24.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.25.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.26.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.27.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.28.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 172.29.0.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 1d00h36m
B>* 192.168.3.0/24 [20/75] via 10.1.0.4 (recursive via 10.3.0.1), 05:15:56
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

127

1276

Chapter 17: Routing Policies

This chapter lists the commands you can use to create routing policies.
This chapter contains the following commands.
Command

Description

Access List Configuration Commands

policy access-list <list-num>

Defines an access list.

policy access-list <list-num> description <desc>

Allows you to specify a brief description for an

access list.

policy access-list <list-num> rule <rule-num>

Creates a rule for an access list.

policy access-list <list-num> rule <rule-num> action

Specifies the action to be taken for packets

matching an access list rule.

policy access-list <list-num> rule <rule-num> description

<desc>

Allows you to specify a brief description for an

access list rule.

policy access-list <list-num> rule <rule-num> destination

Defines match criteria for an access list rule based

on destination.

policy access-list <list-num> rule <rule-num> source

Defines match criteria for an access list rule based

on source.

Chapter 17: Routing Policies

127

Command

Description

AS Path List Configuration Commands

policy as-path-list <list-name>

Defines an autonomous system (AS) path list.

policy as-path-list <list-name> description <desc>

Allows you to specify a brief description for an AS

path list.

policy as-path-list <list-name> rule <rule-num>

Creates a rule for an AS path list.

policy as-path-list <list-name> rule <rule-num> action

Specifies the action to be taken for packets

matching an AS path list rule.

policy as-path-list <list-name> rule <rule-num> description

<desc>

Allows you to specify a brief description for an AS

path list rule.

policy as-path-list <list-name> rule <rule-num> regex

<regex>

Defines match criteria for an AS path list rule based

on a regular expression.

Community List Configuration Commands

policy community-list <list-num>

Defines a BGP community list.

policy community-list <list-num> description <desc>

Allows you to specify a brief description for a

community list.

policy community-list <list-num> rule <rule-num>

Creates a rule for a community list.

policy community-list <list-num> rule <rule-num> action

Specifies the action to be taken for packets

matching a community list rule.

policy community-list <list-num> rule <rule-num>

description <desc>

Allows you to specify a brief description for a

community list rule.

policy community-list <list-num> rule <rule-num> regex

<regex>

Defines match criteria for a community list rule

based on a regular expression.

Prefix List Configuration Commands

policy prefix-list <list-name>

Defines a prefix list.

policy prefix-list <list-name> description <desc>

Allows you to specify a brief description for a prefix

list.

policy prefix-list <list-name> rule <rule-num>

Creates a rule for a prefix list.

policy prefix-list <list-name> rule <rule-num> action

Specifies the action to be taken for packets

matching a prefix list rule.

policy prefix-list <list-name> rule <rule-num> description

<desc>

Allows you to specify a brief description for a prefix

list rule.

policy prefix-list <list-name> rule <rule-num> ge <value>

Defines match criteria for a prefix list rule based on

a greater-than-or-equal-to numeric comparison.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 17: Routing Policies

127

Command

Description

policy prefix-list <list-name> rule <rule-num> le <value>

Defines a match criterion based on a

less-than-or-equal-to numeric comparison for a
prefix list rule.

policy prefix-list <list-name> rule <rule-num> prefix

<ipv4net>

Defines match criteria for a prefix list rule based on

an IPv4 network.

Route Map Configuration Commands

policy route-map <map-name>

Defines a route map for policy-based routing.

policy route-map <map-name> description <desc>

Allows you to specify a brief description for a route

map.

policy route-map <map-name> rule <rule-num>

Creates a rule for a route map.

policy route-map <map-name> rule <rule-num> action

Specifies the action to be taken for packets

matching a route map rule.

policy route-map <map-name> rule <rule-num> call

<target>

Calls to another route map.

policy route-map <map-name> rule <rule-num> continue

<target-num>

Calls to another rule within the current route map.

policy route-map <map-name> rule <rule-num> description

<desc>

Allows you to specify a brief description for a route

map rule.

policy route-map <map-name> rule <rule-num> match

as-path <list-name>

Defines a match condition for a route map based on

an AS path list

policy route-map <map-name> rule <rule-num> match

community

Defines a match condition for a route map based on

BGP communities.

policy route-map <map-name> rule <rule-num> match

interface <ethx>

Defines a match condition for a route map based on

the first-hop interface.

policy route-map <map-name> rule <rule-num> match ip

address

Defines a match condition for a route map based on

IP address.

policy route-map <map-name> rule <rule-num> match ip

nexthop

Defines a match condition for a route map based on

the next-hop address.

policy route-map <map-name> rule <rule-num> match ip

route-source

Defines a match condition for a route map based on

the address from where a route is advertised.

policy route-map <map-name> rule <rule-num> match

metric <metric>

Defines a match condition for a route map based on

the routes metric.

policy route-map <map-name> rule <rule-num> match

origin

Defines a match condition for a route map based on

the routes origin.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 17: Routing Policies

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>

Defines a match condition for a route map based on

OSPF tag.

policy route-map <map-name> rule <rule-num> on-match

Specifies an alternative exit policy for a route map.

policy route-map <map-name> rule <rule-num> set

aggregator

Modifies the BGP aggregator attribute of a route.

policy route-map <map-name> rule <rule-num> set

as-path-prepend <prepend>

Sets or prepends to the AS path of the route.

policy route-map <map-name> rule <rule-num> set

atomic-aggregate

Sets the BGP atomic-aggregate attribute in a route.

policy route-map <map-name> rule <rule-num> set

comm-list

Modifies the BGP community list in a route.

policy route-map <map-name> rule <rule-num> set

community

Modifies the BGP communities attribute in a route.

policy route-map <map-name> rule <rule-num> set

ip-next-hop <ipv4>

Modifies the next hop destination of a route.

policy route-map <map-name> rule <rule-num> set

local-preference <local-pref>

Modifies the BGP local-pref attribute in a route.

policy route-map <map-name> rule <rule-num> set metric

<metric>

Modifies the metric of a route.

policy route-map <map-name> rule <rule-num> set

metric-type <type>

Specifies the OSPF external metric-type for a route.

policy route-map <map-name> rule <rule-num> set

metric-type <type>

Modifies the BGP origin code of a route.

policy route-map <map-name> rule <rule-num> set

originator-id <ipv4>

Modifies the BGP originator ID attribute of a route.

policy route-map <map-name> rule <rule-num> set tag

<tag>

Modifies the OSPF tag value of a route.

policy route-map <map-name> rule <rule-num> set weight

<weight>

Modifies the BGP weight of a route.

Operational Commands
show ip access-list

Displays all IP access lists.

show ip as-path-access-list

Displays all as-path access lists.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 17: Routing Policies

128

Command

Description

show ip community-list

Displays all IP community lists.

show ip extcommunity-list

Displays all extended IP community lists.

show ip prefix-list

Displays IP prefix lists.

show ip protocol

Displays IP route maps per protocol.

show route-map

Displays route map information.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 17: Routing Policies

policy access-list <list-num>

policy access-list <list-num>

Defines an access list.

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

Mandatory. Multi-node. A numeric identifier for the access list.

Access list numbers can take the following values:
1 to 99: IP standard access list
100 to 199: IP extended access list
1300 to 1999: IP standard access list (expanded range)
2000 to 2699: IP extended access list (expanded range)
You can create multiple access lists by creating multiple policy
access-list configuration nodes.

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

Chapter 17: Routing Policies

policy access-list <list-num> description <desc>

policy access-list <list-num> description <desc>

Allows you to specify a brief description for an access list.

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

Mandatory. The number of a defined access list.

desc

Mandatory. A brief text description for the access list.

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

Chapter 17: Routing Policies

policy access-list <list-num> rule <rule-num>

policy access-list <list-num> rule <rule-num>

Creates a rule for an access list.

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

Mandatory. The number of a defined access list.

rule-num

Mandatory. Multi-node. A numeric identifier for the rule. The range is

1 to 4294967295.
You can define multiple rules by creating multiple rule configuration
nodes.

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

Chapter 17: Routing Policies

policy access-list <list-num> rule <rule-num> action

policy access-list <list-num> rule <rule-num> action

Specifies the action to be taken for packets matching an access list rule.

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

Mandatory. The number of a defined access list.

rule-num

Mandatory. The number of a defined access list rule.

deny

Optional. Packets matching this rule are silently dropped.

permit

Optional. Packets matching this rule are forwarded.

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

Chapter 17: Routing Policies

policy access-list <list-num> rule <rule-num> action

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

Chapter 17: Routing Policies

policy access-list <list-num> rule <rule-num> description <desc>

policy access-list <list-num> rule <rule-num> description

<desc>
Allows you to specify a brief description for an access list rule.

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

Mandatory. The number of a defined access list.

rule-num

Mandatory. The number of a defined access list rule.

desc

Mandatory. A brief text description for the access list rule.

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

Chapter 17: Routing Policies

policy access-list <list-num> rule <rule-num> destination

policy access-list <list-num> rule <rule-num>

destination
Defines match criteria for an access list rule based on destination.

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

Mandatory. The number of a defined access list.

rule-num

Mandatory. The number of a defined access list.

any

Match packets destined for any destination. Exactly one of any,

host, inverse-mask, and network is mandatory.

host ipv4

Match packets destined for the specified IPv4 host. Exactly one
of any, host, inverse-mask, and network is mandatory.

inverse-mask ipv4

Match packets destined for the network specified by the mask.

Exactly one of any, host, inverse-mask, and network is
mandatory.

Rel VC4.1 v. 03

Vyatta

128

Chapter 17: Routing Policies

network ipv4net

policy access-list <list-num> rule <rule-num> destination

Match packets coming from the specified network. The format

is ip-address/prefix. Exactly one of any, host, inverse-mask,
and network is mandatory.

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

Chapter 17: Routing Policies

policy access-list <list-num> rule <rule-num> source

policy access-list <list-num> rule <rule-num> source

Defines match criteria for an access list rule based on source.

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

Mandatory. The number of a defined access list.

rule-num

Mandatory. The number of a defined access list rule.

any

Match packets coming from any source. Exactly one of any,

host, inverse-mask, and network is mandatory.

host ipv4

Match packets coming from the specified IPv4 host. Exactly

one of any, host, inverse-mask, and network is mandatory.

inverse-mask ipv4

Match packets coming from the network specified by the mask.

Exactly one of any, host, inverse-mask, and network is
mandatory.

Rel VC4.1 v. 03

Vyatta

128

Chapter 17: Routing Policies

network ipv4net

policy access-list <list-num> rule <rule-num> source

Match packets coming from the specified network. The format

is ip-address/prefix. Exactly one of any, host, inverse-mask,
and network is mandatory.

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

Chapter 17: Routing Policies

policy as-path-list <list-name>

policy as-path-list <list-name>

Defines an autonomous system (AS) path list.

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

Mandatory. Multi-node.A text identifier for the AS path list.

You can create multiple AS path lists by creating multiple policy
as-path-list configuration nodes.

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

Chapter 17: Routing Policies

policy as-path-list <list-name> description <desc>

policy as-path-list <list-name> description <desc>

Allows you to specify a brief description for an AS path list.

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

Mandatory. The name of a defined AS path list.

desc

Mandatory. A brief text description for the AS path list.

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

Chapter 17: Routing Policies

policy as-path-list <list-name> rule <rule-num>

policy as-path-list <list-name> rule <rule-num>

Creates a rule for an AS path list.

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

Mandatory. The name of a defined AS path list.

rule-num

Mandatory. Multi-node. A numeric identifier for the rule. The range is

1 to 4294967295.
You can define multiple rules by creating multiple rule configuration
nodes.

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

Chapter 17: Routing Policies

policy as-path-list <list-name> rule <rule-num> action

policy as-path-list <list-name> rule <rule-num> action

Specifies the action to be taken for packets matching an AS path list rule.

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

Mandatory. The name of a defined AS path list.

rule-num

Mandatory. The number of a defined AS path list rule.

deny

Optional. Packets matching this rule are silently dropped.

permit

Optional. Packets matching this rule are forwarded.

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

Chapter 17: Routing Policies

policy as-path-list <list-name> rule <rule-num> action

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

Chapter 17: Routing Policies

policy as-path-list <list-name> rule <rule-num> description <desc>

policy as-path-list <list-name> rule <rule-num>

description <desc>
Allows you to specify a brief description for an AS path list rule.

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

Mandatory. The name of a defined AS path list.

rule-num

Mandatory. The number of a defined AS path list rule.

desc

Mandatory. A brief text description for the AS path list rule.

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

Chapter 17: Routing Policies

policy as-path-list <list-name> rule <rule-num> regex <regex>

policy as-path-list <list-name> rule <rule-num> regex

<regex>
Defines match criteria for an AS path list rule based on a regular expression.

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

Mandatory. The name of a defined AS path list.

rule-num

Mandatory. The number of a defined AS path list rule.

regex

Mandatory. A POSIX-style regular expression representing an AS

path list.

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

Chapter 17: Routing Policies

policy as-path-list <list-name> rule <rule-num> regex <regex>

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

Chapter 17: Routing Policies

policy community-list <list-num>

policy community-list <list-num>

Defines a BGP community list.

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

Mandatory. Multi-node. A numeric identifier for the community list.

You can create multiple community lists by creating multiple policy
community-list configuration nodes.

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

Chapter 17: Routing Policies

policy community-list <list-num> description <desc>

policy community-list <list-num> description <desc>

Allows you to specify a brief description for a community list.

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

Mandatory. The number of a defined community list.

desc

Mandatory. A brief text description for the community list.

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

Chapter 17: Routing Policies

policy community-list <list-num> rule <rule-num>

policy community-list <list-num> rule <rule-num>

Creates a rule for a community list.

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

Mandatory. The number of a defined community list.

rule-num

Mandatory. Multi-node. A numeric identifier for the rule. The range is

1 to 4294967295.
You can define multiple rules by creating multiple rule configuration
nodes.

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

Chapter 17: Routing Policies

policy community-list <list-num> rule <rule-num> action

policy community-list <list-num> rule <rule-num>

action
Specifies the action to be taken for packets matching a community list rule.

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

Mandatory. The number of a defined community list.

rule-num

Mandatory. The number of a defined community list rule.

deny

Optional. Packets matching this rule are silently dropped.

permit

Optional. Packets matching this rule are forwarded.

Default
Packets matching this rule are forwarded.

Command Reference

Rel VC4.1 v. 03

Vyatta

130

Chapter 17: Routing Policies

policy community-list <list-num> rule <rule-num> action

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

Chapter 17: Routing Policies

policy community-list <list-num> rule <rule-num> description <desc>

policy community-list <list-num> rule <rule-num>

description <desc>
Allows you to specify a brief description for a community list rule.

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

Mandatory. The number of a defined community list.

rule-num

Mandatory. The number of a defined community list rule.

desc

Mandatory. A brief text description for the community list rule.

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

Chapter 17: Routing Policies

policy community-list <list-num> rule <rule-num> regex <regex>

policy community-list <list-num> rule <rule-num> regex

<regex>
Defines match criteria for a community list rule based on a regular expression.

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

Mandatory. The number of a defined community list.

rule-num

Mandatory. The number of a defined community list rule.

regex

Mandatory. A POSIX-style regular expression representing a BGP

community list.

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

Chapter 17: Routing Policies

policy community-list <list-num> rule <rule-num> regex <regex>

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

Chapter 17: Routing Policies

policy prefix-list <list-name>

policy prefix-list <list-name>

Defines a prefix list.

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

Mandatory. Multi-node. A text identifier for the prefix list.

You can create multiple prefix lists by creating multiple policy
prefix-list configuration nodes.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> description <desc>

policy prefix-list <list-name> description <desc>

Allows you to specify a brief description for a prefix list.

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

Mandatory. The name of a defined prefix list.

desc

Mandatory. A brief text description for the prefix list.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num>

policy prefix-list <list-name> rule <rule-num>

Creates a rule for a prefix list.

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

Mandatory. The name of a defined prefix list.

rule-num

Mandatory. Multi-node. A numeric identifier for the rule. The range is

1 to 4294967295.
You can define multiple rules by creating multiple rule configuration
nodes.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> action

policy prefix-list <list-name> rule <rule-num> action

Specifies the action to be taken for packets matching a prefix list rule.

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

Mandatory. The name of a defined prefix list.

rule-num

Mandatory. The number of a defined prefix list rule.

deny

Optional. Packets matching this rule are silently dropped.

permit

Optional. Packets matching this rule are forwarded.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> action

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> description <desc>

policy prefix-list <list-name> rule <rule-num>

description <desc>
Allows you to specify a brief description for a prefix list rule.

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

Mandatory. The name of a defined prefix list.

rule-num

Mandatory. The number of a defined prefix list rule.

desc

Mandatory. A brief text description for the prefix list rule.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> ge <value>

policy prefix-list <list-name> rule <rule-num> ge

<value>
Defines match criteria for a prefix list rule based on a greater-than-or-equal-to numeric
comparison.

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

Mandatory. The name of a defined prefix list.

rule-num

Mandatory. The number of a defined prefix list rule.

value

Mandatory. A number representing a network prefix. Network

prefixes greater than or equal to this number will match this rule. The
range of values is 0 to 32.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> ge <value>

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> le <value>

policy prefix-list <list-name> rule <rule-num> le <value>

Defines a match criterion based on a less-than-or-equal-to numeric comparison for a
prefix list rule.

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

Mandatory. The name of a defined prefix list.

rule-num

Mandatory. The number of a defined prefix list rule.

value

Mandatory. A number representing a network prefix. Network

prefixes less than or equal to this number will match this rule. The
range of values is 0 to 32.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> le <value>

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> prefix <ipv4net>

policy prefix-list <list-name> rule <rule-num> prefix

<ipv4net>
Defines match criteria for a prefix list rule based on an IPv4 network.

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

Mandatory. The name of a defined prefix list.

rule-num

Mandatory. The number of a defined prefix list rule.

ipv4net

Mandatory. An IPv4 network. Networks exactly matching this

network will match this rule. The format is ip-address/prefix.

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

Chapter 17: Routing Policies

policy prefix-list <list-name> rule <rule-num> prefix <ipv4net>

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

Chapter 17: Routing Policies

policy route-map <map-name>

policy route-map <map-name>

Defines a route map for policy-based routing.

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

Mandatory. Multi-node. A text identifier for the route map.

You can create multiple route maps by creating multiple policy
route-map configuration nodes.

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

Chapter 17: Routing Policies

policy route-map <map-name> description <desc>

policy route-map <map-name> description <desc>

Allows you to specify a brief description for a route map.

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

Mandatory. The name of a defined route map.

desc

Mandatory. A brief text description for the route map.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num>

policy route-map <map-name> rule <rule-num>

Creates a rule for a route map.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. Multi-node. A numeric identifier for the rule. The range is

1 to 4294967295.
You can define multiple rules by creating multiple rule configuration
nodes.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> action

policy route-map <map-name> rule <rule-num> action

Specifies the action to be taken for packets matching a route map rule.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

deny

Optional. Packets matching this rule are silently dropped.

permit

Optional. Packets matching this rule are forwarded.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> action

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> call <target>

policy route-map <map-name> rule <rule-num> call

<target>
Calls to another route map.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

target

Mandatory. The identifier of the route map being called.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> continue <target-num>

policy route-map <map-name> rule <rule-num>

continue <target-num>
Calls to another rule within the current route map.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

target

Mandatory. The identifier of the route map rule being called.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> description <desc>

policy route-map <map-name> rule <rule-num>

description <desc>
Allows you to specify a brief description for a route map rule.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

desc

Mandatory. A brief text description for the route map rule.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match as-path <list-name>

policy route-map <map-name> rule <rule-num> match

as-path <list-name>
Defines a match condition for a route map based on an AS path list

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

list-name

Mandatory. Matches the AS paths in the route with those permitted by

the specified AS path list. The AS path list must already be defined.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match as-path <list-name>

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match community

policy route-map <map-name> rule <rule-num> match

community
Defines a match condition for a route map based on BGP communities.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

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

BGP communities are to be matched exactly. Either community-list

or exact-match must be specified.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match community

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match interface <ethx>

policy route-map <map-name> rule <rule-num> match

interface <ethx>
Defines a match condition for a route map based on the first-hop interface.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

ethx

Mandatory. Matches first hop interface specified in the route against

the interface name.

Default
If no interface match condition is specified, packets are not filtered by interface.

Command Reference

Rel VC4.1 v. 03

Vyatta

133

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match interface <ethx>

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match ip address

policy route-map <map-name> rule <rule-num> match

ip address
Defines a match condition for a route map based on IP address.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

access-list
list-num

Matches the source or destination IP address of the route against those

permitted by the specified access list. The access list must already be
defined. Either access-list or prefix-list must be specified.

prefix-list
list-name

Matches the source or destination network of the route against those

permitted by the specified prefix list. The prefix list must already be
defined. Either access-list or prefix-list must be specified.

Rel VC4.1 v. 03

Vyatta

133

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match ip address

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match ip nexthop

policy route-map <map-name> rule <rule-num> match

ip nexthop
Defines a match condition for a route map based on the next-hop address.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

access-list list-num

Matches the next-hop IP address in the route against those

permitted by the specified access list. The access list must
already be defined. Either access-list or prefix-list must be
specified.

Rel VC4.1 v. 03

Vyatta

133

Chapter 17: Routing Policies

prefix-list list-name

policy route-map <map-name> rule <rule-num> match ip nexthop

Matches next-hop IP address in the route against those

permitted by the specified prefix list. The prefix list must
already be defined. Either access-list or prefix-list must be
specified.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match ip route-source

policy route-map <map-name> rule <rule-num> match

ip route-source
Defines a match condition for a route map based on the address from where a route is
advertised.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

access-list list-num

Matches routes advertised from addresses contained in the

specified access list. The access list must already be defined.
Either access-list or prefix-list must be specified.

prefix-list list-name

Matches routes advertised from addresses contained in the

specified prefix list. The prefix list must already be defined.
Either access-list or prefix-list must be specified.

Rel VC4.1 v. 03

Vyatta

133

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match ip route-source

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match metric <metric>

policy route-map <map-name> rule <rule-num> match

metric <metric>
Defines a match condition for a route map based on the routes metric.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

metric

Mandatory. A number representing a route metric. This value is

matched against the metric in the route.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match metric <metric>

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match origin

policy route-map <map-name> rule <rule-num> match

origin
Defines a match condition for a route map based on the routes origin.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

egp:

Matches routes whose origin is an Exterior Gateway Protocol.

igp:

Matches routes whose origin is an Interior Gateway Protocol.

incomplete

Matches routes whose BGP origin code is 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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match origin

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match peer <ipv4>

policy route-map <map-name> rule <rule-num> match

peer <ipv4>
Defines a match condition for a route map based on peer IP address.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

ipv4

Mandatory. An IPv4 address. This address is matched against

the peer address in the route.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match peer <ipv4>

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match tag <tag>

policy route-map <map-name> rule <rule-num> match

tag <tag>
Defines a match condition for a route map based on OSPF tag.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

tag

Mandatory. A 32-bit value representing an OSPF tag. This value is

matched against the contents of the OSPF external Link-State
Advertisement (LSA) 32-bit tag field in the route.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> match tag <tag>

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> on-match

policy route-map <map-name> rule <rule-num>

on-match
Specifies an alternative exit policy for a route map.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> on-match

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set aggregator

policy route-map <map-name> rule <rule-num> set

aggregator
Modifies the BGP aggregator attribute of a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

as asn

Modifies the autonomous system number of the BGP aggregator in the

route to the specified value. The range is 1 to 65535.

ip ipv4

Modifies the IP address of the BGP aggregator in the route to the

specified IPv4 address.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

134

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set aggregator

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set as-path-prepend <prepend>

policy route-map <map-name> rule <rule-num> set

as-path-prepend <prepend>
Sets or prepends to the AS path of the route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

prepend

Mandatory. A string representing an AS path.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set atomic-aggregate

policy route-map <map-name> rule <rule-num> set

atomic-aggregate
Sets the BGP atomic-aggregate attribute in a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set comm-list

policy route-map <map-name> rule <rule-num> set

comm-list
Modifies the BGP community list in a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

comm-list list-name

Removes the communities in the specified community list from

the routes community list. The community list must already be
defined.

delete

Deletes the routes entire community list.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

135

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set comm-list

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set community

policy route-map <map-name> rule <rule-num> set

community
Modifies the BGP communities attribute in a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

community

A BGP community. Supported values are a community number

in aa:nn format, or the well-known BGP communities
local-AS, no-export, no-advertise, or internet.

additive

Appends the specified community to the existing communities

in the route.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set community

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set ip-next-hop <ipv4>

policy route-map <map-name> rule <rule-num> set

ip-next-hop <ipv4>
Modifies the next hop destination of a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

ip-next-hop ipv4

Mandatory. The IPv4 address of the next hop.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set local-preference <local-pref>

policy route-map <map-name> rule <rule-num> set

local-preference <local-pref>
Modifies the BGP local-pref attribute in a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

local-pref

Mandatory. The new value for the BGP local preference

path attribute.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set metric <metric>

policy route-map <map-name> rule <rule-num> set

metric <metric>
Modifies the metric of a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

metric

Mandatory. A number representing the new metric to be used in the

route.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set metric-type <type>

policy route-map <map-name> rule <rule-num> set

metric-type <type>
Specifies the OSPF external metric-type for a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set metric-type <type>

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set origin

policy route-map <map-name> rule <rule-num> set

origin
Modifies the BGP origin code of a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

asn

An autonomous system number. The range is 1 to 65535.

egp

Sets the BGP origin code to egp (Exterior Gateway Protocol).

igp

Sets the BGP origin code to igp (Interior Gateway Protocol).

incomplete

Sets the BGP origin code to incomplete.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

136

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set origin

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set originator-id <ipv4>

policy route-map <map-name> rule <rule-num> set

originator-id <ipv4>
Modifies the BGP originator ID attribute of a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

ipv4

Mandatory. The IPv4 address to be used as the new

originator ID.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set tag <tag>

policy route-map <map-name> rule <rule-num> set tag

<tag>
Modifies the OSPF tag value of a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

tag

Mandatory. A 32-bit number representing the new value of the OSPF

external Link-State Advertisement (LSA) tag field.

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

Chapter 17: Routing Policies

policy route-map <map-name> rule <rule-num> set weight <weight>

policy route-map <map-name> rule <rule-num> set

weight <weight>
Modifies the BGP weight of a route.

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

Mandatory. The name of a defined route map.

rule-num

Mandatory. The number of a defined route map rule.

weight

Mandatory. The BGP weight to be recorded in the routing table. The

range is 0 to 65535.

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

Chapter 17: Routing Policies

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

vyatta@vyatta:~$ show ip access-list

ZEBRA:
Standard IP access list 1
permit any
RIP:
Standard IP access list 1
permit any
OSPF:
Standard IP access list 1
permit any
BGP:
Standard IP access list 1
permit any
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

136

Chapter 17: Routing Policies

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

vyatta@vyatta:~$ show ip as-path-access-list

AS path access list IN
permit 50:1
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

136

Chapter 17: Routing Policies

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

vyatta@vyatta:~$ show ip community-list

Community (expanded) access list 101
permit AB*
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

136

Chapter 17: Routing Policies

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

vyatta@vyatta:~$ show ip extcommunity-list

Community (expanded) access list 101
permit AB*
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

137

Chapter 17: Routing Policies

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

Displays detailed information for all IP prefix lists.

summary

Displays summary information for all IP prefix lists.

list-name

Displays information about the named IP prefix list.

seq-num

Displays the specified sequence from the named IP prefix list.

ipv4net

Displays the select prefix of the named IP prefix list.

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

vyatta@vyatta:~$ show ip prefix-list

ZEBRA: ip prefix-list ABC: 1 entries

Command Reference

Rel VC4.1 v. 03

Vyatta

137

Chapter 17: Routing Policies

show ip prefix-list

seq 1 permit 192.168.2.0/24 ge 25

RIP: ip prefix-list ABC: 1 entries
seq 1 permit 192.168.2.0/24 ge 25
OSPF: ip prefix-list ABC: 1 entries
seq 1 permit 192.168.2.0/24 ge 25
BGP: ip prefix-list ABC: 1 entries
seq 1 permit 192.168.2.0/24 ge 25
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

137

Chapter 17: Routing Policies

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

vyatta@vyatta:~$ show ip protocol

Protocol
: route-map
-----------------------system
: none
kernel
: none
connected
: none
static
: none
rip
: none
ripng
: none
ospf
: none
ospf6
: none
isis
: none
bgp
: none
hsls
: none
any
: none
vyatta@vyatta:~$

Command Reference

Rel VC4.1 v. 03

Vyatta

137

Chapter 17: Routing Policies

Command Reference

show ip protocol

Rel VC4.1 v. 03

Vyatta

137

Chapter 17: Routing Policies

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

vyatta@vyatta:~$ show route-map

ZEBRA:
route-map MAP1, permit, sequence 1
Match clauses:
Set clauses:
Call clause:
Action:
Exit routemap
RIP:
route-map MAP1, permit, sequence 1
Match clauses:
interface eth0
Set clauses:
Call clause:
Action:
Exit routemap

Command Reference

Rel VC4.1 v. 03

Vyatta

137

Chapter 17: Routing Policies

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

Chapter 18: Quality of Service Policies

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

QoS Interface Configuration Commands

interfaces ethernet <ethx> qos-policy out <policy-name>

Applies an outbound QoS policy to the specified

Ethernet interface.

interfaces ethernet <ethx> vif <vlan-id> qos-policy out

<policy-name>

Applies an outbound QoS policy to the specified

virtual interface.

Fair Queue Configuration Commands

qos-policy fair-queue <policy-name>

Defines a fair queue QoS policy.

qos-policy fair-queue <policy-name> description <desc>

Sets a description for a fair queue policy.

qos-policy fair-queue <policy-name> hash-interval

<seconds>

Specifies the interval between flow hash function

updates for a fair queue policy.

qos-policy fair-queue <policy-name> queue-limit <limit>

Sets an upper bound for the number of packets

allowed in the queue for a fair queue policy.

Chapter 18: Quality of Service Policies

137

Command

Description

Traffic Shaper General Configuration Commands

qos-policy traffic-shaper <policy-name>

Defines a traffic shaping QoS policy.

qos-policy traffic-shaper <policy-name> bandwidth

Specifies the bandwidth available for all combined

traffic constrained by this policy.

qos-policy traffic-shaper <policy-name> description <desc>

Specifies a description for a traffic shaper QoS

policy.

Traffic Shaper Class Configuration Commands

qos-policy traffic-shaper <policy-name> class <class>

Defines a traffic class for a traffic shaper QoS policy.

qos-policy traffic-shaper <policy-name> class <class>

bandwidth

Specifies the base guaranteed bandwidth rate for a

traffic class.

qos-policy traffic-shaper <policy-name> class <class> burst

Sets the burst size for a traffic class.

qos-policy traffic-shaper <policy-name> class <class> ceiling

Sets a bandwidth ceiling for a traffic class.

qos-policy traffic-shaper <policy-name> class <class>

description <desc>

Sets a description for a traffic class.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name>

Defines a traffic class matching rule.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name> description <desc>

Sets a description for a match rule.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name> interface <interface>

Specifies a match criterion based on incoming

interface.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name> ip destination

Specifies a match criterion based on IP destination

information.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name> ip dscp <value>

Specifies a match criterion based on the value of the

DSCP field.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name> ip protocol <proto>

Specifies a match criterion based on the IP protocol.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name> ip source

Specifies a match criterion based on source IP

information.

qos-policy traffic-shaper <policy-name> class <class> match

<match-name> vif <vlan-id>

Specifies a a match criterion based on VLAN ID.

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

Specifies the maximum queue size for a traffic class.

Rel VC4.1 v. 03

Vyatta

Chapter 18: Quality of Service Policies

137

Command

Description

qos-policy traffic-shaper <policy-name> class <class>

queue-type <type>

Specifies the type of queuing to use for a traffic

class.

qos-policy traffic-shaper <policy-name> class <class>

set-dscp <value>

Rewrites the DSCP field in packets in this traffic class

to the specified value.

Traffic Shaper Default Class Configuration Commands

qos-policy traffic-shaper <policy-name> default

Defines a default traffic shaper QoS policy.

qos-policy traffic-shaper <policy-name> default bandwidth

Specifies the base guaranteed bandwidth rate for

the default traffic class.

qos-policy traffic-shaper <policy-name> default burst

Sets the burst size for the default traffic class.

qos-policy traffic-shaper <policy-name> default ceiling

Sets a bandwidth ceiling for the default traffic class.

qos-policy traffic-shaper <policy-name> default priority

<priority>

Specifies the priority of the default traffic class for

allocation of extra bandwidth.

qos-policy traffic-shaper <policy-name> default queue-limit

<limit>

Specifies the maximum queue size for the default

traffic class.

qos-policy traffic-shaper <policy-name> default queue-type

<type>

Specifies the type of queuing to use for the default

traffic class.

qos-policy traffic-shaper <policy-name> default set-dscp

<value>

Rewrites the DSCP field in packets in the default

traffic class to the specified value.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 18: Quality of Service Policies

interfaces ethernet <ethx> qos-policy out <policy-name>

interfaces ethernet <ethx> qos-policy out

<policy-name>
Applies an outbound QoS policy to the specified Ethernet interface.

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

Mandatory. The name of an Ethernet interface.

policy-name

The name of the outbound QoS policy to apply to this interface.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

138

Chapter 18: Quality of Service Policies

interfaces ethernet <ethx> qos-policy out <policy-name>

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

Chapter 18: Quality of Service Policies

interfaces ethernet <ethx> vif <vlan-id> qos-policy out <policy-name>

interfaces ethernet <ethx> vif <vlan-id> qos-policy out

<policy-name>
Applies an outbound QoS policy to the specified virtual interface.

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

Mandatory. The name of an Ethernet interface.

vlan-id

Mandatory. The VLAN ID for the vif. The range is 0 to 4095.

policy-name

The name of the outbound QoS policy to apply to this interface.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

138

Chapter 18: Quality of Service Policies

interfaces ethernet <ethx> vif <vlan-id> qos-policy out <policy-name>

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

Chapter 18: Quality of Service Policies

qos-policy fair-queue <policy-name>

qos-policy fair-queue <policy-name>

Defines a fair queue QoS policy.

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

Mandatory. The name of the fair queue policy.

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

Chapter 18: Quality of Service Policies

qos-policy fair-queue <policy-name>

Use the set form of this command to create an FQ policy.

Use the delete form of this command to remove an FQ policy.
Use the show form of this command to display FQ policy configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

138

Chapter 18: Quality of Service Policies

qos-policy fair-queue <policy-name> description <desc>

qos-policy fair-queue <policy-name> description <desc>

Sets a description for a fair queue policy.

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

Mandatory. The name of the fair queue policy.

desc

Mandatory. The description for this fair queue policy.

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

Chapter 18: Quality of Service Policies

qos-policy fair-queue <policy-name> hash-interval <seconds>

qos-policy fair-queue <policy-name> hash-interval

<seconds>
Specifies the interval between flow hash function updates for a fair queue policy.

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

Mandatory. The name of the fair queue policy.

seconds

Mandatory. The rehash interval, in seconds. The range is 0 to

4294967295, where 0 means the hash function is never updated.

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

Chapter 18: Quality of Service Policies

qos-policy fair-queue <policy-name> hash-interval <seconds>

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

Chapter 18: Quality of Service Policies

qos-policy fair-queue <policy-name> queue-limit <limit>

qos-policy fair-queue <policy-name> queue-limit

<limit>
Sets an upper bound for the number of packets allowed in the queue for a fair queue policy.

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

Mandatory. The name of the fair queue policy.

limit

Mandatory. The maximum queue size, in packets. The range is 0 to

4294967295. The default is 127.

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

Chapter 18: Quality of Service Policies

qos-policy fair-queue <policy-name> queue-limit <limit>

Use the show form of this command to display queue limit configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

139

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name>

qos-policy traffic-shaper <policy-name>

Defines a traffic shaping QoS policy.

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

Mandatory. The name of the traffic shaping policy.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name>

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> bandwidth

qos-policy traffic-shaper <policy-name> bandwidth

Specifies the bandwidth available for all combined traffic constrained by this policy.

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

Mandatory. The name of the traffic shaping policy.

auto

Automatically bases the bandwidth on the interface speed.

rate

The bandwidth, specified in kilobits per second.

rate-suffix

The bandwidth, specified as a number and a scaling suffix (for example,

10mbit). The following suffixes are supported:
kbit: Kilobits per second.
mbit: Megabits per second.
gbit: Gigabits per second.
kbps: Kilobytes per second.
mbps: Megabytes per second.
gbps: Gigabytes per second.

Command Reference

Rel VC4.1 v. 03

Vyatta

139

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> bandwidth

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class>

qos-policy traffic-shaper <policy-name> class <class>

Defines a traffic class for a traffic shaper QoS policy.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

139

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class>

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> bandwidth

qos-policy traffic-shaper <policy-name> class <class>

bandwidth
Specifies the base guaranteed bandwidth rate for a traffic class.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

rate

The bandwidth, specified in kilobits per second.

rate-pct

The bandwidth, specified as a percentage of the overall bandwidth rate.

The format is num% (for example, 85%).

Rel VC4.1 v. 03

Vyatta

139

Chapter 18: Quality of Service Policies

rate-suffix

qos-policy traffic-shaper <policy-name> class <class> bandwidth

The bandwidth, specified as a number and a scaling suffix (for example,

10mbit). The following suffixes are supported:
kbit: Kilobits per second.
mbit: Megabits per second.
gbit: Gigabits per second.
kbps: Kilobytes per second.
mbps: Megabytes per second.
gbps: Gigabytes per second.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> burst

qos-policy traffic-shaper <policy-name> class <class>

burst
Sets the burst size for a traffic class.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

num

The burst size, specified in bytes.

num-suffix

The bandwidth, specified as a number and a scaling suffix (for example,

10mbit). The following suffixes are supported:
kbit: Kilobits per second.
mbit: Megabits per second.
gbit: Gigabits per second.

Command Reference

Rel VC4.1 v. 03

Vyatta

139

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> burst

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> ceiling

qos-policy traffic-shaper <policy-name> class <class>

ceiling
Sets a bandwidth ceiling for a traffic class.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

rate

The maximum bandwidth, specified in kilobits per second.

rate-pct

The maximum bandwidth, specified as a percentage of the interface

speed. The format is num% (for example, 85%).

rate-suffix

The bandwidth, specified as a number and a scaling suffix (for example,

10mbit). The following suffixes are supported:
kbit: Kilobits per second.
mbit: Megabits per second.
gbit: Gigabits per second.

Command Reference

Rel VC4.1 v. 03

Vyatta

140

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> ceiling

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> description <desc>

qos-policy traffic-shaper <policy-name> class <class>

description <desc>
Sets a description for a traffic class.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

desc

Mandatory. The description for this traffic class.

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> description <desc>

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>

qos-policy traffic-shaper <policy-name> class <class>

match <match-name>
Defines a traffic class matching rule.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule 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>

qos-policy traffic-shaper <policy-name> class <class>

match <match-name> description <desc>
Sets a description for a match rule.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule name.

desc

Mandatory. The description for this match.

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>

qos-policy traffic-shaper <policy-name> class <class>

match <match-name> interface <interface>
Specifies a match criterion based on incoming interface.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule name.

interface

Performs a match based on the specified Ethernet interface name. The

ingress interface for incoming traffic will be compared with this value.

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

qos-policy traffic-shaper <policy-name> class <class>

match <match-name> ip destination
Specifies a match criterion based on IP destination information.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule 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

Performs a match based on the destination IP address and prefix.

port

Performs a match based on destination port. 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 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

qos-policy traffic-shaper <policy-name> class <class>

match <match-name> ip dscp <value>
Specifies a match criterion based on the value of the DSCP field.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule name.

value

Performs a match based on the specified value. This value is compared

with the value in the DSCP field of the ToS byte in the IP header. 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).

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

qos-policy traffic-shaper <policy-name> class <class>

match <match-name> ip protocol <proto>
Specifies a match criterion based on the IP protocol.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule name.

proto

Performs a match based on the protocol name (for example, icmp) or

number, as assigned by the IANA.

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

qos-policy traffic-shaper <policy-name> class <class>

match <match-name> ip source
Specifies a match criterion based on source IP information.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule name.

ipv4

The source IP address and prefix to match for this rule.

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

qos-policy traffic-shaper <policy-name> class <class>

match <match-name> vif <vlan-id>
Specifies a a match criterion based on VLAN ID.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

match-name

Mandatory. Class matching rule name.

vlan-id

Performs a match based on VLAN ID. The range is 1 to 4096.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> priority <priority>

qos-policy traffic-shaper <policy-name> class <class>

priority <priority>
Specifies the priority of a traffic class for allocation of extra bandwidth.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> priority <priority>

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> queue-limit <limit>

qos-policy traffic-shaper <policy-name> class <class>

queue-limit <limit>
Specifies the maximum queue size for a traffic class.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

limit

The maximum queue size in packets.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

142

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> queue-limit <limit>

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> queue-type <type>

qos-policy traffic-shaper <policy-name> class <class>

queue-type <type>
Specifies the type of queuing to use for a traffic class.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

type

The queuing method to use. Supported values are as follows:

fair-queue: Uses a Stochastic Fair Queue (SFQ) queue.
drop-tail: Uses a First In First Out (FIFO) queue.
priority: Sets queue priority based on the Differentiated Services Code
Point (DSCP) values in the Type of Service (ToS) byte of the IP header.
random-detect: Uses a Random Early Detection (RED) queue.

Default
The default is fair-queue.

Command Reference

Rel VC4.1 v. 03

Vyatta

142

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> queue-type <type>

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> set-dscp <value>

qos-policy traffic-shaper <policy-name> class <class>

set-dscp <value>
Rewrites the DSCP field in packets in this traffic class to the specified value.

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

Mandatory. The name of the traffic shaping policy.

class

Mandatory. The class ID. The range is 2 to 65535.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> class <class> set-dscp <value>

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

RFC 2474 DSCP Values

Binary
Value

Configured
Value

Drop
Rate

Meaning

101 110

46

N/A

Expedited forwarding (EF)

000 000

N/A

Default: Best-effort traffic

001 010

10

Low

Assured forwarding (AF) 11

001 100

12

Medium

Assured forwarding (AF) 12

001 110

14

High

Assured forwarding (AF) 13

010 010

18

Low

Assured forwarding (AF) 21

010 100

20

Medium

Assured forwarding (AF) 22

010 110

22

High

Assured forwarding (AF) 23

011 010

26

Low

Assured forwarding (AF) 31

011 100

28

Medium

Assured forwarding (AF) 32

011 110

30

High

Assured forwarding (AF) 33

100 010

34

Low

Assured forwarding (AF) 41

100 100

36

Medium

Assured forwarding (AF) 42

100 110

38

High

Assured forwarding (AF) 43

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default

qos-policy traffic-shaper <policy-name> default

Defines a default traffic shaper QoS policy.

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

Mandatory. The name of the default policy.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default bandwidth

qos-policy traffic-shaper <policy-name> default

bandwidth
Specifies the base guaranteed bandwidth rate for the default traffic class.

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

Mandatory. The name of the traffic shaping policy.

rate

Bandwidth in kbps.

rate-pct

The bandwidth, specified as a percentage of the interface speed. The

format is num% (for example, 85%).

Rel VC4.1 v. 03

Vyatta

143

Chapter 18: Quality of Service Policies

rate-suffix

qos-policy traffic-shaper <policy-name> default bandwidth

The bandwidth, specified as a number and a scaling suffix (for example,

10mbit). The following suffixes are supported:
kbit: Kilobits per second.
mbit: Megabits per second.
gbit: Gigabits per second.
kbps: Kilobytes per second.
mbps: Megabytes per second.
gbps: Gigabytes per second.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default burst

qos-policy traffic-shaper <policy-name> default burst

Sets the burst size for the default traffic class.

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

Mandatory. The name of the traffic shaping policy.

num

Burst size in bytes.

num-suffix

The bandwidth, specified as a number and a scaling suffix (for example,

10mbit). The following suffixes are supported:
kbit: Kilobits per second.
mbit: Megabits per second.
gbit: Gigabits per second.

Default
The burst size is 15 kilobits per second.

Command Reference

Rel VC4.1 v. 03

Vyatta

143

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default burst

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default ceiling

qos-policy traffic-shaper <policy-name> default ceiling

Sets a bandwidth ceiling for the default traffic class.

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

Mandatory. The name of the traffic shaping policy.

rate

The limit in kbps.

rate-pct

The bandwidth, specified as a percentage of the overall bandwidth rate.

The format is num% (for example, 85%).

rate-suffix

The bandwidth, specified as a number and a scaling suffix (for example,

10mbit). The following suffixes are supported:
kbit: Kilobits per second.
mbit: Megabits per second.
gbit: Gigabits per second.

Default
The default is 100%.

Command Reference

Rel VC4.1 v. 03

Vyatta

143

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default ceiling

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default priority <priority>

qos-policy traffic-shaper <policy-name> default priority

<priority>
Specifies the priority of the default traffic class for allocation of extra bandwidth.

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

Mandatory. The name of the traffic shaping policy.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default priority <priority>

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default queue-limit <limit>

qos-policy traffic-shaper <policy-name> default

queue-limit <limit>
Specifies the maximum queue size for the default traffic class.

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

Mandatory. The name of the traffic shaping policy.

limit

The maximum queue size in packets.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default queue-limit <limit>

Use the show form of this command to display queue limit configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

143

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default queue-type <type>

qos-policy traffic-shaper <policy-name> default

queue-type <type>
Specifies the type of queuing to use for the default traffic class.

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

Mandatory. The name of the traffic shaping policy.

type

The queuing method to use. Supported values are as follows:

fair-queue: Uses a Stochastic Fair Queue (SFQ) queue.
drop-tail: Uses a First In First Out (FIFO) queue.
priority: Sets queue priority based on the Differentiated Services Code
Point (DSCP) values in the Type of Service (ToS) byte of the IP header.
random-detect: Uses a Random Early Detection (RED) queue.

Default
The default is fair-queue.

Command Reference

Rel VC4.1 v. 03

Vyatta

144

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default queue-type <type>

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default set-dscp <value>

qos-policy traffic-shaper <policy-name> default

set-dscp <value>
Rewrites the DSCP field in packets in the default traffic class to the specified value.

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

Mandatory. The name of the traffic shaping policy.

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> default set-dscp <value>

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

RFC 2474 DSCP Values

Binary
Value

Configured
Value

Drop
Rate

Meaning

101 110

46

N/A

Expedited forwarding (EF)

000 000

N/A

Default: Best-effort traffic

001 010

10

Low

Assured forwarding (AF) 11

001 100

12

Medium

Assured forwarding (AF) 12

001 110

14

High

Assured forwarding (AF) 13

010 010

18

Low

Assured forwarding (AF) 21

010 100

20

Medium

Assured forwarding (AF) 22

010 110

22

High

Assured forwarding (AF) 23

011 010

26

Low

Assured forwarding (AF) 31

011 100

28

Medium

Assured forwarding (AF) 32

011 110

30

High

Assured forwarding (AF) 33

100 010

34

Low

Assured forwarding (AF) 41

100 100

36

Medium

Assured forwarding (AF) 42

100 110

38

High

Assured forwarding (AF) 43

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

Chapter 18: Quality of Service Policies

qos-policy traffic-shaper <policy-name> description <desc>

qos-policy traffic-shaper <policy-name> description

<desc>
Specifies a description for a traffic shaper QoS policy.

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

Mandatory. The name of the traffic shaping policy.

desc

The description for this traffic shaper policy.

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

Chapter 19: NAT

This chapter lists the commands for setting up Network Address Translation
(NAT) on the Vyatta system.
This chapter contains the following commands.
Command

Description

NAT Configuration Commands

service nat

Enables NAT on the system.

service nat rule <rule-num>

Defines a NAT rule.

service nat rule <rule-num> destination

Specifies the destination address and port to match in a

NAT rule.

service nat rule <rule-num> exclude

Creates an exclusion rule, excluding the specified

packets from being translated.

service nat rule <rule-num> inbound-interface

<interface>

Specifies the interface on which to receive inbound

traffic for a destination NAT rule.

service nat rule <rule-num> inside-address

Defines the inside address for a destination NAT rule.

service nat rule <rule-num> outbound-interface

<interface>

Specifies the interface on which to transmit outbound

traffic for source and masquerade NAT rules.

Chapter 19: NAT

144

Command

Description

service nat rule <rule-num> outside-address

Defines an outside address configuration for a Source

NAT (SNAT) rule.

service nat rule <rule-num> protocol <protocol>

Specifies which protocols are to have NAT performed on

them.

service nat rule <rule-num> source

Specifies the source address and port to match in a NAT

rule.

service nat rule <rule-num> type <type>

Sets the type of translation for a NAT rule.

NAT Operational Commands

clear nat counters

Resets counters for active NAT rules.

clear nat translations

Clears state information associated with the specified

NAT rule(s).

show nat rules

Lists configured NAT rules.

show nat statistics

Displays statistics for NAT.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 19: NAT

clear nat counters

clear nat counters

Resets counters for active NAT rules.

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

Chapter 19: NAT

clear nat translations

clear nat translations

Clears state information associated with the specified NAT rule(s).

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

Chapter 19: NAT

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

Chapter 19: NAT

service nat rule <rule-num>

service nat rule <rule-num>

Defines a NAT rule.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

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

Chapter 19: NAT

service nat rule <rule-num>

Use the show form of this command to view NAT rule configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

145

Chapter 19: NAT

service nat rule <rule-num> destination

service nat rule <rule-num> destination

Specifies the destination address and port to match in a NAT rule.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

Rel VC4.1 v. 03

Vyatta

145

Chapter 19: NAT

service nat rule <rule-num> destination

address

The destination address to match. The following formats are valid:

ip-address: Matches the specified IP address.
ip-address/prefix: A network address, where 0.0.0.0/0 matches any
network.
ip-addressip-address: Matches a range of contiguous IP addresses; for
example, 192.168.1.1192.168.1.150.
!ip-address: Matches all IP addresses except the one specified.
!ip-address/prefix: Matches all network addresses except the one
specified.
!ip-addressip-address: Matches all IP addresses except those in the
specified range.

port

The destination port to match. The following formats are valid:

port-name: Matches the name of an IP service; for example, http. You
can specify any service name in the file etc/services.
port-num: Matches a port number. The range is 1 to 65535.
startend: Matches the specified range of ports; for example,
10011005.
You can use a combination of these formats in a comma-separated list.
You can also negate the entire list by prepending it with an exclamation
mark (!); for example, !22,telnet,http,123,1001-1005.

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

Chapter 19: NAT

service nat rule <rule-num> exclude

service nat rule <rule-num> exclude

Creates an exclusion rule, excluding the specified packets from being translated.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

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

Chapter 19: NAT

service nat rule <rule-num> exclude

Use the show form of this command to view the configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

145

Chapter 19: NAT

service nat rule <rule-num> inbound-interface <interface>

service nat rule <rule-num> inbound-interface

<interface>
Specifies the interface on which to receive inbound traffic for a destination NAT rule.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

interface

The inbound Ethernet or serial interface. Destination NAT (DNAT) will

be performed on traffic received on this interface.
You can specify an individual vif, rather than an entire interface. To do
this, refer to the vif using int.vif notation. For example to refer to vif 40
on interface eth0, use eth0.40.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

145

Chapter 19: NAT

service nat rule <rule-num> inbound-interface <interface>

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

Chapter 19: NAT

service nat rule <rule-num> inside-address

service nat rule <rule-num> inside-address

Defines the inside address for a destination NAT rule.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

address

The address or range of addresses to be used to translate the inside

address. The following formats are valid:
ip-address: Translates to the specified IP address.
ip-addressip-address: Translates to one of the IP addresses in the
specified pool of contiguous IP addresses; for example,
192.168.1.1192.168.1.150.

Command Reference

Rel VC4.1 v. 03

Vyatta

145

Chapter 19: NAT

service nat rule <rule-num> inside-address

port

The IP port to be used to translate the inside address. The following

formats are valid:
port-num: Translates to the specified port. The range is 1 to 65535.
startend: Translates to one of the ports in the specified pool of
contiguous ports; for example, 10011005.

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

Chapter 19: NAT

service nat rule <rule-num> outbound-interface <interface>

service nat rule <rule-num> outbound-interface

<interface>
Specifies the interface on which to transmit outbound traffic for source and masquerade
NAT rules.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

interface

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.
You can specify an individual vif, rather than an entire interface. To do
this, refer to the vif using int.vif notation. For example to refer to vif 40
on interface eth0, use eth0.40.

Command Reference

Rel VC4.1 v. 03

Vyatta

146

Chapter 19: NAT

service nat rule <rule-num> outbound-interface <interface>

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

Chapter 19: NAT

service nat rule <rule-num> outside-address

service nat rule <rule-num> outside-address

Defines an outside address configuration for a Source NAT (SNAT) rule.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

address

The address or range of addresses to be used to translate the outside

address. The address or addresses chosen must be present on the
outbound interface. The following formats are valid:
ip-address: Translates to the specified IP address.
ip-addressip-address: Translates to one of the IP addresses in the
specified pool of contiguous IP addresses; for example,
192.168.1.1192.168.1.150.

Command Reference

Rel VC4.1 v. 03

Vyatta

146

Chapter 19: NAT

service nat rule <rule-num> outside-address

port

The IP port to be used to translate the ourtside address. The following

formats are valid:
port-num: Translates to the specified port. The range is 1 to 65535.
startend: Translates to one of the ports in the specified pool of
contiguous ports; for example, 10011005.

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

Chapter 19: NAT

service nat rule <rule-num> protocol <protocol>

service nat rule <rule-num> protocol <protocol>

Specifies which protocols are to have NAT performed on them.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

protocol

The protocol(s) on which to perform NAT. Any protocol literals or

numbers listed in /etc/protocols can be used. The keyword all is also
supported.
Prefixing the protocol name with the exclamation mark character (!)
matches every protocol except the specified protocol. For example, !tcp
matches all protocols except TCP.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

146

Chapter 19: NAT

service nat rule <rule-num> protocol <protocol>

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

Chapter 19: NAT

service nat rule <rule-num> source

service nat rule <rule-num> source

Specifies the source address and port to match in a NAT rule.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

Rel VC4.1 v. 03

Vyatta

146

Chapter 19: NAT

service nat rule <rule-num> source

address

The source address to match. The following formats are valid:

ip-address: Matches the specified IP address.
ip-address/prefix: A network address, where 0.0.0.0/0 matches any
network.
ip-addressip-address: Matches a range of contiguous IP addresses; for
example, 192.168.1.1192.168.1.150.
!ip-address: Matches all IP addresses except the one specified.
!ip-address/prefix: Matches all network addresses except the one
specified.
!ip-addressip-address: Matches all IP addresses except those in the
specified range.

port

The source port to match. The following formats are valid:

port-name: Matches the name of an IP service; for example, http. You
can specify any service name in the file etc/services .
port-num: Matches a port number. The range is 1 to 65535.
startend: Matches the specified range of ports; for example,
10011005.
You can use a combination of these formats in a comma-separated list.
You can also negate the entire list by prepending it with an exclamation
mark (!); for example, !22,telnet,http,123,1001-1005.

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

Chapter 19: NAT

service nat rule <rule-num> type <type>

service nat rule <rule-num> type <type>

Sets the type of translation for a NAT rule.

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

Mandatory. Multi-node. A numeric identifier for the rule. The range is

11024.

type

Indicates whether this rule is translating the source IP or the destination

IP. Note that this is dependent on the direction of the interface. The
supported values are as follows:
source: This rule translates the source network address. Typically
source rules are applied to outbound packets.
destination: This rule translates the destination network address.
Typically destination rules are applied to inbound packets.
masquerade: This rule is a type of source NAT. It translates the source
network address using the outbound router interface IP address as the
translated address.

Command Reference

Rel VC4.1 v. 03

Vyatta

146

Chapter 19: NAT

service nat rule <rule-num> type <type>

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

Chapter 19: NAT

show nat rules

show nat rules

Lists configured NAT rules.

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

Chapter 19: NAT

show nat statistics

show nat statistics

Displays statistics for NAT.

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

Chapter 20: Logging

This chapter lists the commands used for system logging.

Chapter 20: Logging

147

This chapter contains the following commands.

Command

Description

Configuration Commands
system syslog

Configures the systems syslog utility.

system syslog console facility <facility> level <level>

Specifies which messages are sent to the console.

system syslog file <filename> archive

Specifies the settings for log file archiving of the

user-defined log file.

system syslog file <filename> facility <facility> level <level>

Specifies which messages are sent to the

user-defined log file.

system syslog global archive

Specifies the settings for log file archiving of the

main system log file.

system syslog global facility <facility> level <level>

Specifies which messages are sent to the main

system log file.

system syslog host <hostname> facility <facility> level

<level>

Specifies which messages are sent to the remote

syslog server.

system syslog user <userid> facility <facility> level <level>

Specifies which messages are sent to the specified

users terminal.

Operational Commands
delete log file

Deletes the specified log file, including all its archive

files.

show log

Displays the contents of the specified log file.

show log directory

Displays a list of files in the logging directory.

show log tail

Displays the last lines of the messages file.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 20: Logging

delete log file

delete log file

Deletes the specified log file, including all its archive files.

Syntax
delete log file file-name

Command Mode
Operational mode.

Parameters

file-name

Deletes the specified user-defined file in the /var/log directory,

including all its archive files.

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

Chapter 20: Logging

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

Displays the contents of all master log files.

file file-name

Displays the contents of the specified log file directory.

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

Chapter 20: Logging

show log directory

show log directory

Displays a list of files in the logging directory.

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

Chapter 20: Logging

show log tail

show log tail

Displays the last lines of the messages file.

Syntax
show log tail [lines]

Command Mode
Operational mode.

Parameters

lines

The number of lines to display.

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

Chapter 20: Logging

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

Emergency. A general system failure or other serious failure has

occurred, such that the system is unusable.

alert

Alert. Immediate action is required to prevent the system from

becoming unusablefor example, because a network link has failed,
or the database has become compromised.

Rel VC4.1 v. 03

Vyatta

147

Chapter 20: Logging

system syslog

Table 20-1 Syslog message severities

crit

Critical. A critical condition exists, such as resource exhaustionfor

example, the system is out of memory, CPU processing thresholds are
being exceeded, or a hardware failure has occurred.

err

Error. An error condition has occurred, such as a failed system call.

However, the system is still functioning.

warning

Warning. An event has occurred that has the potential to cause an

error, such as invalid parameters being passed to a function. This
situation should be monitored.

notice

Notice. A normal but significant event has occurred, such as an

unexpected event. It is not an error, but could potentially require
attention.

info

Informational. Normal events of interest are being reported as they

occur.

debug

Debug level. Trace-level information is being provided.

The Vyatta system supports standard syslog facilities. These are as follows:
Table 20-2 Syslog facilities

Command Reference

Facility

Description

auth

Authentication and authorization

authpriv

Non-system authorization

cron

Cron daemon

daemon

System daemons

kern

Kernel

lpr

Line printer spooler

mail

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

Chapter 20: Logging

system syslog

Table 20-2 Syslog facilities

local0

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

All facilities excluding mark

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

Chapter 20: Logging

system syslog console facility <facility> level <level>

system syslog console facility <facility> level <level>

Specifies which messages are sent to the console.

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

Multi-node. The kinds of messages that will be sent to the console.

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 console by
creating multiple facility configuration nodes within the console node.

level

The minimum severity of log message that will be reported to the

console. Supported values are emerg, alert, crit, err, warning, notice,
info, and 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 the console.

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

Chapter 20: Logging

system syslog console facility <facility> level <level>

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

Chapter 20: Logging

system syslog file <filename> archive

system syslog file <filename> archive

Specifies the settings for log file archiving of the user-defined log file.

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

Multi-node. Defines a file to which the specified log messages will be

written. File names can include numbers, letters, and hyphens.
You can send log messages to multiple files by creating multiple file
configuration nodes.

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

Chapter 20: Logging

system syslog file <filename> archive

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

Chapter 20: Logging

system syslog file <filename> facility <facility> level <level>

system syslog file <filename> facility <facility> level

<level>
Specifies which messages are sent to the user-defined log file.

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

Multi-node. Defines a file to which the specified log messages will be

written. File names can include numbers, letters, and hyphens.
You can send log messages to multiple files by creating multiple file
configuration nodes.

facility

Multi-node. The kinds of messages that will be sent to the user-defined

log file. 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 this log file by
creating multiple facility configuration nodes within the file
configuration node.

Command Reference

Rel VC4.1 v. 03

Vyatta

148

Chapter 20: Logging

system syslog file <filename> facility <facility> level <level>

level

The minimum severity of log message that will be reported. 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 warning severity are logged to file.

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

Chapter 20: Logging

system syslog global archive

system syslog global archive

Specifies the settings for log file archiving of the main system log file.

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

Chapter 20: Logging

system syslog global archive

Use the show form of this command to view the log file archiving configuration.

Command Reference

Rel VC4.1 v. 03

Vyatta

148

Chapter 20: Logging

system syslog global facility <facility> level <level>

system syslog global facility <facility> level <level>

Specifies which messages are sent to the main system log file.

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

The minimum severity of log message that will be reported. 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 warning severity are logged to the main system
log file.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

148

Chapter 20: Logging

system syslog global facility <facility> level <level>

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

Chapter 20: Logging

system syslog host <hostname> facility <facility> level <level>

system syslog host <hostname> facility <facility> level

<level>
Specifies which messages are sent to the remote syslog server.

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

Chapter 20: Logging

system syslog host <hostname> facility <facility> level <level>

level

The minimum severity of log message that will be reported. 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 hosts.

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

Chapter 20: Logging

system syslog user <userid> facility <facility> level <level>

system syslog user <userid> facility <facility> level

<level>
Specifies which messages are sent to the specified users terminal.

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

Multi-node. Sends the specified log messages to the specified users

terminal.
You can send log messages to multiple users by creating multiple user
configuration nodes.

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

Chapter 20: Logging

system syslog user <userid> facility <facility> level <level>

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

Chapter 21: SNMP

This chapter lists the commands for setting up the Simple Network Management
Protocol on the Vyatta system.

Chapter 21: SNMP

149

This chapter contains the following commands.

Command

Description

Configuration Commands
protocols snmp

Defines SNMP community and trap information for

the Vyatta system.

protocols snmp community <community>

Defines an SNMP community.

protocols snmp community <community> authorization

<auth>

Specifies the privileges this community will have.

protocols snmp community <community> client <ipv4>

Specifies the SNMP clients in this community that

are authorized to access the system.

protocols snmp community <community> network

<ipv4net>

Specifies the network of SNMP clients in this

community that are authorized to access the server.

protocols snmp contact <contact>

Records contact information for the system.

protocols snmp description <desc>

Records a brief description of the system.

protocols snmp location <location>

Records the location of the system.

protocols snmp trap-target <ipv4>

Specifies the IP address of the destination for SNMP

traps.

Command Reference

Rel VC4.1 v. 03

Vyatta

Chapter 21: SNMP

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

Chapter 21: SNMP

protocols snmp community <community>

protocols snmp community <community>

Defines an SNMP community.

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

Optional. Multi-node. Defines an SNMP community. The argument is

the community string to be used to authorize SNMP managers making
requests of this system. Letters, numbers, and hyphens are supported.
You can define more than one community by creating multiple
community configuration nodes.

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

Chapter 21: SNMP

protocols snmp community <community> authorization <auth>

protocols snmp community <community> authorization

<auth>
Specifies the privileges this community will have.

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

Optional. Multi-node. Defines an SNMP community. The argument is

the community string to be used to authorize SNMP managers making
requests of this system. Letters, numbers, and hyphens are supported.
You can define more than one community by creating multiple
community configuration nodes.

auth

Optional. Specifies the privileges this community will have. Supported

values are as follows:
ro: This community can view system information, but not change it.
rw: This community has read-write privileges.
Deleting the authorization statement resets the privilege level to the
default (ro).

Command Reference

Rel VC4.1 v. 03

Vyatta

149

Chapter 21: SNMP

protocols snmp community <community> authorization <auth>

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

Chapter 21: SNMP

protocols snmp community <community> client <ipv4>

protocols snmp community <community> client <ipv4>

Specifies the SNMP clients in this community that are authorized to access the system.

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

Optional. Multi-node. Defines an SNMP community. The argument is

the community string to be used to authorize SNMP managers making
requests of this system. Letters, numbers, and hyphens are supported.
You can define more than one community by creating multiple
community configuration nodes.

ipv4

Optional. Multi-node. The SNMP clients in this community that are

authorized to access the system.
You can define more than one client by creating the client configuration
node multiple times.
If no client or network is defined, then any client presenting the correct
community string will have read-only access to the system. If any client
or network is defined then only explicitly listed clients and/or networks
will have access to the system.

Command Reference

Rel VC4.1 v. 03

Vyatta

150

Chapter 21: SNMP

protocols snmp community <community> client <ipv4>

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

Chapter 21: SNMP

protocols snmp community <community> network <ipv4net>

protocols snmp community <community> network

<ipv4net>
Specifies the network of SNMP clients in this community that are authorized to access the
server.

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

Optional. Multi-node. Defines an SNMP community. The argument is

the community string to be used to authorize SNMP managers making
requests of this system. Letters, numbers, and hyphens are supported.
You can define more than one community by creating multiple
community configuration nodes.

ipv4net

Optional. Multi-node. The network of SNMP clients in this community

that are authorized to access the server.
You can define more than one network by creating the network
configuration node multiple times.
If no client or network is defined, then any client presenting the correct
community string will have read-only access to the router. If any client
or network is defined then only explicitly listed clients and/or networks
will have access to the router.

Command Reference

Rel VC4.1 v. 03

Vyatta

150

Chapter 21: SNMP

protocols snmp community <community> network <ipv4net>

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

Chapter 21: SNMP

protocols snmp contact <contact>

protocols snmp contact <contact>

Records contact information for the system.

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

Optional. Records contact information for the system. This is stored as

MIB-2 system information in the snmpd.conf configuration file.
Letters, numbers, and hyphens are supported.

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

Chapter 21: SNMP

protocols snmp description <desc>

protocols snmp description <desc>

Records a brief description of the system.

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

Optional. Records a brief description of the system. This is stored as

MIB-2 system information in the snmpd.conf configuration file.
Letters, numbers, and hyphens are supported.

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

Chapter 21: SNMP

protocols snmp location <location>

protocols snmp location <location>

Records the location of the system.

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

Optional. Records the location of the system. This is stored as MIB-2

system information in the snmpd.conf configuration file. Letters,
numbers, and hyphens are supported.

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

Chapter 21: SNMP

protocols snmp trap-target <ipv4>

protocols snmp trap-target <ipv4>

Specifies the IP address of the destination for SNMP traps.

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

Optional. Multi-node. The IP address of the destination for SNMP traps.

You can specify multiple destinations for SNMP traps by creating
multiple trap-target configuration nodes. Or, you can enter a
space-separated list of IP addresses.

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

Chapter 21: SNMP

Command Reference

protocols snmp trap-target <ipv4>

Rel VC4.1 v. 03

Vyatta

150

1510

Chapter 22: Diagnostics

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.

Chapter 22: Diagnostics

151

This chapter contains the following commands.

Command

Description

Operational Commands

Command Reference

ping <host>

Sends ICMP ECHO_REQUEST packets to IPv4

network hosts.

reboot

Reboots the system. See page 61 in Chapter 3:

System Management.

show system boot-messages

Displays boot messages generated by the kernel.

See page 85 in Chapter 3: System Management.

show system connections

Displays active network connections on the system.

See page 87 in Chapter 3: System Management.

show system kernel-messages

Displays messages in the kernel ring buffer. See

page 89 in Chapter 3: System Management.

show system memory

Displays messages in the kernel ring buffer. See

page 91 in Chapter 3: System Management.

show system processes

Displays messages in the kernel ring buffer. See

page 92 in Chapter 3: System Management.

show system storage

Displays messages in the kernel ring buffer. See

page 94 in Chapter 3: System Management.

show system uptime

Displays messages in the kernel ring buffer. See

page 95 in Chapter 3: System Management.

show tech-support

Displays messages in the kernel ring buffer. See

page 96 in Chapter 3: System Management.

show version

Displays messages in the kernel ring buffer. See

page 98 in Chapter 3: System Management.

traceroute <host>

Displays the route packets take to an IPv4 network

host.

Rel VC4.1 v. 03

Vyatta

Chapter 22: Diagnostics

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

Chapter 22: Diagnostics

ping <host>

64 bytes from 10.3.0.2:

64 bytes from 10.3.0.2:
64 bytes from 10.3.0.2:
64 bytes from 10.3.0.2:
Command interrupted!

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

Chapter 22: Diagnostics

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

traceroute to 10.0.0.30 (10.0.0.30), 30 hops max, 40 byte packets

1 rtr5-erg-f1.mycom.com (10.1.0.1) 0.251 ms 0.153 ms 0.118 ms
2 10-252-0-9-e9-bb5-bccca-net.mycom.com (10.252.0.9) 0.364 ms 0.235 ms 0.372 ms
3 10-253-2-3-e3-cbc3-bccca-net.mycom.com (10.253.2.3) 0.758 ms 0.746 ms 0.897 ms
4 pilson.mycom.com (10.0.0.30) 1.037 ms 1.030 ms 0.999 ms

Command Reference

Rel VC4.1 v. 03

Vyatta

151

1515

Chapter 23: Software Upgrades

This chapter lists commands for using the Vyatta systems software upgrade
mechanism.
This chapter contains the following commands.
Command

Description

Configuration Commands
system package

Specifies the information needed for automatic

software updates.

system package auto-sync <days>

Specifies how often the repository cache should be

updated.

system package repository <repository>

Specifies information about the repository.

system package repository <repository> components

<component>

Specifies a repository component name.

system package repository <repository> description <desc>

Specifies a brief description for the repository.

system package repository <repository> distribution <dist>

Specifies a distribution name.

system package repository <repository> url <url>

Specifies the URL of the server hosting the

repository.

Chapter 23: Software Upgrades

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

Chapter 23: Software Upgrades

system package auto-sync <days>

system package auto-sync <days>

Specifies how often the repository cache should be updated.

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

Optional. Sets the system to update the repository cache every

specified number of days.
The range is 1 to 4294967296.

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

Chapter 23: Software Upgrades

system package repository <repository>

system package repository <repository>

Specifies information about the repository.

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

Multi-node. The version of the software. For example,

community.
You can define more than one software repository by creating
multiple repository nodes.

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

Chapter 23: Software Upgrades

system package repository <repository> components <component>

system package repository <repository> components

<component>
Specifies a repository component name.

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

Multi-node. The version of the software. For example,

community.
You can define more than one software repository by creating
multiple repository nodes.

component

Multi-node. The repository component names.

You can configure more than one component within a
repository by creating multiple component nodes. The stock
components are main and security.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

151

Chapter 23: Software Upgrades

system package repository <repository> components <component>

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

Chapter 23: Software Upgrades

system package repository <repository> description <desc>

system package repository <repository> description

<desc>
Specifies a brief description for the repository.

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

Multi-node. The version of the software. For example,

community.
You can define more than one software repository by creating
multiple repository nodes.

desc

A brief description for the repository.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

152

Chapter 23: Software Upgrades

system package repository <repository> description <desc>

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

Chapter 23: Software Upgrades

system package repository <repository> distribution <dist>

system package repository <repository> distribution

<dist>
Specifies a distribution name.

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

Multi-node. The version of the software. For example,

community.
You can define more than one software repository by creating
multiple repository nodes.

dist

The name of the distribution.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

152

Chapter 23: Software Upgrades

system package repository <repository> distribution <dist>

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

Chapter 23: Software Upgrades

system package repository <repository> url <url>

system package repository <repository> url <url>

Specifies the URL of the server hosting the repository.

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

Multi-node. The version of the software. For example,

community.
You can define more than one software repository by creating
multiple repository nodes.

url

Mandatory. The full URL of the server hosting the software

repository, including the path if required.

Default
None.

Command Reference

Rel VC4.1 v. 03

Vyatta

152

Chapter 23: Software Upgrades

system package repository <repository> url <url>

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

Appendix A: SNMP MIB Support

This appendix lists the standard MIBs and traps supported by the Vyatta system.

Appendix A: SNMP MIB Support

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

RFC 1657, Definitions of Managed Objects for

the Fourth Version of Border Gateway Protocol
(BGP-4)

Protocol MIB supported plus the following

traps:
BGP peer established
BGP peer backwards transition

IF-MIB

RFC 2863, The Interfaces Group MIB

The following traps are supported:

linkUp
linkDown

OSPF2-MIB

RFC 1850, OSPF Version 2 Management

Information Base

OSPF Trap

MIB Module from RFC 1850, OSPF Version 2

Management Information Base

RIP

RFC 1724, RIP Version 2 MIB Extension

SNMPv2-MIB

RFC 3418, Management Information Base

(MIB) for the Simple Network Management
Protocol (SNMP)

Command Reference

The following traps are supported:

ospfVirtIfStateChange
ospfTxRetransmit
ospfVirtIfTxRetransmit
ospfOriginateLsa
ospfMaxAgeLsa
ospfLsdbOverflow
ospfLsdbApproachingOverflow
ospfIfStateChange
ospfIfStateChange
ospfVirtNbrStateChange
ospfIfConfigError
ospfVirtIfConfigError
ospfIfAuthFailure
ospfVirtIfAuthFailure
ospfIfRxBadPacket
ospfVirtIfRxBadPacket

The following traps are supported:

coldStart
warmStart

Rel VC4.1 v. 03

Vyatta

1529

Appendix B: ICMP Types

This appendix lists the ICMP types defined by the Internet Assigned Numbers
Authority (IANA).

Appendix B: ICMP Types

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

Appendix B: ICMP Types

153

Table B-1 ICMP types

Command Reference

ICMP Type

Literal

38

domainname-response

39

skip

40

photuris

Rel VC4.1 v. 03

Vyatta

Appendix B: ICMP Types

Command Reference

153

Rel VC4.1 v. 03

Vyatta

1533

Appendix C: Regular Expressions

This appendix describes the regular expressions that can be recognized by the
Vyatta system.

Appendix C: Regular Expressions

153

The Vyatta system supports POSIX-style regular expressions.

POSIX expressions are an extension of standard UNIX regular expressions. A regular
expression is a string representing a pattern that describes or matches a set of strings.
In these regular expressions, most characters (literals) match themselves and nothing else.
For example, a matches a, ab matches ab, and so on. A small set of characters
(metacharacters) carry special meaning. Table C-1 describes supported metacharacters.
Table C-1 Regular expression metacharacters
Metacharact
er

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.

\ ( \)

Creates a block or sub-expression from the enclosed characters. For

example:
\(at\) matches at only.
[pb]\(at\)h matches path and bath.

To be matched, the specified character or block must occur at the

beginning of a line.
^[hc]at matches hat and cat, but only at the beginning of a line.

Rel VC4.1 v. 03

Vyatta

Appendix C: Regular Expressions

153

Table C-1 Regular expression metacharacters

Metacharact
er

Meaning

To be matched, the specified character or block must occur at the end of a

line.
[hc]at$ matches hat and cat, but only at the end of a line.
^$ matches blank lines.

Matches 0 or more instances of the preceding single character, for

example:
[hc]* matches , h, and c
[hc]*at matches , h, c, at, hat, cat, hcat, chat,
hhat, ccat, and so on.

Matches 1 or more instances of the preceding single character or block,

for example:
[hc]+ matches h and c, hh, hc, cc, ch, and so on, but
not .
[hc]+at matches , h, c, hat, cat, hcat, chat, hhat,
ccat, and so on, but not at.

Matches 0 or 1 instances of the preceding single character or block, for

example:
[hc]? matches , h and c.
[hc]?at matches at,hat, and cat.

Alternation operator. Matches either the expression before or the

expression after the operator. For example:
abc|def matches either abc or def.

The escape character. If a metacharacter is to be included as part of the

search string, it must be escaped by preceding it with the backslash. This
includes the backslash itself. For example:
bat\. matches bat..
\\dev matches \dev.

To account for differences between the organization of character sets in different

implementations, the POSIX standard defines a number of classes or categories of
characters. Table C-2 lists POSIX classes.
Table C-2 POSIX classes

Command Reference

Class

Equivalent to:

[:upper:]

[A-Z] Upper case letters.

[:lower:]

[a-z] Lower case letters.

[:alpha:]

[A-Za-z] Upper and lower case letters.

Rel VC4.1 v. 03

Vyatta

Appendix C: Regular Expressions

153

Table C-2 POSIX classes

Command Reference

Class

Equivalent to:

[:digit:]

[0-9] Digits.

[:alnum:]

[A-Za-z0-9] Digits, and upper and lower case letters.

[:xdigit:]

[0-9A-Fa-f] Hexadecimal digits.

[:punct:]

[.,!?:...] Punctuation.

[:blank:]

[ \t] Space and <Tab>.

[:space:]

[ \t\n\r\f\v] Characters generating white space.

[:cntrl:]

Control characters.

[:graph:]

[^\t\n\r\f\v] Printed characters.

[:print:]

[^ \t\n\r\f\v] Printed characters and blank space.

Rel VC4.1 v. 03

Vyatta

153

Glossary of Acronyms

ACL

access control list

ADSL

Asymmetric Digital Subscriber Line

AS

autonomous system

ARP

Address Resolution Protocol

BGP

Border Gateway Protocol

CHAP

Challenge Handshake Authentication Protocol

CLI

command-line interface

DHCP

Dynamic Host Configuration Protocol

DLCI

data-link connection identifier

DMI

desktop management interface

DNS

Domain Name System

DSCP

Differentiated Services Code Point

DSL

Digital Subscriber Line

eBGP

external BGP

EGP

Exterior Gateway Protocol

ECMP

equal-cost multipath

ESP

Encapsulating Security Payload

FIB

Forwarding Information Base

FTP

File Transfer Protocol

GRE

Generic Routing Encapsulation

153

Command Reference

HDLC

High-Level Data Link Control

ICMP

Internet Control Message Protocol

IDS

Intrusion Detection System

IGP

Interior Gateway Protocol

IPS

Intrusion Protection System

IKE

Internet Key Exchange

IP

Internet Protocol

IPOA

IP over ATM

IPsec

IP security

IPv4

IP Version 4

IPv6

IP Version 6

IS-IS

Intermediate SystemtoIntermediate System

L2TP

Layer 2 Tunneling Protocol

LAN

local area network

MAC

medium access control

MIB

Management Information Base

MLPPP

multilink PPP

MPLS

Multiprotocol Label Switching

MPLS EXP

MPLS experimental

MPLS TE

MPLS Traffic Engineering

MRRU

maximum received reconstructed unit

MTU

maximum transmission unit

NAT

Network Address Translation

NIC

network interface card

NTP

Network Time Protocol

OSPF

Open Shortest Path First

OSPFv2

OSPF Version 2

Rel VC4.1 v. 03

Vyatta

153

Command Reference

OSPFv3

OSPF Version 3

PAM

Pluggable Authentication Module

PAP

Password Authentication Protocol

PCI

peripheral component interconnect

PKI

Public Key Infrastructure

PPP

Point-to-Point Protocol

PPPoA

PPP over ATM

PPPoE

PPP over Ethernet

PPTP

Point-to-Point Tunneling Protocol

PVC

permanent virtual circuit

QoS

quality of service

RADIUS

Remote Authentication Dial-In User Service

RIB

Routing Information Base

RIP

Routing Information Protocol

RIPng

RIP next generation

Rx

receive

SNMP

Simple Network Management Protocol

SONET

Synchronous Optical Network

SSH

Secure Shell

TACACS+

Terminal Access Controller Access Control System Plus

TCP

Transmission Control Protocol

ToS

Type of Service

Tx

transmit

UDP

User Datagram Protocol

VLAN

virtual LAN

VPN

Virtual Private Network

VRRP

Virtual Router Redundancy Protocol

Rel VC4.1 v. 03

Vyatta

154

WAN

Command Reference

wide area network

Rel VC4.1 v. 03

Vyatta