doc/user/scripting.rst

   1 .. _scripting:
   2
   3 *********
   4 Scripting
   5 *********
   6
   7 The behavior of FRR may be extended or customized using its built-in scripting
   8 capabilities.
   9
  10 Some configuration commands accept the name of a Lua script to call to perform
  11 some task or make some decision. These scripts have their environments
  12 populated with some set of inputs, and are expected to populate some set of
  13 output variables, which are read by FRR after the script completes. The names
  14 and expected contents of these scripts are documented alongside the commands
  15 that support them.
  16
  17 These scripts live in :file:`/etc/frr/scripts/` by default. This is
  18 configurable at compile time via ``--with-scriptdir``. It may be
  19 overriden at runtime with the ``--scriptdir`` daemon option.
  20
  21 In order to use scripting, FRR must be built with ``--enable-scripting``.
  22
  23 .. note::
  24
  25    Scripts are typically loaded just-in-time. This means you can change the
  26    contents of a script that is in use without restarting FRR. Not all
  27    scripting locations may behave this way; refer to the documentation for the
  28    particular location.