FRRouting User Guide

Introduction

• Overview
  • How to get FRR
  • About FRR
  • Mailing Lists
  • Bug Reports
• Installation
  • From Packages
  • From Snapcraft
  • From Source
• Basic Setup
  • Crash logs
  • Daemons Configuration File
  • Services
  • Systemd
  • Operations

Basics

• Basic Commands
  • Config Commands
  • Terminal Mode Commands
  • Common Invocation Options
  • Loadable Module Support
  • Virtual Terminal Interfaces
• Extended Logging Target
  • Destinations
  • Options
  • Structured data
  • Restart and Reconfiguration caveats
• VTY shell
  • Live logs
  • Pager usage
  • Permissions and setup requirements
  • Integrated configuration file
• Northbound gRPC
  • Northbound gRPC Features
  • Daemon gRPC Configuration
• Filtering
  • IP Access List
  • IP Prefix List
• Route Maps
  • Route Map Command
  • Route Map Match Command
  • Route Map Set Command
  • Route Map Call Command
  • Route Map Exit Action Command
  • Route Map Optimization Command
  • Route Map Examples
• Affinity Maps
  • Command
• IPv6 Support
  • Router Advertisement
  • Router Advertisement Configuration Example
• Kernel Interface
• SNMP Support
  • Getting and installing an SNMP agent
  • NET-SNMP configuration
  • AgentX configuration
  • Handling SNMP Traps
• Scripting
  • Scripting
  • Available Lua hook calls
• Nexthop Groups

Protocols

• Zebra
  • Invoking zebra
  • Configuration Addresses behaviour
  • Interface Commands
  • Nexthop Tracking
  • PBR dataplane programming
  • Administrative Distance
  • Route Replace Semantics
  • Virtual Routing and Forwarding
  • Table Allocation
  • ECMP
  • Single Vxlan Device Support
  • MPLS Commands
  • Segment-Routing IPv6
  • Multicast RIB Commands
  • zebra Route Filtering
  • zebra FIB push interface
  • FPM Commands
  • Dataplane Commands
  • DPDK dataplane
  • zebra Terminal Mode Commands
  • Router-id
  • sysctl settings
  • Debugging
  • Scripting
• Bidirectional Forwarding Detection
  • Starting BFD
  • BFDd Commands
  • Configuration
  • Status
  • Distributed BFD
  • Debugging
• BGP
  • Starting BGP
  • Basic Concepts
  • BGP Router Configuration
  • Displaying BGP Information
  • Route Reflector
  • Suppressing routes not installed in FIB
  • Routing Policy
  • BGP Regular Expressions
  • Miscellaneous Configuration Examples
  • BGP tcp-mss support
  • Configuring FRR as a Route Server
  • Prefix Origin Validation Using RPKI
  • Weighted ECMP using BGP link bandwidth
  • Flowspec
  • BGP fast-convergence support
• Babel
  • Configuring babeld
  • Babel configuration
  • Babel redistribution
  • Show Babel information
  • Babel debugging commands
  • Babel sample configuration file
• OpenFabric
  • Configuring fabricd
  • OpenFabric router
  • OpenFabric Timer
  • OpenFabric interface
  • Showing OpenFabric information
  • Debugging OpenFabric
  • Sample configuration
• LDP
  • Running Ldpd
  • Understanding LDP principles
  • LDP Configuration
  • Show LDP Information
  • LDP debugging commands
  • Sample configuration
• EIGRP
  • Starting and Stopping eigrpd
  • EIGRP Configuration
  • How to Announce EIGRP route
  • Show EIGRP Information
  • EIGRP Debug Commands
  • Sample configuration
• EVPN
  • EVPN Concepts
  • FRR Configuration
  • Linux Interface Configuration
• ISIS
  • Configuring isisd
  • ISIS router
  • ISIS Timer
  • ISIS Fast-Reroute
  • ISIS region
  • ISIS interface
  • Showing ISIS information
  • Traffic Engineering
  • Segment Routing
  • Flex-Algos (Flex-Algo)
  • Segment Routing over IPv6 (SRv6)
  • Debugging ISIS
  • ISIS Configuration Examples
  • ISIS Vrf Configuration Examples
• NHRP
  • Routing Design
  • Configuring NHRP
  • Hub Functionality
  • Integration with IKE
  • Multicast Functionality
  • NHRP Events
  • Show NHRP
  • Configuration Example
• OSPFv2
  • OSPF Fundamentals
  • Configuring OSPF
  • OSPF route-map
  • Graceful Restart
  • Showing Information
  • Opaque LSA
  • Traffic Engineering
  • Router Information
  • Segment Routing
  • External Route Summarisation
  • TI-LFA
  • Debugging OSPF
  • Sample Configuration
• OSPFv3
  • Configuring OSPF6
• PATH
  • Configuration
  • Starting
  • PCEP Support
  • Pathd Configuration
  • Usage with BGP route-maps
  • Sample configuration
• PIM
  • Starting and Stopping pimd
  • PIM Interface Configuration
  • PIM Multicast RIB
  • Multicast Source Discovery Protocol (MSDP) Configuration
  • Show PIM Information
  • PIM Debug Commands
  • PIM Clear Commands
  • PIM EVPN configuration
  • Sample configuration
• PIMv6
  • Starting and Stopping pim6d
  • PIMv6 Interface Configuration
  • Show PIMv6 Information
  • PIMv6 Clear Commands
  • PIMv6 Debug Commands
• PBR
  • Starting PBR
  • PBR Nexthop Groups
  • PBR Maps
  • PBR Policy
  • PBR Debugs
  • PBR Details
  • Sample configuration
• RIP
  • Starting and Stopping ripd
  • RIP Configuration
  • RIP Version Control
  • How to Announce RIP route
  • Filtering RIP Routes
  • RIP Metric Manipulation
  • RIP distance
  • RIP route-map
  • RIP Authentication
  • RIP Timers
  • Show RIP Information
  • RIP Debug Commands
  • Sample configuration
• RIPng
  • Invoking ripngd
  • ripngd Configuration
  • ripngd Terminal Mode Commands
  • ripngd Filtering Commands
  • RIPng route-map
  • Sample configuration
• SHARP
  • Starting SHARP
  • Using SHARP
• STATIC
  • Starting STATIC
  • Static Route Commands
  • Multiple nexthop static route
  • SR-TE Route Commands
  • SRv6 Route Commands
• VNC and VNC-GW
  • Configuring VNC
  • Manual Address Control
  • Other VNC-Related Commands
  • Example VNC and VNC-GW Configurations
• VRRP
  • Starting VRRP
  • Protocol Overview
  • Configuring VRRP
• BMP
  • Implementation characteristics
  • Starting BMP
  • Configuring BMP
• WATCHFRR
  • Starting WATCHFRR
  • WATCHFRR commands
• MGMTd (Management Daemon)
  • MGMT Frontend Interface
  • MGMTD Backend Interface
  • MGMTD Transaction Engine
  • MGMTD Configuration Rollback and Commit History
  • MGMT Configuration commands
  • MGMT Show commands
  • MGMT Daemon debug commands
  • MGMT Client debug commands

Appendix

• Reporting Bugs
  • Report Format & Requested Information
• Packet Binary Dump Format
• Glossary
• The frr-reload.py script
  • Options

Copyright notice

Copyright (c) 1996-2018 Kunihiro Ishiguro, et al.

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by Kunihiro Ishiguro.