The behavior of FRR may be extended or customized using its built-in scripting capabilities. The scripting language is Lua 5.3. This guide assumes Lua knowledge. For more information on Lua, consult the Lua 5.3 reference manual, or Programming in Lua (note that the free version covers only Lua 5.0).


See also

Developer docs for scripting

How to use

  1. Identify the Lua function name. See Available Lua hook calls.

  2. Write the Lua script

  3. Configure FRR to use the Lua script

In order to use scripting, FRR must be built with --enable-scripting.


Scripts are typically loaded just-in-time. This means you can change the contents of a script that is in use without restarting FRR. Not all scripting locations may behave this way; refer to the documentation for the particular location.

Example: on_rib_process_dplane_results

This example shows how to write a Lua script that logs changes when a route is added.

First, identify the Lua hook call to attach a Lua function to: this will be the name of the Lua function. In this case, since the hook call is on_rib_process_dplane_results:

function on_rib_process_dplane_results(ctx)
   return {}

The documentation for on_rib_process_dplane_results tells us its arguments. Here, the destination prefix for a route is being logged out.

Scripts live in /etc/frr/scripts/ by default. This is configurable at compile time via --with-scriptdir. It may be overridden at runtime with the --scriptdir daemon option.

The documentation for on_rib_process_dplane_results indicates that the script command should be used to set the script. Assuming that the above function was created in /etc/frr/scripts/my_dplane_script.lua, the following vtysh command sets the script for the hook call:

script on_rib_process_dplane_results my_dplane_script

After the script is set, when the hook call is hit, FRR will look for a on_rib_process_dplane_results function in /etc/frr/scripts/my_dplane_script.lua and run it with the ctx object as its argument.

Available Lua hook calls