diff --git a/doc/bird.sgml b/doc/bird.sgml index 86df0456..d456f5cb 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -362,16 +362,49 @@ protocol rip { seconds, zero means disabled. Default: disabled (0). mrtdump " - Set MRTdump file name. This option must be specified to allow MRTdump - feature. Default: no dump file. + Set MRTdump protocols file name. This option must be specified to allow MRTdump + protocols feature. Default: no dump file. mrtdump protocols all|off|{ states, messages } - Set global defaults of MRTdump options. See in the following section. Default: off. - filter - Define a filter. You can learn more about filters in the following - chapter. + + table / + Choosing tables from which will be routes taken. + Can be used wildcards * and ?. + Default: "*" for all tables + period / + Configures the interval in seconds between mrt table dumps. + Default: 60 seconds + filter / + Configure filtering dumping routes. Filters are more described in . + Default: Accept all + + + Example: +

+mrtdump routes { + filename "%f-%s.mrt"; # dumps will be saved into files named like 'tableA-1437119435.mrt' + table "t*"; # only routes from tables starts with character 't' + period 10; # 10 seconds interval between dumps + where source = RTS_BGP; # only routes from BGP protocols +} +mrtdump routes; # another mrtdump route config with default options + + filter + Define a filter. You can learn more about filters in . function Define a function. You can learn more about functions in the following chapter. @@ -453,13 +486,13 @@ protocol rip { hh:mm:ss) for table - Create a new routing table. The default routing table is created + table + Create a new routing table. The default description for details. - roa table + roa table Create a new ROA (Route Origin Authorization) table. ROA tables can be used to validate route origination of BGP routes. A ROA table contains ROA entries, each consist of a network prefix, a max prefix length and @@ -511,8 +544,9 @@ agreement"). protocol, mrtdump all|off|{ states, messages } - Set protocol MRTdump flags. MRTdump is a standard binary format for + + Set protocol MRTdump flags. MRTdump is a standard binary format (see + )) for logging information from routing protocols and daemons. These flags control what kind of information is logged from the protocol to the MRTdump file (which must be specified by global show route [[for] + show route [[for] Show contents of a routing table (by default of the main one or the table attached to a respective protocol), that is routes, their metrics and (in case the show roa [] + show roa [ Show contents of a ROA table (by default of the first one). You can specify a for , you'll get all entries relevant for route @@ -796,16 +830,16 @@ This argument can be omitted if there exists only a single instance. entries covered by the network prefix. You could also use add roa ] + add roa Add a new ROA entry to a ROA table. Such entry is called delete roa ] + delete roa Delete the specified ROA entry from a ROA table. Only dynamic ROA entries (i.e., the ones added by flush roa [table ] + flush roa [table Remove all dynamic ROA entries from a ROA table. configure [soft] [" @@ -873,6 +907,11 @@ This argument can be omitted if there exists only a single instance. dump resources|sockets|interfaces|neighbors|attributes|routes|protocols Dump contents of internal data structures to the debugging output. + mrtdump routes [table + + Once the specified routes will be saved into file(s) named based on . + echo all|off|{ Control echoing of log messages to the command-line output. See for a list of log classes. @@ -882,7 +921,7 @@ This argument can be omitted if there exists only a single instance. -Filters +