diff options
Diffstat (limited to 'doc/bird.sgml')
| -rw-r--r-- | doc/bird.sgml | 37 |
1 files changed, 33 insertions, 4 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml index d351cedc..615ced98 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -702,19 +702,48 @@ This argument can be omitted if there exists only a single instance. <tag>flush roa [table <m/t/>]</tag> Remove all dynamic ROA entries from a ROA table. - <tag>configure [soft] ["<m/config file/"]</tag> + <tag>configure [soft] ["<m/config file/"] [timeout [<m/num/]]</tag> Reload configuration from a given file. BIRD will smoothly switch itself to the new configuration, protocols are reconfigured if possible, restarted otherwise. Changes in - filters usually lead to restart of affected protocols. If - <cf/soft/ option is used, changes in filters does not cause + filters usually lead to restart of affected protocols. + + If <cf/soft/ option is used, changes in filters does not cause BIRD to restart affected protocols, therefore already accepted routes (according to old filters) would be still propagated, but new routes would be processed according to the new filters. + If <cf/timeout/ option is used, config timer is activated. The + new configuration could be either confirmed using + <cf/configure confirm/ command, or it will be reverted to the + old one when the config timer expires. This is useful for cases + when reconfiguration breaks current routing and a router becames + inaccessible for an administrator. The config timeout expiration is + equivalent to <cf/configure undo/ command. The timeout duration + could be specified, default is 300 s. + + <tag>configure confirm</tag> + Deactivate the config undo timer and therefore confirm the current + configuration. + + <tag>configure undo</tag> + Undo the last configuration change and smoothly switch back to + the previous (stored) configuration. If the last configuration + change was soft, the undo change is also soft. There is only + one level of undo, but in some specific cases when several + reconfiguration requests are given immediately in a row and + the intermediate ones are skipped then the undo also skips them back. + + <tag>configure check ["<m/config file/"]</tag> + Read and parse given config file, but do not use it. useful + for checking syntactic and some semantic validity of an config + file. + <tag>enable|disable|restart <m/name/|"<m/pattern/"|all</tag> - Enable, disable or restart a given protocol instance, instances matching the <cf><m/pattern/</cf> or <cf/all/ instances. + Enable, disable or restart a given protocol instance, + instances matching the <cf><m/pattern/</cf> or + <cf/all/ instances. <tag>reload [in|out] <m/name/|"<m/pattern/"|all</tag> |